rcs 2.0.1 → 2.0.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/audiences/client.rb +347 -0
- data/lib/rcs/audiences/contacts/client.rb +173 -0
- data/lib/rcs/audiences/types/audiences_get_response.rb +58 -0
- data/lib/rcs/brands/client.rb +19 -6
- data/lib/rcs/campaigns/dlc/client.rb +12 -12
- data/lib/rcs/campaigns/dlc/types/{upsert_dlc_campaign_help_keywords.rb → dlc_campaign_help_keywords.rb} +5 -5
- data/lib/rcs/campaigns/dlc/types/{upsert_dlc_campaign_keywords.rb → dlc_campaign_keywords.rb} +20 -20
- data/lib/rcs/campaigns/dlc/types/{upsert_dlc_campaign_links.rb → dlc_campaign_links.rb} +5 -5
- data/lib/rcs/campaigns/dlc/types/{upsert_dlc_campaign_opt_in_keywords.rb → dlc_campaign_opt_in_keywords.rb} +5 -5
- data/lib/rcs/campaigns/dlc/types/{upsert_dlc_campaign_opt_out_keywords.rb → dlc_campaign_opt_out_keywords.rb} +5 -5
- data/lib/rcs/campaigns/dlc/types/{upsert_dlc_campaign_options.rb → dlc_campaign_options.rb} +5 -5
- data/lib/rcs/campaigns/dlc/types/{upsert_dlc_campaign_use_case.rb → dlc_campaign_use_case.rb} +5 -5
- data/lib/rcs/campaigns/rcs/client.rb +144 -51
- data/lib/rcs/campaigns/rcs/types/{upsert_rcs_agent.rb → rcs_agent.rb} +15 -9
- data/lib/rcs/campaigns/rcs/types/rcs_autofill_response.rb +122 -43
- data/lib/rcs/campaigns/rcs/types/{upsert_rcs_opt_out.rb → rcs_campaign_help_keywords.rb} +20 -19
- data/lib/rcs/campaigns/rcs/types/rcs_campaign_keywords.rb +98 -0
- data/lib/rcs/campaigns/rcs/types/rcs_campaign_opt_in_keywords.rb +87 -0
- data/lib/rcs/campaigns/rcs/types/rcs_campaign_opt_out_keywords.rb +83 -0
- data/lib/rcs/campaigns/rcs/types/rcs_campaign_traffic.rb +76 -0
- data/lib/rcs/campaigns/rcs/types/{upsert_rcs_links.rb → rcs_links.rb} +5 -5
- data/lib/rcs/campaigns/rcs/types/{upsert_rcs_use_case.rb → rcs_use_case.rb} +7 -7
- data/lib/rcs/campaigns/toll_free/client.rb +53 -10
- data/lib/rcs/campaigns/toll_free/types/toll_free_autofill_response.rb +54 -12
- data/lib/rcs/campaigns/toll_free/types/toll_free_campaign_help_keywords.rb +66 -0
- data/lib/rcs/campaigns/toll_free/types/toll_free_campaign_keywords.rb +86 -0
- data/lib/rcs/campaigns/toll_free/types/toll_free_campaign_links.rb +74 -0
- data/lib/rcs/campaigns/toll_free/types/{upsert_toll_free_schema_opt_in.rb → toll_free_campaign_opt_in.rb} +5 -5
- data/lib/rcs/campaigns/toll_free/types/toll_free_campaign_opt_in_keywords.rb +78 -0
- data/lib/rcs/campaigns/toll_free/types/toll_free_campaign_options.rb +64 -0
- data/lib/rcs/campaigns/toll_free/types/{upsert_toll_free_schema_use_case.rb → toll_free_campaign_use_case.rb} +5 -5
- data/lib/rcs/messages/blast/client.rb +419 -0
- data/lib/rcs/messages/blast/types/blast_mms_options.rb +82 -0
- data/lib/rcs/messages/blast/types/blast_mms_response.rb +60 -0
- data/lib/rcs/messages/blast/types/blast_rcs_options.rb +118 -0
- data/lib/rcs/messages/blast/types/blast_rcs_request_options_standalone_card.rb +82 -0
- data/lib/rcs/messages/blast/types/blast_rcs_request_options_standalone_card_image_alignment.rb +16 -0
- data/lib/rcs/messages/blast/types/blast_rcs_request_options_standalone_card_orientation.rb +15 -0
- data/lib/rcs/messages/blast/types/blast_rcs_response.rb +60 -0
- data/lib/rcs/messages/blast/types/blast_sms_options.rb +70 -0
- data/lib/rcs/messages/blast/types/blast_sms_response.rb +60 -0
- data/lib/rcs/messages/mms/client.rb +6 -6
- data/lib/rcs/messages/mms/types/mms_send_response.rb +4 -4
- data/lib/rcs/messages/rcs/client.rb +7 -7
- data/lib/rcs/messages/rcs/types/{rcs_send_response.rb → send_rich_message_response.rb} +11 -11
- data/lib/rcs/messages/schedule/client.rb +103 -0
- data/lib/rcs/messages/sms/client.rb +6 -6
- data/lib/rcs/messages/sms/types/sms_send_response.rb +4 -4
- data/lib/rcs/types/audience_count_only.rb +87 -0
- data/lib/rcs/types/audience_with_pagination.rb +114 -0
- data/lib/rcs/types/{rcs_base.rb → base_rich_message.rb} +10 -10
- data/lib/rcs/types/blast_details.rb +110 -0
- data/lib/rcs/types/company_entity_type_enum.rb +14 -0
- data/lib/rcs/types/delete_audience_response.rb +57 -0
- data/lib/rcs/types/dlc_campaign_with_extended_brand_and_status.rb +30 -2
- data/lib/rcs/types/dlc_with_extended_brand_and_status_mno_brand_tier.rb +15 -0
- data/lib/rcs/types/dlc_with_extended_brand_and_status_mno_tcr_tier.rb +22 -0
- data/lib/rcs/types/extended_brand.rb +10 -1
- data/lib/rcs/types/extended_brand_with_vetting.rb +10 -1
- data/lib/rcs/types/extended_rcs_campaign.rb +122 -51
- data/lib/rcs/types/message_schedule.rb +52 -24
- data/lib/rcs/types/message_status_enum.rb +1 -0
- data/lib/rcs/types/optional_brand_info.rb +10 -1
- data/lib/rcs/types/pagination.rb +81 -0
- data/lib/rcs/types/rcs_campaign.rb +122 -43
- data/lib/rcs/types/rcs_campaign_schema_extra_keywords.rb +94 -0
- data/lib/rcs/types/{rcs_campaign_schema_extra_opt_out.rb → rcs_campaign_schema_extra_keywords_help.rb} +18 -17
- data/lib/rcs/types/rcs_campaign_schema_extra_keywords_opt_in.rb +73 -0
- data/lib/rcs/types/rcs_campaign_schema_extra_keywords_opt_out.rb +73 -0
- data/lib/rcs/types/rcs_campaign_schema_extra_traffic.rb +72 -0
- data/lib/rcs/types/rcs_campaign_schema_extra_use_case.rb +2 -2
- data/lib/rcs/types/rcs_campaign_schema_keywords.rb +94 -0
- data/lib/rcs/types/{rcs_campaign_schema_opt_out.rb → rcs_campaign_schema_keywords_help.rb} +18 -17
- data/lib/rcs/types/rcs_campaign_schema_keywords_opt_in.rb +73 -0
- data/lib/rcs/types/rcs_campaign_schema_keywords_opt_out.rb +73 -0
- data/lib/rcs/types/rcs_campaign_schema_traffic.rb +72 -0
- data/lib/rcs/types/rcs_campaign_schema_use_case.rb +2 -2
- data/lib/rcs/types/rcs_cards_content_cards_item.rb +4 -2
- data/lib/rcs/types/rcs_content.rb +4 -4
- data/lib/rcs/types/rcs_messaging_type_enum.rb +17 -0
- data/lib/rcs/types/rcs_validate_content.rb +8 -8
- data/lib/rcs/types/rcs_validation_result.rb +9 -2
- data/lib/rcs/types/{rcs_cards_cards_item.rb → rich_card.rb} +9 -7
- data/lib/rcs/types/{rcs_cards.rb → rich_cards.rb} +9 -9
- data/lib/rcs/types/rich_cards_message.rb +9 -9
- data/lib/rcs/types/rich_media_message.rb +5 -5
- data/lib/rcs/types/{send_rcs_card_options_standalone_card.rb → rich_standalone_card_options.rb} +9 -7
- data/lib/rcs/types/{rcs_text_content.rb → rich_text.rb} +5 -5
- data/lib/rcs/types/rich_text_message.rb +5 -5
- data/lib/rcs/types/schedule_cancel_result.rb +58 -0
- data/lib/rcs/types/scheduled_blast_details.rb +76 -0
- data/lib/rcs/types/scheduled_blast_response_config.rb +89 -0
- data/lib/rcs/types/{scheduled_messaage.rb → scheduled_message.rb} +5 -5
- data/lib/rcs/types/{send_rcs_card_options.rb → send_rich_cards_options.rb} +18 -14
- data/lib/rcs/types/{options.rb → send_rich_message_options.rb} +5 -5
- data/lib/rcs/types/sent_mms_details.rb +18 -4
- data/lib/rcs/types/{sent_rcs_details.rb → sent_rich_message.rb} +5 -5
- data/lib/rcs/types/toll_free_campaign.rb +54 -12
- data/lib/rcs/types/toll_free_campaign_schema_keywords.rb +82 -0
- data/lib/rcs/types/toll_free_campaign_schema_keywords_help.rb +62 -0
- data/lib/rcs/types/toll_free_campaign_schema_keywords_opt_in.rb +74 -0
- data/lib/rcs/types/toll_free_campaign_schema_links.rb +70 -0
- data/lib/rcs/types/{upsert_toll_free_campaign_opt_in.rb → toll_free_campaign_schema_opt_in.rb} +5 -5
- data/lib/rcs/types/toll_free_campaign_schema_options.rb +60 -0
- data/lib/rcs/types/{upsert_toll_free_campaign_use_case.rb → toll_free_campaign_schema_use_case.rb} +5 -5
- data/lib/rcs/types/toll_free_campaign_with_extended_brand_and_status.rb +54 -12
- data/lib/rcs.rb +7 -0
- data/lib/requests.rb +2 -2
- data/lib/types_export.rb +71 -32
- metadata +77 -34
- data/lib/rcs/campaigns/rcs/types/upsert_rcs_opt_in.rb +0 -75
- data/lib/rcs/types/rcs_base_options.rb +0 -111
- data/lib/rcs/types/rcs_campaign_opt_in_method_enum.rb +0 -15
- data/lib/rcs/types/rcs_campaign_schema_extra_opt_in.rb +0 -71
- data/lib/rcs/types/rcs_campaign_schema_opt_in.rb +0 -71
data/lib/rcs/brands/client.rb
CHANGED
|
@@ -6,6 +6,7 @@ require_relative "../types/optional_brand_info"
|
|
|
6
6
|
require_relative "../types/upsert_contact"
|
|
7
7
|
require_relative "../types/company_sector_enum"
|
|
8
8
|
require_relative "../types/company_type_enum"
|
|
9
|
+
require_relative "../types/company_entity_type_enum"
|
|
9
10
|
require_relative "../types/extended_brand"
|
|
10
11
|
require_relative "../types/extended_brand_with_vetting"
|
|
11
12
|
require_relative "../types/submission_results"
|
|
@@ -89,6 +90,7 @@ module Pinnacle
|
|
|
89
90
|
# @param name [String] Legal name of the brand as registered.
|
|
90
91
|
# @param sector [Pinnacle::Types::CompanySectorEnum] Industry the brand operates in.
|
|
91
92
|
# @param type [Pinnacle::Types::CompanyTypeEnum] Legal structure of the brand.
|
|
93
|
+
# @param entity_type [Pinnacle::Types::CompanyEntityTypeEnum] Legal entity type of the brand.
|
|
92
94
|
# @param website [String] Brand website URL.
|
|
93
95
|
# @param request_options [Pinnacle::RequestOptions]
|
|
94
96
|
# @return [Pinnacle::Types::ExtendedBrand]
|
|
@@ -109,10 +111,11 @@ module Pinnacle
|
|
|
109
111
|
# name: "Pinnacle",
|
|
110
112
|
# sector: TECHNOLOGY,
|
|
111
113
|
# type: PRIVATE_PROFIT,
|
|
114
|
+
# entity_type: LLC,
|
|
112
115
|
# website: "https://www.pinnacle.sh"
|
|
113
116
|
# )
|
|
114
117
|
def upsert(address: nil, contact: nil, dba: nil, description: nil, ein: nil, email: nil, id: nil, name: nil,
|
|
115
|
-
sector: nil, type: nil, website: nil, request_options: nil)
|
|
118
|
+
sector: nil, type: nil, entity_type: nil, website: nil, request_options: nil)
|
|
116
119
|
response = @request_client.conn.post do |req|
|
|
117
120
|
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
|
118
121
|
req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
|
|
@@ -136,6 +139,7 @@ module Pinnacle
|
|
|
136
139
|
name: name,
|
|
137
140
|
sector: sector,
|
|
138
141
|
type: type,
|
|
142
|
+
entityType: entity_type,
|
|
139
143
|
website: website
|
|
140
144
|
}.compact
|
|
141
145
|
req.url "#{@request_client.get_url(request_options: request_options)}/brands"
|
|
@@ -230,6 +234,7 @@ module Pinnacle
|
|
|
230
234
|
# @param name [String] Legal name of the brand as registered.
|
|
231
235
|
# @param sector [Pinnacle::Types::CompanySectorEnum]
|
|
232
236
|
# @param type [Pinnacle::Types::CompanyTypeEnum]
|
|
237
|
+
# @param entity_type [Pinnacle::Types::CompanyEntityTypeEnum] Legal entity type of the brand.
|
|
233
238
|
# @param website [String] Brand website URL.
|
|
234
239
|
# @param request_options [Pinnacle::RequestOptions]
|
|
235
240
|
# @return [Pinnacle::Types::ValidationResults]
|
|
@@ -249,10 +254,11 @@ module Pinnacle
|
|
|
249
254
|
# name: "Pinnacle",
|
|
250
255
|
# sector: TECHNOLOGY,
|
|
251
256
|
# type: PRIVATE_PROFIT,
|
|
257
|
+
# entity_type: LLC,
|
|
252
258
|
# website: "https://www.pinnacle.sh"
|
|
253
259
|
# )
|
|
254
|
-
def validate(address:, contact:, description:, email:, name:, sector:, type:, website:, dba: nil,
|
|
255
|
-
request_options: nil)
|
|
260
|
+
def validate(address:, contact:, description:, email:, name:, sector:, type:, entity_type:, website:, dba: nil,
|
|
261
|
+
ein: nil, request_options: nil)
|
|
256
262
|
response = @request_client.conn.post do |req|
|
|
257
263
|
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
|
258
264
|
req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
|
|
@@ -275,6 +281,7 @@ module Pinnacle
|
|
|
275
281
|
name: name,
|
|
276
282
|
sector: sector,
|
|
277
283
|
type: type,
|
|
284
|
+
entityType: entity_type,
|
|
278
285
|
website: website
|
|
279
286
|
}.compact
|
|
280
287
|
req.url "#{@request_client.get_url(request_options: request_options)}/brands/validate"
|
|
@@ -398,6 +405,7 @@ module Pinnacle
|
|
|
398
405
|
# @param name [String] Legal name of the brand as registered.
|
|
399
406
|
# @param sector [Pinnacle::Types::CompanySectorEnum] Industry the brand operates in.
|
|
400
407
|
# @param type [Pinnacle::Types::CompanyTypeEnum] Legal structure of the brand.
|
|
408
|
+
# @param entity_type [Pinnacle::Types::CompanyEntityTypeEnum] Legal entity type of the brand.
|
|
401
409
|
# @param website [String] Brand website URL.
|
|
402
410
|
# @param request_options [Pinnacle::RequestOptions]
|
|
403
411
|
# @return [Pinnacle::Types::ExtendedBrand]
|
|
@@ -418,10 +426,11 @@ module Pinnacle
|
|
|
418
426
|
# name: "Pinnacle",
|
|
419
427
|
# sector: TECHNOLOGY,
|
|
420
428
|
# type: PRIVATE_PROFIT,
|
|
429
|
+
# entity_type: LLC,
|
|
421
430
|
# website: "https://www.pinnacle.sh"
|
|
422
431
|
# )
|
|
423
432
|
def upsert(address: nil, contact: nil, dba: nil, description: nil, ein: nil, email: nil, id: nil, name: nil,
|
|
424
|
-
sector: nil, type: nil, website: nil, request_options: nil)
|
|
433
|
+
sector: nil, type: nil, entity_type: nil, website: nil, request_options: nil)
|
|
425
434
|
Async do
|
|
426
435
|
response = @request_client.conn.post do |req|
|
|
427
436
|
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
|
@@ -446,6 +455,7 @@ module Pinnacle
|
|
|
446
455
|
name: name,
|
|
447
456
|
sector: sector,
|
|
448
457
|
type: type,
|
|
458
|
+
entityType: entity_type,
|
|
449
459
|
website: website
|
|
450
460
|
}.compact
|
|
451
461
|
req.url "#{@request_client.get_url(request_options: request_options)}/brands"
|
|
@@ -545,6 +555,7 @@ module Pinnacle
|
|
|
545
555
|
# @param name [String] Legal name of the brand as registered.
|
|
546
556
|
# @param sector [Pinnacle::Types::CompanySectorEnum]
|
|
547
557
|
# @param type [Pinnacle::Types::CompanyTypeEnum]
|
|
558
|
+
# @param entity_type [Pinnacle::Types::CompanyEntityTypeEnum] Legal entity type of the brand.
|
|
548
559
|
# @param website [String] Brand website URL.
|
|
549
560
|
# @param request_options [Pinnacle::RequestOptions]
|
|
550
561
|
# @return [Pinnacle::Types::ValidationResults]
|
|
@@ -564,10 +575,11 @@ module Pinnacle
|
|
|
564
575
|
# name: "Pinnacle",
|
|
565
576
|
# sector: TECHNOLOGY,
|
|
566
577
|
# type: PRIVATE_PROFIT,
|
|
578
|
+
# entity_type: LLC,
|
|
567
579
|
# website: "https://www.pinnacle.sh"
|
|
568
580
|
# )
|
|
569
|
-
def validate(address:, contact:, description:, email:, name:, sector:, type:, website:, dba: nil,
|
|
570
|
-
request_options: nil)
|
|
581
|
+
def validate(address:, contact:, description:, email:, name:, sector:, type:, entity_type:, website:, dba: nil,
|
|
582
|
+
ein: nil, request_options: nil)
|
|
571
583
|
Async do
|
|
572
584
|
response = @request_client.conn.post do |req|
|
|
573
585
|
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
|
@@ -591,6 +603,7 @@ module Pinnacle
|
|
|
591
603
|
name: name,
|
|
592
604
|
sector: sector,
|
|
593
605
|
type: type,
|
|
606
|
+
entityType: entity_type,
|
|
594
607
|
website: website
|
|
595
608
|
}.compact
|
|
596
609
|
req.url "#{@request_client.get_url(request_options: request_options)}/brands/validate"
|
|
@@ -5,10 +5,10 @@ require_relative "../../types/autofill_campaign_params"
|
|
|
5
5
|
require_relative "../../types/autofill_dlc_campaign_response"
|
|
6
6
|
require_relative "../../types/dlc_campaign_with_extended_brand_and_status"
|
|
7
7
|
require_relative "../../types/campaign_submission_result"
|
|
8
|
-
require_relative "types/
|
|
9
|
-
require_relative "types/
|
|
10
|
-
require_relative "types/
|
|
11
|
-
require_relative "types/
|
|
8
|
+
require_relative "types/dlc_campaign_keywords"
|
|
9
|
+
require_relative "types/dlc_campaign_links"
|
|
10
|
+
require_relative "types/dlc_campaign_options"
|
|
11
|
+
require_relative "types/dlc_campaign_use_case"
|
|
12
12
|
require_relative "../../types/validate_campaign_params"
|
|
13
13
|
require_relative "../../types/campaign_validation_result"
|
|
14
14
|
require "async"
|
|
@@ -134,7 +134,7 @@ module Pinnacle
|
|
|
134
134
|
# @param campaign_id [String] Unique identifier for the campaign. This identifier is a string that always
|
|
135
135
|
# begins with the prefix `dlc_`, for example: `dlc_1234567890`.
|
|
136
136
|
# @param description [String] Description of the campaign.
|
|
137
|
-
# @param keywords [Hash] Keyword response configuration.Request of type Pinnacle::Campaigns::Dlc::Types::
|
|
137
|
+
# @param keywords [Hash] Keyword response configuration.Request of type Pinnacle::Campaigns::Dlc::Types::DlcCampaignKeywords, as a Hash
|
|
138
138
|
# * :help (Hash)
|
|
139
139
|
# * :message (String)
|
|
140
140
|
# * :values (Array<String>)
|
|
@@ -144,12 +144,12 @@ module Pinnacle
|
|
|
144
144
|
# * :opt_out (Hash)
|
|
145
145
|
# * :message (String)
|
|
146
146
|
# * :values (Array<String>)
|
|
147
|
-
# @param links [Hash] Legal documentation links.Request of type Pinnacle::Campaigns::Dlc::Types::
|
|
147
|
+
# @param links [Hash] Legal documentation links.Request of type Pinnacle::Campaigns::Dlc::Types::DlcCampaignLinks, as a Hash
|
|
148
148
|
# * :privacy_policy (String)
|
|
149
149
|
# * :terms_of_service (String)
|
|
150
150
|
# @param message_flow [String] Describe the flow of how users will opt in to this campaign.
|
|
151
151
|
# @param name [String] Display name of the campaign.
|
|
152
|
-
# @param options [Hash] Campaign configuration options.Request of type Pinnacle::Campaigns::Dlc::Types::
|
|
152
|
+
# @param options [Hash] Campaign configuration options.Request of type Pinnacle::Campaigns::Dlc::Types::DlcCampaignOptions, as a Hash
|
|
153
153
|
# * :affiliate_marketing (Boolean)
|
|
154
154
|
# * :age_gated (Boolean)
|
|
155
155
|
# * :direct_lending (Boolean)
|
|
@@ -157,7 +157,7 @@ module Pinnacle
|
|
|
157
157
|
# * :embedded_phone (Boolean)
|
|
158
158
|
# * :number_pooling (Boolean)
|
|
159
159
|
# @param sample_messages [Array<String>] Example messages for the campaign.
|
|
160
|
-
# @param use_case [Hash] Use case for the campaign.Request of type Pinnacle::Campaigns::Dlc::Types::
|
|
160
|
+
# @param use_case [Hash] Use case for the campaign.Request of type Pinnacle::Campaigns::Dlc::Types::DlcCampaignUseCase, as a Hash
|
|
161
161
|
# * :sub (Array<Pinnacle::Types::SubUseCaseEnum>)
|
|
162
162
|
# * :value (Pinnacle::Types::DlcCampaignUseCaseEnum)
|
|
163
163
|
# @param request_options [Pinnacle::RequestOptions]
|
|
@@ -371,7 +371,7 @@ module Pinnacle
|
|
|
371
371
|
# @param campaign_id [String] Unique identifier for the campaign. This identifier is a string that always
|
|
372
372
|
# begins with the prefix `dlc_`, for example: `dlc_1234567890`.
|
|
373
373
|
# @param description [String] Description of the campaign.
|
|
374
|
-
# @param keywords [Hash] Keyword response configuration.Request of type Pinnacle::Campaigns::Dlc::Types::
|
|
374
|
+
# @param keywords [Hash] Keyword response configuration.Request of type Pinnacle::Campaigns::Dlc::Types::DlcCampaignKeywords, as a Hash
|
|
375
375
|
# * :help (Hash)
|
|
376
376
|
# * :message (String)
|
|
377
377
|
# * :values (Array<String>)
|
|
@@ -381,12 +381,12 @@ module Pinnacle
|
|
|
381
381
|
# * :opt_out (Hash)
|
|
382
382
|
# * :message (String)
|
|
383
383
|
# * :values (Array<String>)
|
|
384
|
-
# @param links [Hash] Legal documentation links.Request of type Pinnacle::Campaigns::Dlc::Types::
|
|
384
|
+
# @param links [Hash] Legal documentation links.Request of type Pinnacle::Campaigns::Dlc::Types::DlcCampaignLinks, as a Hash
|
|
385
385
|
# * :privacy_policy (String)
|
|
386
386
|
# * :terms_of_service (String)
|
|
387
387
|
# @param message_flow [String] Describe the flow of how users will opt in to this campaign.
|
|
388
388
|
# @param name [String] Display name of the campaign.
|
|
389
|
-
# @param options [Hash] Campaign configuration options.Request of type Pinnacle::Campaigns::Dlc::Types::
|
|
389
|
+
# @param options [Hash] Campaign configuration options.Request of type Pinnacle::Campaigns::Dlc::Types::DlcCampaignOptions, as a Hash
|
|
390
390
|
# * :affiliate_marketing (Boolean)
|
|
391
391
|
# * :age_gated (Boolean)
|
|
392
392
|
# * :direct_lending (Boolean)
|
|
@@ -394,7 +394,7 @@ module Pinnacle
|
|
|
394
394
|
# * :embedded_phone (Boolean)
|
|
395
395
|
# * :number_pooling (Boolean)
|
|
396
396
|
# @param sample_messages [Array<String>] Example messages for the campaign.
|
|
397
|
-
# @param use_case [Hash] Use case for the campaign.Request of type Pinnacle::Campaigns::Dlc::Types::
|
|
397
|
+
# @param use_case [Hash] Use case for the campaign.Request of type Pinnacle::Campaigns::Dlc::Types::DlcCampaignUseCase, as a Hash
|
|
398
398
|
# * :sub (Array<Pinnacle::Types::SubUseCaseEnum>)
|
|
399
399
|
# * :value (Pinnacle::Types::DlcCampaignUseCaseEnum)
|
|
400
400
|
# @param request_options [Pinnacle::RequestOptions]
|
|
@@ -8,7 +8,7 @@ module Pinnacle
|
|
|
8
8
|
module Dlc
|
|
9
9
|
module Types
|
|
10
10
|
# Help keyword settings.
|
|
11
|
-
class
|
|
11
|
+
class DlcCampaignHelpKeywords
|
|
12
12
|
# @return [String] Response message for help keywords.
|
|
13
13
|
attr_reader :message
|
|
14
14
|
# @return [Array<String>] Keywords that trigger help response.
|
|
@@ -24,7 +24,7 @@ module Pinnacle
|
|
|
24
24
|
# @param message [String] Response message for help keywords.
|
|
25
25
|
# @param values [Array<String>] Keywords that trigger help response.
|
|
26
26
|
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
|
27
|
-
# @return [Pinnacle::Campaigns::Dlc::Types::
|
|
27
|
+
# @return [Pinnacle::Campaigns::Dlc::Types::DlcCampaignHelpKeywords]
|
|
28
28
|
def initialize(message: OMIT, values: OMIT, additional_properties: nil)
|
|
29
29
|
@message = message if message != OMIT
|
|
30
30
|
@values = values if values != 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 DlcCampaignHelpKeywords
|
|
38
38
|
#
|
|
39
39
|
# @param json_object [String]
|
|
40
|
-
# @return [Pinnacle::Campaigns::Dlc::Types::
|
|
40
|
+
# @return [Pinnacle::Campaigns::Dlc::Types::DlcCampaignHelpKeywords]
|
|
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 DlcCampaignHelpKeywords to a JSON object
|
|
54
54
|
#
|
|
55
55
|
# @return [String]
|
|
56
56
|
def to_json(*_args)
|
data/lib/rcs/campaigns/dlc/types/{upsert_dlc_campaign_keywords.rb → dlc_campaign_keywords.rb}
RENAMED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
-
require_relative "
|
|
4
|
-
require_relative "
|
|
5
|
-
require_relative "
|
|
3
|
+
require_relative "dlc_campaign_help_keywords"
|
|
4
|
+
require_relative "dlc_campaign_opt_in_keywords"
|
|
5
|
+
require_relative "dlc_campaign_opt_out_keywords"
|
|
6
6
|
require "ostruct"
|
|
7
7
|
require "json"
|
|
8
8
|
|
|
@@ -11,12 +11,12 @@ module Pinnacle
|
|
|
11
11
|
module Dlc
|
|
12
12
|
module Types
|
|
13
13
|
# Keyword response configuration.
|
|
14
|
-
class
|
|
15
|
-
# @return [Pinnacle::Campaigns::Dlc::Types::
|
|
14
|
+
class DlcCampaignKeywords
|
|
15
|
+
# @return [Pinnacle::Campaigns::Dlc::Types::DlcCampaignHelpKeywords] Help keyword settings.
|
|
16
16
|
attr_reader :help
|
|
17
|
-
# @return [Pinnacle::Campaigns::Dlc::Types::
|
|
17
|
+
# @return [Pinnacle::Campaigns::Dlc::Types::DlcCampaignOptInKeywords] Opt-in keyword settings.
|
|
18
18
|
attr_reader :opt_in
|
|
19
|
-
# @return [Pinnacle::Campaigns::Dlc::Types::
|
|
19
|
+
# @return [Pinnacle::Campaigns::Dlc::Types::DlcCampaignOptOutKeywords] Opt-out keyword settings.
|
|
20
20
|
attr_reader :opt_out
|
|
21
21
|
# @return [OpenStruct] Additional properties unmapped to the current class definition
|
|
22
22
|
attr_reader :additional_properties
|
|
@@ -26,11 +26,11 @@ module Pinnacle
|
|
|
26
26
|
|
|
27
27
|
OMIT = Object.new
|
|
28
28
|
|
|
29
|
-
# @param help [Pinnacle::Campaigns::Dlc::Types::
|
|
30
|
-
# @param opt_in [Pinnacle::Campaigns::Dlc::Types::
|
|
31
|
-
# @param opt_out [Pinnacle::Campaigns::Dlc::Types::
|
|
29
|
+
# @param help [Pinnacle::Campaigns::Dlc::Types::DlcCampaignHelpKeywords] Help keyword settings.
|
|
30
|
+
# @param opt_in [Pinnacle::Campaigns::Dlc::Types::DlcCampaignOptInKeywords] Opt-in keyword settings.
|
|
31
|
+
# @param opt_out [Pinnacle::Campaigns::Dlc::Types::DlcCampaignOptOutKeywords] Opt-out keyword settings.
|
|
32
32
|
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
|
33
|
-
# @return [Pinnacle::Campaigns::Dlc::Types::
|
|
33
|
+
# @return [Pinnacle::Campaigns::Dlc::Types::DlcCampaignKeywords]
|
|
34
34
|
def initialize(help: OMIT, opt_in: OMIT, opt_out: OMIT, additional_properties: nil)
|
|
35
35
|
@help = help if help != OMIT
|
|
36
36
|
@opt_in = opt_in if opt_in != OMIT
|
|
@@ -41,10 +41,10 @@ module Pinnacle
|
|
|
41
41
|
end
|
|
42
42
|
end
|
|
43
43
|
|
|
44
|
-
# Deserialize a JSON object to an instance of
|
|
44
|
+
# Deserialize a JSON object to an instance of DlcCampaignKeywords
|
|
45
45
|
#
|
|
46
46
|
# @param json_object [String]
|
|
47
|
-
# @return [Pinnacle::Campaigns::Dlc::Types::
|
|
47
|
+
# @return [Pinnacle::Campaigns::Dlc::Types::DlcCampaignKeywords]
|
|
48
48
|
def self.from_json(json_object:)
|
|
49
49
|
struct = JSON.parse(json_object, object_class: OpenStruct)
|
|
50
50
|
parsed_json = JSON.parse(json_object)
|
|
@@ -52,19 +52,19 @@ module Pinnacle
|
|
|
52
52
|
help = nil
|
|
53
53
|
else
|
|
54
54
|
help = parsed_json["HELP"].to_json
|
|
55
|
-
help = Pinnacle::Campaigns::Dlc::Types::
|
|
55
|
+
help = Pinnacle::Campaigns::Dlc::Types::DlcCampaignHelpKeywords.from_json(json_object: help)
|
|
56
56
|
end
|
|
57
57
|
if parsed_json["OPT_IN"].nil?
|
|
58
58
|
opt_in = nil
|
|
59
59
|
else
|
|
60
60
|
opt_in = parsed_json["OPT_IN"].to_json
|
|
61
|
-
opt_in = Pinnacle::Campaigns::Dlc::Types::
|
|
61
|
+
opt_in = Pinnacle::Campaigns::Dlc::Types::DlcCampaignOptInKeywords.from_json(json_object: opt_in)
|
|
62
62
|
end
|
|
63
63
|
if parsed_json["OPT_OUT"].nil?
|
|
64
64
|
opt_out = nil
|
|
65
65
|
else
|
|
66
66
|
opt_out = parsed_json["OPT_OUT"].to_json
|
|
67
|
-
opt_out = Pinnacle::Campaigns::Dlc::Types::
|
|
67
|
+
opt_out = Pinnacle::Campaigns::Dlc::Types::DlcCampaignOptOutKeywords.from_json(json_object: opt_out)
|
|
68
68
|
end
|
|
69
69
|
new(
|
|
70
70
|
help: help,
|
|
@@ -74,7 +74,7 @@ module Pinnacle
|
|
|
74
74
|
)
|
|
75
75
|
end
|
|
76
76
|
|
|
77
|
-
# Serialize an instance of
|
|
77
|
+
# Serialize an instance of DlcCampaignKeywords to a JSON object
|
|
78
78
|
#
|
|
79
79
|
# @return [String]
|
|
80
80
|
def to_json(*_args)
|
|
@@ -88,9 +88,9 @@ module Pinnacle
|
|
|
88
88
|
# @param obj [Object]
|
|
89
89
|
# @return [Void]
|
|
90
90
|
def self.validate_raw(obj:)
|
|
91
|
-
obj.help.nil? || Pinnacle::Campaigns::Dlc::Types::
|
|
92
|
-
obj.opt_in.nil? || Pinnacle::Campaigns::Dlc::Types::
|
|
93
|
-
obj.opt_out.nil? || Pinnacle::Campaigns::Dlc::Types::
|
|
91
|
+
obj.help.nil? || Pinnacle::Campaigns::Dlc::Types::DlcCampaignHelpKeywords.validate_raw(obj: obj.help)
|
|
92
|
+
obj.opt_in.nil? || Pinnacle::Campaigns::Dlc::Types::DlcCampaignOptInKeywords.validate_raw(obj: obj.opt_in)
|
|
93
|
+
obj.opt_out.nil? || Pinnacle::Campaigns::Dlc::Types::DlcCampaignOptOutKeywords.validate_raw(obj: obj.opt_out)
|
|
94
94
|
end
|
|
95
95
|
end
|
|
96
96
|
end
|
|
@@ -8,7 +8,7 @@ module Pinnacle
|
|
|
8
8
|
module Dlc
|
|
9
9
|
module Types
|
|
10
10
|
# Legal documentation links.
|
|
11
|
-
class
|
|
11
|
+
class DlcCampaignLinks
|
|
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::Dlc::Types::
|
|
27
|
+
# @return [Pinnacle::Campaigns::Dlc::Types::DlcCampaignLinks]
|
|
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 DlcCampaignLinks
|
|
38
38
|
#
|
|
39
39
|
# @param json_object [String]
|
|
40
|
-
# @return [Pinnacle::Campaigns::Dlc::Types::
|
|
40
|
+
# @return [Pinnacle::Campaigns::Dlc::Types::DlcCampaignLinks]
|
|
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 DlcCampaignLinks to a JSON object
|
|
54
54
|
#
|
|
55
55
|
# @return [String]
|
|
56
56
|
def to_json(*_args)
|
|
@@ -8,7 +8,7 @@ module Pinnacle
|
|
|
8
8
|
module Dlc
|
|
9
9
|
module Types
|
|
10
10
|
# Opt-in keyword settings.
|
|
11
|
-
class
|
|
11
|
+
class DlcCampaignOptInKeywords
|
|
12
12
|
# @return [String] Response message for opt-in keywords.
|
|
13
13
|
attr_reader :message
|
|
14
14
|
# @return [Array<String>] Keywords that trigger opt-in.
|
|
@@ -24,7 +24,7 @@ module Pinnacle
|
|
|
24
24
|
# @param message [String] Response message for opt-in keywords.
|
|
25
25
|
# @param values [Array<String>] Keywords that trigger opt-in.
|
|
26
26
|
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
|
27
|
-
# @return [Pinnacle::Campaigns::Dlc::Types::
|
|
27
|
+
# @return [Pinnacle::Campaigns::Dlc::Types::DlcCampaignOptInKeywords]
|
|
28
28
|
def initialize(message: OMIT, values: OMIT, additional_properties: nil)
|
|
29
29
|
@message = message if message != OMIT
|
|
30
30
|
@values = values if values != 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 DlcCampaignOptInKeywords
|
|
38
38
|
#
|
|
39
39
|
# @param json_object [String]
|
|
40
|
-
# @return [Pinnacle::Campaigns::Dlc::Types::
|
|
40
|
+
# @return [Pinnacle::Campaigns::Dlc::Types::DlcCampaignOptInKeywords]
|
|
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 DlcCampaignOptInKeywords to a JSON object
|
|
54
54
|
#
|
|
55
55
|
# @return [String]
|
|
56
56
|
def to_json(*_args)
|
|
@@ -8,7 +8,7 @@ module Pinnacle
|
|
|
8
8
|
module Dlc
|
|
9
9
|
module Types
|
|
10
10
|
# Opt-out keyword settings.
|
|
11
|
-
class
|
|
11
|
+
class DlcCampaignOptOutKeywords
|
|
12
12
|
# @return [String] Response message for opt-out keywords.
|
|
13
13
|
attr_reader :message
|
|
14
14
|
# @return [Array<String>] Keywords that trigger opt-out.
|
|
@@ -24,7 +24,7 @@ module Pinnacle
|
|
|
24
24
|
# @param message [String] Response message for opt-out keywords.
|
|
25
25
|
# @param values [Array<String>] Keywords that trigger opt-out.
|
|
26
26
|
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
|
27
|
-
# @return [Pinnacle::Campaigns::Dlc::Types::
|
|
27
|
+
# @return [Pinnacle::Campaigns::Dlc::Types::DlcCampaignOptOutKeywords]
|
|
28
28
|
def initialize(message: OMIT, values: OMIT, additional_properties: nil)
|
|
29
29
|
@message = message if message != OMIT
|
|
30
30
|
@values = values if values != 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 DlcCampaignOptOutKeywords
|
|
38
38
|
#
|
|
39
39
|
# @param json_object [String]
|
|
40
|
-
# @return [Pinnacle::Campaigns::Dlc::Types::
|
|
40
|
+
# @return [Pinnacle::Campaigns::Dlc::Types::DlcCampaignOptOutKeywords]
|
|
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 DlcCampaignOptOutKeywords to a JSON object
|
|
54
54
|
#
|
|
55
55
|
# @return [String]
|
|
56
56
|
def to_json(*_args)
|
|
@@ -8,7 +8,7 @@ module Pinnacle
|
|
|
8
8
|
module Dlc
|
|
9
9
|
module Types
|
|
10
10
|
# Campaign configuration options.
|
|
11
|
-
class
|
|
11
|
+
class DlcCampaignOptions
|
|
12
12
|
# @return [Boolean] Whether the campaign uses affiliate marketing.
|
|
13
13
|
attr_reader :affiliate_marketing
|
|
14
14
|
# @return [Boolean] Whether the campaign is age-gated.
|
|
@@ -36,7 +36,7 @@ module Pinnacle
|
|
|
36
36
|
# @param embedded_phone [Boolean] Whether messages include phone numbers.
|
|
37
37
|
# @param number_pooling [Boolean] Whether the campaign uses number pooling.
|
|
38
38
|
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
|
39
|
-
# @return [Pinnacle::Campaigns::Dlc::Types::
|
|
39
|
+
# @return [Pinnacle::Campaigns::Dlc::Types::DlcCampaignOptions]
|
|
40
40
|
def initialize(affiliate_marketing: OMIT, age_gated: OMIT, direct_lending: OMIT, embedded_link: OMIT,
|
|
41
41
|
embedded_phone: OMIT, number_pooling: OMIT, additional_properties: nil)
|
|
42
42
|
@affiliate_marketing = affiliate_marketing if affiliate_marketing != OMIT
|
|
@@ -58,10 +58,10 @@ module Pinnacle
|
|
|
58
58
|
end
|
|
59
59
|
end
|
|
60
60
|
|
|
61
|
-
# Deserialize a JSON object to an instance of
|
|
61
|
+
# Deserialize a JSON object to an instance of DlcCampaignOptions
|
|
62
62
|
#
|
|
63
63
|
# @param json_object [String]
|
|
64
|
-
# @return [Pinnacle::Campaigns::Dlc::Types::
|
|
64
|
+
# @return [Pinnacle::Campaigns::Dlc::Types::DlcCampaignOptions]
|
|
65
65
|
def self.from_json(json_object:)
|
|
66
66
|
struct = JSON.parse(json_object, object_class: OpenStruct)
|
|
67
67
|
parsed_json = JSON.parse(json_object)
|
|
@@ -82,7 +82,7 @@ module Pinnacle
|
|
|
82
82
|
)
|
|
83
83
|
end
|
|
84
84
|
|
|
85
|
-
# Serialize an instance of
|
|
85
|
+
# Serialize an instance of DlcCampaignOptions to a JSON object
|
|
86
86
|
#
|
|
87
87
|
# @return [String]
|
|
88
88
|
def to_json(*_args)
|
data/lib/rcs/campaigns/dlc/types/{upsert_dlc_campaign_use_case.rb → dlc_campaign_use_case.rb}
RENAMED
|
@@ -10,7 +10,7 @@ module Pinnacle
|
|
|
10
10
|
module Dlc
|
|
11
11
|
module Types
|
|
12
12
|
# Use case for the campaign.
|
|
13
|
-
class
|
|
13
|
+
class DlcCampaignUseCase
|
|
14
14
|
# @return [Array<Pinnacle::Types::SubUseCaseEnum>] Sub-use case categories.
|
|
15
15
|
attr_reader :sub
|
|
16
16
|
# @return [Pinnacle::Types::DlcCampaignUseCaseEnum]
|
|
@@ -26,7 +26,7 @@ module Pinnacle
|
|
|
26
26
|
# @param sub [Array<Pinnacle::Types::SubUseCaseEnum>] Sub-use case categories.
|
|
27
27
|
# @param value [Pinnacle::Types::DlcCampaignUseCaseEnum]
|
|
28
28
|
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
|
29
|
-
# @return [Pinnacle::Campaigns::Dlc::Types::
|
|
29
|
+
# @return [Pinnacle::Campaigns::Dlc::Types::DlcCampaignUseCase]
|
|
30
30
|
def initialize(sub: OMIT, value: OMIT, additional_properties: nil)
|
|
31
31
|
@sub = sub if sub != OMIT
|
|
32
32
|
@value = value if value != 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 DlcCampaignUseCase
|
|
40
40
|
#
|
|
41
41
|
# @param json_object [String]
|
|
42
|
-
# @return [Pinnacle::Campaigns::Dlc::Types::
|
|
42
|
+
# @return [Pinnacle::Campaigns::Dlc::Types::DlcCampaignUseCase]
|
|
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 DlcCampaignUseCase to a JSON object
|
|
56
56
|
#
|
|
57
57
|
# @return [String]
|
|
58
58
|
def to_json(*_args)
|