rcs 2.0.0.pre.rc.1 → 2.0.0.pre.rc.3
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 +4 -4
- data/lib/rcs/brands/client.rb +6 -6
- data/lib/rcs/brands/types/{autofill_brand_schema_options.rb → autofill_brand_options.rb} +5 -5
- data/lib/rcs/campaigns/dlc/client.rb +12 -12
- data/lib/rcs/campaigns/dlc/types/{upsert_dlc_schema_keywords_help.rb → upsert_dlc_campaign_help_keywords.rb} +5 -5
- data/lib/rcs/campaigns/dlc/types/{upsert_dlc_schema_keywords.rb → upsert_dlc_campaign_keywords.rb} +20 -20
- data/lib/rcs/campaigns/dlc/types/{upsert_dlc_schema_links.rb → upsert_dlc_campaign_links.rb} +5 -5
- data/lib/rcs/campaigns/dlc/types/{upsert_dlc_schema_keywords_opt_in.rb → upsert_dlc_campaign_opt_in_keywords.rb} +5 -5
- data/lib/rcs/campaigns/dlc/types/{upsert_dlc_schema_keywords_opt_out.rb → upsert_dlc_campaign_opt_out_keywords.rb} +5 -5
- data/lib/rcs/campaigns/dlc/types/{upsert_dlc_schema_options.rb → upsert_dlc_campaign_options.rb} +5 -5
- data/lib/rcs/campaigns/dlc/types/{upsert_dlc_schema_use_case.rb → upsert_dlc_campaign_use_case.rb} +5 -5
- data/lib/rcs/campaigns/rcs/client.rb +25 -25
- data/lib/rcs/campaigns/rcs/types/{upsert_rcs_schema_agent_emails_item.rb → rcs_agent_email.rb} +5 -5
- data/lib/rcs/campaigns/rcs/types/{upsert_rcs_schema_agent_phones_item.rb → rcs_agent_phone.rb} +5 -5
- data/lib/rcs/campaigns/rcs/types/{upsert_rcs_schema_agent_websites_item.rb → rcs_agent_website.rb} +5 -5
- data/lib/rcs/campaigns/rcs/types/{upsert_rcs_schema_agent.rb → upsert_rcs_agent.rb} +17 -17
- data/lib/rcs/campaigns/rcs/types/{upsert_rcs_schema_links.rb → upsert_rcs_links.rb} +5 -5
- data/lib/rcs/campaigns/rcs/types/{upsert_rcs_schema_opt_in.rb → upsert_rcs_opt_in.rb} +13 -13
- data/lib/rcs/campaigns/rcs/types/{upsert_rcs_schema_opt_out.rb → upsert_rcs_opt_out.rb} +5 -5
- data/lib/rcs/campaigns/rcs/types/{upsert_rcs_schema_use_case.rb → upsert_rcs_use_case.rb} +5 -5
- data/lib/rcs/campaigns/toll_free/client.rb +4 -4
- data/lib/rcs/campaigns/toll_free/types/toll_free_autofill_response.rb +10 -10
- data/lib/rcs/campaigns/toll_free/types/upsert_toll_free_schema_opt_in.rb +8 -8
- data/lib/rcs/conversations/client.rb +2 -2
- data/lib/rcs/messages/client.rb +24 -3
- data/lib/rcs/messages/mms/client.rb +118 -0
- data/lib/rcs/messages/{send/types/send_mms_response.rb → mms/types/mms_send_response.rb} +4 -4
- data/lib/rcs/messages/{send/types/send_mms_schema_options.rb → mms/types/send_mms_options.rb} +6 -6
- data/lib/rcs/messages/rcs/client.rb +68 -0
- data/lib/rcs/messages/{send/types/send_rcs_response.rb → rcs/types/rcs_send_response.rb} +4 -4
- data/lib/rcs/messages/sms/client.rb +198 -0
- data/lib/rcs/messages/{send/types/send_sms_schema_options.rb → sms/types/send_sms_options.rb} +6 -6
- data/lib/rcs/messages/{send/types/send_sms_response.rb → sms/types/sms_send_response.rb} +4 -4
- data/lib/rcs/messages/types/{message_reaction_schema_options.rb → react_message_options.rb} +5 -5
- data/lib/rcs/phone_numbers/client.rb +32 -18
- data/lib/rcs/phone_numbers/types/{phone_details_schema_options_enhanced_contact_info.rb → enhanced_contact_info.rb} +5 -7
- data/lib/rcs/phone_numbers/types/{phone_details_schema_options.rb → retrieve_phone_number_details_options.rb} +10 -10
- data/lib/rcs/phone_numbers/types/{search_schema_number.rb → search_phone_number_by_digits.rb} +5 -5
- data/lib/rcs/phone_numbers/types/{search_schema_location.rb → search_phone_number_by_location.rb} +5 -5
- data/lib/rcs/phone_numbers/types/{search_schema_options.rb → search_phone_number_options.rb} +5 -5
- data/lib/rcs/phone_numbers/webhook/client.rb +2 -2
- data/lib/rcs/tools/file/client.rb +3 -3
- data/lib/rcs/tools/file/types/{file_upload_schema_options_download.rb → download_options.rb} +5 -5
- data/lib/rcs/tools/file/types/{file_upload_schema_options.rb → upload_file_options.rb} +10 -10
- data/lib/rcs/types/{attach_webhook_schema_webhook_id.rb → attach_webhook_by_id_params.rb} +5 -5
- data/lib/rcs/types/attach_webhook_params.rb +8 -8
- data/lib/rcs/types/{get_conversation_request_id.rb → conversation_by_id_params.rb} +5 -5
- data/lib/rcs/types/{get_conversation_request_recipient.rb → conversation_by_participants_params.rb} +5 -5
- data/lib/rcs/types/{attach_webhook_schema_name.rb → create_and_attach_webhook_by_url_params.rb} +5 -5
- data/lib/rcs/types/get_conversation_params.rb +8 -8
- data/lib/rcs/types/link_click_event.rb +8 -8
- data/lib/rcs/types/message.rb +8 -8
- data/lib/rcs/types/rcs.rb +12 -12
- data/lib/rcs/types/rcs_campaign_schema_extra_opt_in.rb +8 -8
- data/lib/rcs/types/rcs_campaign_schema_opt_in.rb +8 -8
- data/lib/rcs/types/rcs_cards.rb +4 -4
- data/lib/rcs/types/rcs_cards_cards_item.rb +4 -4
- data/lib/rcs/types/rcs_cards_content.rb +4 -4
- data/lib/rcs/types/rcs_cards_content_cards_item.rb +4 -4
- data/lib/rcs/types/rcs_media_content.rb +4 -4
- data/lib/rcs/types/rcs_text_content.rb +4 -4
- data/lib/rcs/types/{rcs_button_content.rb → rich_button.rb} +10 -10
- data/lib/rcs/types/{rcs_card.rb → rich_cards_message.rb} +9 -9
- data/lib/rcs/types/{rcs_media.rb → rich_media_message.rb} +9 -9
- data/lib/rcs/types/{rcs_text.rb → rich_text_message.rb} +9 -9
- data/lib/rcs/types/toll_free_campaign.rb +10 -10
- data/lib/rcs/types/toll_free_campaign_with_extended_brand_and_status.rb +10 -10
- data/lib/rcs/types/{nullable_contact.rb → upsert_contact.rb} +5 -5
- data/lib/rcs/types/{toll_free_campaign_schema_opt_in.rb → upsert_toll_free_campaign_opt_in.rb} +13 -13
- data/lib/rcs/types/{toll_free_campaign_schema_use_case.rb → upsert_toll_free_campaign_use_case.rb} +5 -5
- data/lib/rcs.rb +0 -7
- data/lib/requests.rb +2 -2
- data/lib/types_export.rb +40 -40
- metadata +43 -45
- data/lib/rcs/message/client.rb +0 -30
- data/lib/rcs/message/sms/client.rb +0 -96
- data/lib/rcs/messages/send/client.rb +0 -318
data/lib/rcs/campaigns/rcs/types/{upsert_rcs_schema_agent_emails_item.rb → rcs_agent_email.rb}
RENAMED
@@ -7,7 +7,7 @@ module Pinnacle
|
|
7
7
|
module Campaigns
|
8
8
|
module Rcs
|
9
9
|
module Types
|
10
|
-
class
|
10
|
+
class RcsAgentEmail
|
11
11
|
# @return [String] Email attached to the agent.
|
12
12
|
attr_reader :email
|
13
13
|
# @return [String] Label for the email.
|
@@ -23,7 +23,7 @@ module Pinnacle
|
|
23
23
|
# @param email [String] Email attached to the agent.
|
24
24
|
# @param label [String] Label for the email.
|
25
25
|
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
26
|
-
# @return [Pinnacle::Campaigns::Rcs::Types::
|
26
|
+
# @return [Pinnacle::Campaigns::Rcs::Types::RcsAgentEmail]
|
27
27
|
def initialize(email: OMIT, label: OMIT, additional_properties: nil)
|
28
28
|
@email = email if email != OMIT
|
29
29
|
@label = label if label != OMIT
|
@@ -33,10 +33,10 @@ module Pinnacle
|
|
33
33
|
end
|
34
34
|
end
|
35
35
|
|
36
|
-
# Deserialize a JSON object to an instance of
|
36
|
+
# Deserialize a JSON object to an instance of RcsAgentEmail
|
37
37
|
#
|
38
38
|
# @param json_object [String]
|
39
|
-
# @return [Pinnacle::Campaigns::Rcs::Types::
|
39
|
+
# @return [Pinnacle::Campaigns::Rcs::Types::RcsAgentEmail]
|
40
40
|
def self.from_json(json_object:)
|
41
41
|
struct = JSON.parse(json_object, object_class: OpenStruct)
|
42
42
|
parsed_json = JSON.parse(json_object)
|
@@ -49,7 +49,7 @@ module Pinnacle
|
|
49
49
|
)
|
50
50
|
end
|
51
51
|
|
52
|
-
# Serialize an instance of
|
52
|
+
# Serialize an instance of RcsAgentEmail to a JSON object
|
53
53
|
#
|
54
54
|
# @return [String]
|
55
55
|
def to_json(*_args)
|
data/lib/rcs/campaigns/rcs/types/{upsert_rcs_schema_agent_phones_item.rb → rcs_agent_phone.rb}
RENAMED
@@ -7,7 +7,7 @@ module Pinnacle
|
|
7
7
|
module Campaigns
|
8
8
|
module Rcs
|
9
9
|
module Types
|
10
|
-
class
|
10
|
+
class RcsAgentPhone
|
11
11
|
# @return [String] Label for the phone number.
|
12
12
|
attr_reader :label
|
13
13
|
# @return [String] Phone number attached to the agent in E.164 format.
|
@@ -23,7 +23,7 @@ module Pinnacle
|
|
23
23
|
# @param label [String] Label for the phone number.
|
24
24
|
# @param phone [String] Phone number attached to the agent in E.164 format.
|
25
25
|
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
26
|
-
# @return [Pinnacle::Campaigns::Rcs::Types::
|
26
|
+
# @return [Pinnacle::Campaigns::Rcs::Types::RcsAgentPhone]
|
27
27
|
def initialize(label: OMIT, phone: OMIT, additional_properties: nil)
|
28
28
|
@label = label if label != OMIT
|
29
29
|
@phone = phone if phone != OMIT
|
@@ -33,10 +33,10 @@ module Pinnacle
|
|
33
33
|
end
|
34
34
|
end
|
35
35
|
|
36
|
-
# Deserialize a JSON object to an instance of
|
36
|
+
# Deserialize a JSON object to an instance of RcsAgentPhone
|
37
37
|
#
|
38
38
|
# @param json_object [String]
|
39
|
-
# @return [Pinnacle::Campaigns::Rcs::Types::
|
39
|
+
# @return [Pinnacle::Campaigns::Rcs::Types::RcsAgentPhone]
|
40
40
|
def self.from_json(json_object:)
|
41
41
|
struct = JSON.parse(json_object, object_class: OpenStruct)
|
42
42
|
parsed_json = JSON.parse(json_object)
|
@@ -49,7 +49,7 @@ module Pinnacle
|
|
49
49
|
)
|
50
50
|
end
|
51
51
|
|
52
|
-
# Serialize an instance of
|
52
|
+
# Serialize an instance of RcsAgentPhone to a JSON object
|
53
53
|
#
|
54
54
|
# @return [String]
|
55
55
|
def to_json(*_args)
|
data/lib/rcs/campaigns/rcs/types/{upsert_rcs_schema_agent_websites_item.rb → rcs_agent_website.rb}
RENAMED
@@ -7,7 +7,7 @@ module Pinnacle
|
|
7
7
|
module Campaigns
|
8
8
|
module Rcs
|
9
9
|
module Types
|
10
|
-
class
|
10
|
+
class RcsAgentWebsite
|
11
11
|
# @return [String] Label for the url.
|
12
12
|
attr_reader :label
|
13
13
|
# @return [String] Url attached to the agent.
|
@@ -23,7 +23,7 @@ module Pinnacle
|
|
23
23
|
# @param label [String] Label for the url.
|
24
24
|
# @param url [String] Url attached to the agent.
|
25
25
|
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
26
|
-
# @return [Pinnacle::Campaigns::Rcs::Types::
|
26
|
+
# @return [Pinnacle::Campaigns::Rcs::Types::RcsAgentWebsite]
|
27
27
|
def initialize(label: OMIT, url: OMIT, additional_properties: nil)
|
28
28
|
@label = label if label != OMIT
|
29
29
|
@url = url if url != OMIT
|
@@ -33,10 +33,10 @@ module Pinnacle
|
|
33
33
|
end
|
34
34
|
end
|
35
35
|
|
36
|
-
# Deserialize a JSON object to an instance of
|
36
|
+
# Deserialize a JSON object to an instance of RcsAgentWebsite
|
37
37
|
#
|
38
38
|
# @param json_object [String]
|
39
|
-
# @return [Pinnacle::Campaigns::Rcs::Types::
|
39
|
+
# @return [Pinnacle::Campaigns::Rcs::Types::RcsAgentWebsite]
|
40
40
|
def self.from_json(json_object:)
|
41
41
|
struct = JSON.parse(json_object, object_class: OpenStruct)
|
42
42
|
parsed_json = JSON.parse(json_object)
|
@@ -49,7 +49,7 @@ module Pinnacle
|
|
49
49
|
)
|
50
50
|
end
|
51
51
|
|
52
|
-
# Serialize an instance of
|
52
|
+
# Serialize an instance of RcsAgentWebsite to a JSON object
|
53
53
|
#
|
54
54
|
# @return [String]
|
55
55
|
def to_json(*_args)
|
@@ -1,8 +1,8 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
|
3
|
-
require_relative "
|
4
|
-
require_relative "
|
5
|
-
require_relative "
|
3
|
+
require_relative "rcs_agent_email"
|
4
|
+
require_relative "rcs_agent_phone"
|
5
|
+
require_relative "rcs_agent_website"
|
6
6
|
require "ostruct"
|
7
7
|
require "json"
|
8
8
|
|
@@ -11,13 +11,13 @@ module Pinnacle
|
|
11
11
|
module Rcs
|
12
12
|
module Types
|
13
13
|
# Create an agent for the campaign.
|
14
|
-
class
|
14
|
+
class UpsertRcsAgent
|
15
15
|
# @return [String] Color of the agent's buttons. <br>
|
16
16
|
# Must have sufficient contrast with white.
|
17
17
|
attr_reader :color
|
18
18
|
# @return [String] Description of the agent.
|
19
19
|
attr_reader :description
|
20
|
-
# @return [Array<Pinnacle::Campaigns::Rcs::Types::
|
20
|
+
# @return [Array<Pinnacle::Campaigns::Rcs::Types::RcsAgentEmail>] List of emails (1-3 required).
|
21
21
|
attr_reader :emails
|
22
22
|
# @return [String] Link to the agent's hero.
|
23
23
|
attr_reader :hero_url
|
@@ -25,9 +25,9 @@ module Pinnacle
|
|
25
25
|
attr_reader :icon_url
|
26
26
|
# @return [String] Name of the agent.
|
27
27
|
attr_reader :name
|
28
|
-
# @return [Array<Pinnacle::Campaigns::Rcs::Types::
|
28
|
+
# @return [Array<Pinnacle::Campaigns::Rcs::Types::RcsAgentPhone>] List of phone numbers (1-3 required).
|
29
29
|
attr_reader :phones
|
30
|
-
# @return [Array<Pinnacle::Campaigns::Rcs::Types::
|
30
|
+
# @return [Array<Pinnacle::Campaigns::Rcs::Types::RcsAgentWebsite>] List of urls (1-3 required).
|
31
31
|
attr_reader :websites
|
32
32
|
# @return [OpenStruct] Additional properties unmapped to the current class definition
|
33
33
|
attr_reader :additional_properties
|
@@ -40,14 +40,14 @@ module Pinnacle
|
|
40
40
|
# @param color [String] Color of the agent's buttons. <br>
|
41
41
|
# Must have sufficient contrast with white.
|
42
42
|
# @param description [String] Description of the agent.
|
43
|
-
# @param emails [Array<Pinnacle::Campaigns::Rcs::Types::
|
43
|
+
# @param emails [Array<Pinnacle::Campaigns::Rcs::Types::RcsAgentEmail>] List of emails (1-3 required).
|
44
44
|
# @param hero_url [String] Link to the agent's hero.
|
45
45
|
# @param icon_url [String] Link to the agent's icon.
|
46
46
|
# @param name [String] Name of the agent.
|
47
|
-
# @param phones [Array<Pinnacle::Campaigns::Rcs::Types::
|
48
|
-
# @param websites [Array<Pinnacle::Campaigns::Rcs::Types::
|
47
|
+
# @param phones [Array<Pinnacle::Campaigns::Rcs::Types::RcsAgentPhone>] List of phone numbers (1-3 required).
|
48
|
+
# @param websites [Array<Pinnacle::Campaigns::Rcs::Types::RcsAgentWebsite>] List of urls (1-3 required).
|
49
49
|
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
50
|
-
# @return [Pinnacle::Campaigns::Rcs::Types::
|
50
|
+
# @return [Pinnacle::Campaigns::Rcs::Types::UpsertRcsAgent]
|
51
51
|
def initialize(color: OMIT, description: OMIT, emails: OMIT, hero_url: OMIT, icon_url: OMIT, name: OMIT,
|
52
52
|
phones: OMIT, websites: OMIT, additional_properties: nil)
|
53
53
|
@color = color if color != OMIT
|
@@ -73,10 +73,10 @@ module Pinnacle
|
|
73
73
|
end
|
74
74
|
end
|
75
75
|
|
76
|
-
# Deserialize a JSON object to an instance of
|
76
|
+
# Deserialize a JSON object to an instance of UpsertRcsAgent
|
77
77
|
#
|
78
78
|
# @param json_object [String]
|
79
|
-
# @return [Pinnacle::Campaigns::Rcs::Types::
|
79
|
+
# @return [Pinnacle::Campaigns::Rcs::Types::UpsertRcsAgent]
|
80
80
|
def self.from_json(json_object:)
|
81
81
|
struct = JSON.parse(json_object, object_class: OpenStruct)
|
82
82
|
parsed_json = JSON.parse(json_object)
|
@@ -84,18 +84,18 @@ module Pinnacle
|
|
84
84
|
description = parsed_json["description"]
|
85
85
|
emails = parsed_json["emails"]&.map do |item|
|
86
86
|
item = item.to_json
|
87
|
-
Pinnacle::Campaigns::Rcs::Types::
|
87
|
+
Pinnacle::Campaigns::Rcs::Types::RcsAgentEmail.from_json(json_object: item)
|
88
88
|
end
|
89
89
|
hero_url = parsed_json["heroUrl"]
|
90
90
|
icon_url = parsed_json["iconUrl"]
|
91
91
|
name = parsed_json["name"]
|
92
92
|
phones = parsed_json["phones"]&.map do |item|
|
93
93
|
item = item.to_json
|
94
|
-
Pinnacle::Campaigns::Rcs::Types::
|
94
|
+
Pinnacle::Campaigns::Rcs::Types::RcsAgentPhone.from_json(json_object: item)
|
95
95
|
end
|
96
96
|
websites = parsed_json["websites"]&.map do |item|
|
97
97
|
item = item.to_json
|
98
|
-
Pinnacle::Campaigns::Rcs::Types::
|
98
|
+
Pinnacle::Campaigns::Rcs::Types::RcsAgentWebsite.from_json(json_object: item)
|
99
99
|
end
|
100
100
|
new(
|
101
101
|
color: color,
|
@@ -110,7 +110,7 @@ module Pinnacle
|
|
110
110
|
)
|
111
111
|
end
|
112
112
|
|
113
|
-
# Serialize an instance of
|
113
|
+
# Serialize an instance of UpsertRcsAgent to a JSON object
|
114
114
|
#
|
115
115
|
# @return [String]
|
116
116
|
def to_json(*_args)
|
@@ -8,7 +8,7 @@ module Pinnacle
|
|
8
8
|
module Rcs
|
9
9
|
module Types
|
10
10
|
# Legal documentation links.
|
11
|
-
class
|
11
|
+
class UpsertRcsLinks
|
12
12
|
# @return [String] Privacy policy URL.
|
13
13
|
attr_reader :privacy_policy
|
14
14
|
# @return [String] Terms of service URL.
|
@@ -24,7 +24,7 @@ module Pinnacle
|
|
24
24
|
# @param privacy_policy [String] Privacy policy URL.
|
25
25
|
# @param terms_of_service [String] Terms of service URL.
|
26
26
|
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
27
|
-
# @return [Pinnacle::Campaigns::Rcs::Types::
|
27
|
+
# @return [Pinnacle::Campaigns::Rcs::Types::UpsertRcsLinks]
|
28
28
|
def initialize(privacy_policy: OMIT, terms_of_service: OMIT, additional_properties: nil)
|
29
29
|
@privacy_policy = privacy_policy if privacy_policy != OMIT
|
30
30
|
@terms_of_service = terms_of_service if terms_of_service != OMIT
|
@@ -34,10 +34,10 @@ module Pinnacle
|
|
34
34
|
end
|
35
35
|
end
|
36
36
|
|
37
|
-
# Deserialize a JSON object to an instance of
|
37
|
+
# Deserialize a JSON object to an instance of UpsertRcsLinks
|
38
38
|
#
|
39
39
|
# @param json_object [String]
|
40
|
-
# @return [Pinnacle::Campaigns::Rcs::Types::
|
40
|
+
# @return [Pinnacle::Campaigns::Rcs::Types::UpsertRcsLinks]
|
41
41
|
def self.from_json(json_object:)
|
42
42
|
struct = JSON.parse(json_object, object_class: OpenStruct)
|
43
43
|
parsed_json = JSON.parse(json_object)
|
@@ -50,7 +50,7 @@ module Pinnacle
|
|
50
50
|
)
|
51
51
|
end
|
52
52
|
|
53
|
-
# Serialize an instance of
|
53
|
+
# Serialize an instance of UpsertRcsLinks to a JSON object
|
54
54
|
#
|
55
55
|
# @return [String]
|
56
56
|
def to_json(*_args)
|
@@ -9,9 +9,9 @@ module Pinnacle
|
|
9
9
|
module Rcs
|
10
10
|
module Types
|
11
11
|
# Opt-in configuration.
|
12
|
-
class
|
12
|
+
class UpsertRcsOptIn
|
13
13
|
# @return [Pinnacle::Types::RcsCampaignOptInMethodEnum]
|
14
|
-
attr_reader :
|
14
|
+
attr_reader :method_
|
15
15
|
# @return [String] Message shown to users explaining what they are agreeing to when opting in.
|
16
16
|
attr_reader :terms_and_conditions
|
17
17
|
# @return [OpenStruct] Additional properties unmapped to the current class definition
|
@@ -22,36 +22,36 @@ module Pinnacle
|
|
22
22
|
|
23
23
|
OMIT = Object.new
|
24
24
|
|
25
|
-
# @param
|
25
|
+
# @param method_ [Pinnacle::Types::RcsCampaignOptInMethodEnum]
|
26
26
|
# @param terms_and_conditions [String] Message shown to users explaining what they are agreeing to when opting in.
|
27
27
|
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
28
|
-
# @return [Pinnacle::Campaigns::Rcs::Types::
|
29
|
-
def initialize(
|
30
|
-
@
|
28
|
+
# @return [Pinnacle::Campaigns::Rcs::Types::UpsertRcsOptIn]
|
29
|
+
def initialize(method_: OMIT, terms_and_conditions: OMIT, additional_properties: nil)
|
30
|
+
@method_ = method_ if method_ != OMIT
|
31
31
|
@terms_and_conditions = terms_and_conditions if terms_and_conditions != OMIT
|
32
32
|
@additional_properties = additional_properties
|
33
|
-
@_field_set = { "method":
|
33
|
+
@_field_set = { "method": method_, "termsAndConditions": terms_and_conditions }.reject do |_k, v|
|
34
34
|
v == OMIT
|
35
35
|
end
|
36
36
|
end
|
37
37
|
|
38
|
-
# Deserialize a JSON object to an instance of
|
38
|
+
# Deserialize a JSON object to an instance of UpsertRcsOptIn
|
39
39
|
#
|
40
40
|
# @param json_object [String]
|
41
|
-
# @return [Pinnacle::Campaigns::Rcs::Types::
|
41
|
+
# @return [Pinnacle::Campaigns::Rcs::Types::UpsertRcsOptIn]
|
42
42
|
def self.from_json(json_object:)
|
43
43
|
struct = JSON.parse(json_object, object_class: OpenStruct)
|
44
44
|
parsed_json = JSON.parse(json_object)
|
45
|
-
|
45
|
+
method_ = parsed_json["method"]
|
46
46
|
terms_and_conditions = parsed_json["termsAndConditions"]
|
47
47
|
new(
|
48
|
-
|
48
|
+
method_: method_,
|
49
49
|
terms_and_conditions: terms_and_conditions,
|
50
50
|
additional_properties: struct
|
51
51
|
)
|
52
52
|
end
|
53
53
|
|
54
|
-
# Serialize an instance of
|
54
|
+
# Serialize an instance of UpsertRcsOptIn to a JSON object
|
55
55
|
#
|
56
56
|
# @return [String]
|
57
57
|
def to_json(*_args)
|
@@ -65,7 +65,7 @@ module Pinnacle
|
|
65
65
|
# @param obj [Object]
|
66
66
|
# @return [Void]
|
67
67
|
def self.validate_raw(obj:)
|
68
|
-
obj.
|
68
|
+
obj.method_&.is_a?(Pinnacle::Types::RcsCampaignOptInMethodEnum) != false || raise("Passed value for field obj.method_ is not the expected type, validation failed.")
|
69
69
|
obj.terms_and_conditions&.is_a?(String) != false || raise("Passed value for field obj.terms_and_conditions is not the expected type, validation failed.")
|
70
70
|
end
|
71
71
|
end
|
@@ -8,7 +8,7 @@ module Pinnacle
|
|
8
8
|
module Rcs
|
9
9
|
module Types
|
10
10
|
# Opt-out configuration.
|
11
|
-
class
|
11
|
+
class UpsertRcsOptOut
|
12
12
|
# @return [String] Description for the keyword.
|
13
13
|
attr_reader :description
|
14
14
|
# @return [Array<String>] Keywords to opt-out. <br>
|
@@ -26,7 +26,7 @@ module Pinnacle
|
|
26
26
|
# @param keywords [Array<String>] Keywords to opt-out. <br>
|
27
27
|
# Each keyword must be a single word with no spaces or whitespace characters.
|
28
28
|
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
29
|
-
# @return [Pinnacle::Campaigns::Rcs::Types::
|
29
|
+
# @return [Pinnacle::Campaigns::Rcs::Types::UpsertRcsOptOut]
|
30
30
|
def initialize(description: OMIT, keywords: OMIT, additional_properties: nil)
|
31
31
|
@description = description if description != OMIT
|
32
32
|
@keywords = keywords if keywords != OMIT
|
@@ -36,10 +36,10 @@ module Pinnacle
|
|
36
36
|
end
|
37
37
|
end
|
38
38
|
|
39
|
-
# Deserialize a JSON object to an instance of
|
39
|
+
# Deserialize a JSON object to an instance of UpsertRcsOptOut
|
40
40
|
#
|
41
41
|
# @param json_object [String]
|
42
|
-
# @return [Pinnacle::Campaigns::Rcs::Types::
|
42
|
+
# @return [Pinnacle::Campaigns::Rcs::Types::UpsertRcsOptOut]
|
43
43
|
def self.from_json(json_object:)
|
44
44
|
struct = JSON.parse(json_object, object_class: OpenStruct)
|
45
45
|
parsed_json = JSON.parse(json_object)
|
@@ -52,7 +52,7 @@ module Pinnacle
|
|
52
52
|
)
|
53
53
|
end
|
54
54
|
|
55
|
-
# Serialize an instance of
|
55
|
+
# Serialize an instance of UpsertRcsOptOut to a JSON object
|
56
56
|
#
|
57
57
|
# @return [String]
|
58
58
|
def to_json(*_args)
|
@@ -9,7 +9,7 @@ module Pinnacle
|
|
9
9
|
module Rcs
|
10
10
|
module Types
|
11
11
|
# Use case classification for the campaign.
|
12
|
-
class
|
12
|
+
class UpsertRcsUseCase
|
13
13
|
# @return [String] Summary of the use case.
|
14
14
|
attr_reader :behavior
|
15
15
|
# @return [Pinnacle::Types::RcsCampaignUseCaseEnum]
|
@@ -25,7 +25,7 @@ module Pinnacle
|
|
25
25
|
# @param behavior [String] Summary of the use case.
|
26
26
|
# @param value [Pinnacle::Types::RcsCampaignUseCaseEnum]
|
27
27
|
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
28
|
-
# @return [Pinnacle::Campaigns::Rcs::Types::
|
28
|
+
# @return [Pinnacle::Campaigns::Rcs::Types::UpsertRcsUseCase]
|
29
29
|
def initialize(behavior: OMIT, value: OMIT, additional_properties: nil)
|
30
30
|
@behavior = behavior if behavior != OMIT
|
31
31
|
@value = value if value != OMIT
|
@@ -35,10 +35,10 @@ module Pinnacle
|
|
35
35
|
end
|
36
36
|
end
|
37
37
|
|
38
|
-
# Deserialize a JSON object to an instance of
|
38
|
+
# Deserialize a JSON object to an instance of UpsertRcsUseCase
|
39
39
|
#
|
40
40
|
# @param json_object [String]
|
41
|
-
# @return [Pinnacle::Campaigns::Rcs::Types::
|
41
|
+
# @return [Pinnacle::Campaigns::Rcs::Types::UpsertRcsUseCase]
|
42
42
|
def self.from_json(json_object:)
|
43
43
|
struct = JSON.parse(json_object, object_class: OpenStruct)
|
44
44
|
parsed_json = JSON.parse(json_object)
|
@@ -51,7 +51,7 @@ module Pinnacle
|
|
51
51
|
)
|
52
52
|
end
|
53
53
|
|
54
|
-
# Serialize an instance of
|
54
|
+
# Serialize an instance of UpsertRcsUseCase to a JSON object
|
55
55
|
#
|
56
56
|
# @return [String]
|
57
57
|
def to_json(*_args)
|
@@ -129,7 +129,7 @@ module Pinnacle
|
|
129
129
|
# @param monthly_volume [Pinnacle::Types::MessageVolumeEnum]
|
130
130
|
# @param name [String] Display name of the campaign.
|
131
131
|
# @param opt_in [Hash] Opt-in keyword settings.Request of type Pinnacle::Campaigns::TollFree::Types::UpsertTollFreeSchemaOptIn, as a Hash
|
132
|
-
# * :
|
132
|
+
# * :method_ (Pinnacle::Types::OptInMethodEnum)
|
133
133
|
# * :url (String)
|
134
134
|
# * :workflow_description (String)
|
135
135
|
# @param production_message_content [String] Explain message that would be sent.
|
@@ -149,7 +149,7 @@ module Pinnacle
|
|
149
149
|
# campaign_id: 161,
|
150
150
|
# monthly_volume: ONE_000,
|
151
151
|
# name: "Pinnacle",
|
152
|
-
# opt_in: {
|
152
|
+
# opt_in: { method_: DIGITAL, url: "https://www.pinnacle.sh/", workflow_description: "Visit https://www.pinnacle.sh/" },
|
153
153
|
# production_message_content: "Join Pinnacle's workshop tomorrow and send your first RCS!",
|
154
154
|
# use_case: { summary: "Alerts clients about any Pinnacle hosted workshops.", value: WORKSHOP_ALERTS }
|
155
155
|
# )
|
@@ -336,7 +336,7 @@ module Pinnacle
|
|
336
336
|
# @param monthly_volume [Pinnacle::Types::MessageVolumeEnum]
|
337
337
|
# @param name [String] Display name of the campaign.
|
338
338
|
# @param opt_in [Hash] Opt-in keyword settings.Request of type Pinnacle::Campaigns::TollFree::Types::UpsertTollFreeSchemaOptIn, as a Hash
|
339
|
-
# * :
|
339
|
+
# * :method_ (Pinnacle::Types::OptInMethodEnum)
|
340
340
|
# * :url (String)
|
341
341
|
# * :workflow_description (String)
|
342
342
|
# @param production_message_content [String] Explain message that would be sent.
|
@@ -356,7 +356,7 @@ module Pinnacle
|
|
356
356
|
# campaign_id: 161,
|
357
357
|
# monthly_volume: ONE_000,
|
358
358
|
# name: "Pinnacle",
|
359
|
-
# opt_in: {
|
359
|
+
# opt_in: { method_: DIGITAL, url: "https://www.pinnacle.sh/", workflow_description: "Visit https://www.pinnacle.sh/" },
|
360
360
|
# production_message_content: "Join Pinnacle's workshop tomorrow and send your first RCS!",
|
361
361
|
# use_case: { summary: "Alerts clients about any Pinnacle hosted workshops.", value: WORKSHOP_ALERTS }
|
362
362
|
# )
|
@@ -1,8 +1,8 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
|
3
3
|
require_relative "../../../types/message_volume_enum"
|
4
|
-
require_relative "../../../types/
|
5
|
-
require_relative "../../../types/
|
4
|
+
require_relative "../../../types/upsert_toll_free_campaign_opt_in"
|
5
|
+
require_relative "../../../types/upsert_toll_free_campaign_use_case"
|
6
6
|
require "ostruct"
|
7
7
|
require "json"
|
8
8
|
|
@@ -19,11 +19,11 @@ module Pinnacle
|
|
19
19
|
attr_reader :monthly_volume
|
20
20
|
# @return [String] Display name of the campaign.
|
21
21
|
attr_reader :name
|
22
|
-
# @return [Pinnacle::Types::
|
22
|
+
# @return [Pinnacle::Types::UpsertTollFreeCampaignOptIn] Opt-in keyword settings.
|
23
23
|
attr_reader :opt_in
|
24
24
|
# @return [String] Explain message that would be sent.
|
25
25
|
attr_reader :production_message_content
|
26
|
-
# @return [Pinnacle::Types::
|
26
|
+
# @return [Pinnacle::Types::UpsertTollFreeCampaignUseCase] Use case classification for the campaign.
|
27
27
|
attr_reader :use_case
|
28
28
|
# @return [OpenStruct] Additional properties unmapped to the current class definition
|
29
29
|
attr_reader :additional_properties
|
@@ -37,9 +37,9 @@ module Pinnacle
|
|
37
37
|
# @param campaign_id [Integer] Unique identifier for the campaign.
|
38
38
|
# @param monthly_volume [Pinnacle::Types::MessageVolumeEnum]
|
39
39
|
# @param name [String] Display name of the campaign.
|
40
|
-
# @param opt_in [Pinnacle::Types::
|
40
|
+
# @param opt_in [Pinnacle::Types::UpsertTollFreeCampaignOptIn] Opt-in keyword settings.
|
41
41
|
# @param production_message_content [String] Explain message that would be sent.
|
42
|
-
# @param use_case [Pinnacle::Types::
|
42
|
+
# @param use_case [Pinnacle::Types::UpsertTollFreeCampaignUseCase] Use case classification for the campaign.
|
43
43
|
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
44
44
|
# @return [Pinnacle::Campaigns::TollFree::Types::TollFreeAutofillResponse]
|
45
45
|
def initialize(brand: OMIT, campaign_id: OMIT, monthly_volume: OMIT, name: OMIT, opt_in: OMIT,
|
@@ -80,14 +80,14 @@ module Pinnacle
|
|
80
80
|
opt_in = nil
|
81
81
|
else
|
82
82
|
opt_in = parsed_json["optIn"].to_json
|
83
|
-
opt_in = Pinnacle::Types::
|
83
|
+
opt_in = Pinnacle::Types::UpsertTollFreeCampaignOptIn.from_json(json_object: opt_in)
|
84
84
|
end
|
85
85
|
production_message_content = parsed_json["productionMessageContent"]
|
86
86
|
if parsed_json["useCase"].nil?
|
87
87
|
use_case = nil
|
88
88
|
else
|
89
89
|
use_case = parsed_json["useCase"].to_json
|
90
|
-
use_case = Pinnacle::Types::
|
90
|
+
use_case = Pinnacle::Types::UpsertTollFreeCampaignUseCase.from_json(json_object: use_case)
|
91
91
|
end
|
92
92
|
new(
|
93
93
|
brand: brand,
|
@@ -119,9 +119,9 @@ module Pinnacle
|
|
119
119
|
obj.campaign_id&.is_a?(Integer) != false || raise("Passed value for field obj.campaign_id is not the expected type, validation failed.")
|
120
120
|
obj.monthly_volume&.is_a?(Pinnacle::Types::MessageVolumeEnum) != false || raise("Passed value for field obj.monthly_volume is not the expected type, validation failed.")
|
121
121
|
obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
|
122
|
-
obj.opt_in.nil? || Pinnacle::Types::
|
122
|
+
obj.opt_in.nil? || Pinnacle::Types::UpsertTollFreeCampaignOptIn.validate_raw(obj: obj.opt_in)
|
123
123
|
obj.production_message_content&.is_a?(String) != false || raise("Passed value for field obj.production_message_content is not the expected type, validation failed.")
|
124
|
-
obj.use_case.nil? || Pinnacle::Types::
|
124
|
+
obj.use_case.nil? || Pinnacle::Types::UpsertTollFreeCampaignUseCase.validate_raw(obj: obj.use_case)
|
125
125
|
end
|
126
126
|
end
|
127
127
|
end
|
@@ -11,7 +11,7 @@ module Pinnacle
|
|
11
11
|
# Opt-in keyword settings.
|
12
12
|
class UpsertTollFreeSchemaOptIn
|
13
13
|
# @return [Pinnacle::Types::OptInMethodEnum]
|
14
|
-
attr_reader :
|
14
|
+
attr_reader :method_
|
15
15
|
# @return [String] Url to opt in.
|
16
16
|
attr_reader :url
|
17
17
|
# @return [String] Explain how users find the opt-in.
|
@@ -24,18 +24,18 @@ module Pinnacle
|
|
24
24
|
|
25
25
|
OMIT = Object.new
|
26
26
|
|
27
|
-
# @param
|
27
|
+
# @param method_ [Pinnacle::Types::OptInMethodEnum]
|
28
28
|
# @param url [String] Url to opt in.
|
29
29
|
# @param workflow_description [String] Explain how users find the opt-in.
|
30
30
|
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
31
31
|
# @return [Pinnacle::Campaigns::TollFree::Types::UpsertTollFreeSchemaOptIn]
|
32
|
-
def initialize(
|
33
|
-
@
|
32
|
+
def initialize(method_: OMIT, url: OMIT, workflow_description: OMIT, additional_properties: nil)
|
33
|
+
@method_ = method_ if method_ != OMIT
|
34
34
|
@url = url if url != OMIT
|
35
35
|
@workflow_description = workflow_description if workflow_description != OMIT
|
36
36
|
@additional_properties = additional_properties
|
37
37
|
@_field_set = {
|
38
|
-
"method":
|
38
|
+
"method": method_,
|
39
39
|
"url": url,
|
40
40
|
"workflowDescription": workflow_description
|
41
41
|
}.reject do |_k, v|
|
@@ -50,11 +50,11 @@ module Pinnacle
|
|
50
50
|
def self.from_json(json_object:)
|
51
51
|
struct = JSON.parse(json_object, object_class: OpenStruct)
|
52
52
|
parsed_json = JSON.parse(json_object)
|
53
|
-
|
53
|
+
method_ = parsed_json["method"]
|
54
54
|
url = parsed_json["url"]
|
55
55
|
workflow_description = parsed_json["workflowDescription"]
|
56
56
|
new(
|
57
|
-
|
57
|
+
method_: method_,
|
58
58
|
url: url,
|
59
59
|
workflow_description: workflow_description,
|
60
60
|
additional_properties: struct
|
@@ -75,7 +75,7 @@ module Pinnacle
|
|
75
75
|
# @param obj [Object]
|
76
76
|
# @return [Void]
|
77
77
|
def self.validate_raw(obj:)
|
78
|
-
obj.
|
78
|
+
obj.method_&.is_a?(Pinnacle::Types::OptInMethodEnum) != false || raise("Passed value for field obj.method_ is not the expected type, validation failed.")
|
79
79
|
obj.url&.is_a?(String) != false || raise("Passed value for field obj.url is not the expected type, validation failed.")
|
80
80
|
obj.workflow_description&.is_a?(String) != false || raise("Passed value for field obj.workflow_description is not the expected type, validation failed.")
|
81
81
|
end
|
@@ -22,7 +22,7 @@ module Pinnacle
|
|
22
22
|
# Fetch a specific conversation using either its unique identifier or by matching
|
23
23
|
# sender and recipient details.
|
24
24
|
#
|
25
|
-
# @param request [Pinnacle::Types::
|
25
|
+
# @param request [Pinnacle::Types::ConversationByIdParams, Pinnacle::Types::ConversationByParticipantsParams]
|
26
26
|
# @param request_options [Pinnacle::RequestOptions]
|
27
27
|
# @return [Pinnacle::Types::Conversation]
|
28
28
|
# @example
|
@@ -150,7 +150,7 @@ module Pinnacle
|
|
150
150
|
# Fetch a specific conversation using either its unique identifier or by matching
|
151
151
|
# sender and recipient details.
|
152
152
|
#
|
153
|
-
# @param request [Pinnacle::Types::
|
153
|
+
# @param request [Pinnacle::Types::ConversationByIdParams, Pinnacle::Types::ConversationByParticipantsParams]
|
154
154
|
# @param request_options [Pinnacle::RequestOptions]
|
155
155
|
# @return [Pinnacle::Types::Conversation]
|
156
156
|
# @example
|