rcs 2.0.0.pre.rc.2 → 2.0.0.pre.rc.4

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.
Files changed (80) hide show
  1. checksums.yaml +4 -4
  2. data/lib/rcs/brands/client.rb +6 -6
  3. data/lib/rcs/brands/types/{autofill_brand_schema_options.rb → autofill_brand_options.rb} +5 -5
  4. data/lib/rcs/campaigns/dlc/client.rb +12 -12
  5. data/lib/rcs/campaigns/dlc/types/{upsert_dlc_schema_keywords_help.rb → upsert_dlc_campaign_help_keywords.rb} +5 -5
  6. data/lib/rcs/campaigns/dlc/types/{upsert_dlc_schema_keywords.rb → upsert_dlc_campaign_keywords.rb} +20 -20
  7. data/lib/rcs/campaigns/dlc/types/{upsert_dlc_schema_links.rb → upsert_dlc_campaign_links.rb} +5 -5
  8. data/lib/rcs/campaigns/dlc/types/{upsert_dlc_schema_keywords_opt_in.rb → upsert_dlc_campaign_opt_in_keywords.rb} +5 -5
  9. data/lib/rcs/campaigns/dlc/types/{upsert_dlc_schema_keywords_opt_out.rb → upsert_dlc_campaign_opt_out_keywords.rb} +5 -5
  10. data/lib/rcs/campaigns/dlc/types/{upsert_dlc_schema_options.rb → upsert_dlc_campaign_options.rb} +5 -5
  11. data/lib/rcs/campaigns/dlc/types/{upsert_dlc_schema_use_case.rb → upsert_dlc_campaign_use_case.rb} +5 -5
  12. data/lib/rcs/campaigns/rcs/client.rb +39 -29
  13. data/lib/rcs/campaigns/rcs/types/{upsert_rcs_schema_agent_emails_item.rb → rcs_agent_email.rb} +5 -5
  14. data/lib/rcs/campaigns/rcs/types/{upsert_rcs_schema_agent_phones_item.rb → rcs_agent_phone.rb} +5 -5
  15. data/lib/rcs/campaigns/rcs/types/{upsert_rcs_schema_agent_websites_item.rb → rcs_agent_website.rb} +5 -5
  16. data/lib/rcs/campaigns/rcs/types/rcs_autofill_response.rb +14 -2
  17. data/lib/rcs/campaigns/rcs/types/{upsert_rcs_schema_agent.rb → upsert_rcs_agent.rb} +17 -17
  18. data/lib/rcs/campaigns/rcs/types/{upsert_rcs_schema_links.rb → upsert_rcs_links.rb} +5 -5
  19. data/lib/rcs/campaigns/rcs/types/{upsert_rcs_schema_opt_in.rb → upsert_rcs_opt_in.rb} +13 -13
  20. data/lib/rcs/campaigns/rcs/types/{upsert_rcs_schema_opt_out.rb → upsert_rcs_opt_out.rb} +5 -5
  21. data/lib/rcs/campaigns/rcs/types/{upsert_rcs_schema_use_case.rb → upsert_rcs_use_case.rb} +5 -5
  22. data/lib/rcs/campaigns/toll_free/client.rb +4 -4
  23. data/lib/rcs/campaigns/toll_free/types/toll_free_autofill_response.rb +10 -10
  24. data/lib/rcs/campaigns/toll_free/types/upsert_toll_free_schema_opt_in.rb +8 -8
  25. data/lib/rcs/conversations/client.rb +2 -2
  26. data/lib/rcs/messages/client.rb +24 -10
  27. data/lib/rcs/messages/mms/client.rb +118 -0
  28. data/lib/rcs/messages/{send/types/send_mms_response.rb → mms/types/mms_send_response.rb} +4 -4
  29. data/lib/rcs/messages/{send/types/send_mms_schema_options.rb → mms/types/send_mms_options.rb} +6 -6
  30. data/lib/rcs/messages/rcs/client.rb +68 -0
  31. data/lib/rcs/messages/{send/types/send_rcs_response.rb → rcs/types/rcs_send_response.rb} +4 -4
  32. data/lib/rcs/messages/sms/client.rb +198 -0
  33. data/lib/rcs/messages/{send/types/send_sms_schema_options.rb → sms/types/send_sms_options.rb} +6 -6
  34. data/lib/rcs/messages/{send/types/send_sms_response.rb → sms/types/sms_send_response.rb} +4 -4
  35. data/lib/rcs/messages/types/{message_reaction_schema_options.rb → react_message_options.rb} +5 -5
  36. data/lib/rcs/phone_numbers/client.rb +18 -18
  37. data/lib/rcs/phone_numbers/types/{phone_details_schema_options_enhanced_contact_info.rb → enhanced_contact_info.rb} +5 -7
  38. data/lib/rcs/phone_numbers/types/{phone_details_schema_options.rb → retrieve_phone_number_details_options.rb} +10 -10
  39. data/lib/rcs/phone_numbers/types/{search_schema_number.rb → search_phone_number_by_digits.rb} +5 -5
  40. data/lib/rcs/phone_numbers/types/{search_schema_location.rb → search_phone_number_by_location.rb} +5 -5
  41. data/lib/rcs/phone_numbers/types/{search_schema_options.rb → search_phone_number_options.rb} +5 -5
  42. data/lib/rcs/phone_numbers/webhook/client.rb +2 -2
  43. data/lib/rcs/tools/file/client.rb +3 -3
  44. data/lib/rcs/tools/file/types/{file_upload_schema_options_download.rb → download_options.rb} +5 -5
  45. data/lib/rcs/tools/file/types/{file_upload_schema_options.rb → upload_file_options.rb} +10 -10
  46. data/lib/rcs/types/{attach_webhook_schema_webhook_id.rb → attach_webhook_by_id_params.rb} +5 -5
  47. data/lib/rcs/types/attach_webhook_params.rb +8 -8
  48. data/lib/rcs/types/{get_conversation_request_id.rb → conversation_by_id_params.rb} +5 -5
  49. data/lib/rcs/types/{get_conversation_request_recipient.rb → conversation_by_participants_params.rb} +5 -5
  50. data/lib/rcs/types/{attach_webhook_schema_name.rb → create_and_attach_webhook_by_url_params.rb} +5 -5
  51. data/lib/rcs/types/extended_rcs_campaign.rb +13 -1
  52. data/lib/rcs/types/get_conversation_params.rb +8 -8
  53. data/lib/rcs/types/link_click_event.rb +8 -8
  54. data/lib/rcs/types/message.rb +8 -8
  55. data/lib/rcs/types/rcs.rb +12 -12
  56. data/lib/rcs/types/rcs_campaign.rb +14 -2
  57. data/lib/rcs/types/rcs_campaign_schema_extra_opt_in.rb +8 -8
  58. data/lib/rcs/types/rcs_campaign_schema_opt_in.rb +8 -8
  59. data/lib/rcs/types/rcs_cards.rb +4 -4
  60. data/lib/rcs/types/rcs_cards_cards_item.rb +4 -4
  61. data/lib/rcs/types/rcs_cards_content.rb +4 -4
  62. data/lib/rcs/types/rcs_cards_content_cards_item.rb +4 -4
  63. data/lib/rcs/types/rcs_media_content.rb +4 -4
  64. data/lib/rcs/types/rcs_text_content.rb +4 -4
  65. data/lib/rcs/types/{rcs_button_content.rb → rich_button.rb} +10 -10
  66. data/lib/rcs/types/{rcs_card.rb → rich_cards_message.rb} +9 -9
  67. data/lib/rcs/types/{rcs_media.rb → rich_media_message.rb} +9 -9
  68. data/lib/rcs/types/{rcs_text.rb → rich_text_message.rb} +9 -9
  69. data/lib/rcs/types/toll_free_campaign.rb +10 -10
  70. data/lib/rcs/types/toll_free_campaign_with_extended_brand_and_status.rb +10 -10
  71. data/lib/rcs/types/{nullable_contact.rb → upsert_contact.rb} +5 -5
  72. data/lib/rcs/types/{toll_free_campaign_schema_opt_in.rb → upsert_toll_free_campaign_opt_in.rb} +13 -13
  73. data/lib/rcs/types/{toll_free_campaign_schema_use_case.rb → upsert_toll_free_campaign_use_case.rb} +5 -5
  74. data/lib/rcs.rb +0 -7
  75. data/lib/requests.rb +2 -2
  76. data/lib/types_export.rb +40 -40
  77. metadata +43 -45
  78. data/lib/rcs/message/client.rb +0 -30
  79. data/lib/rcs/message/sms/client.rb +0 -96
  80. data/lib/rcs/messages/send/client.rb +0 -318
@@ -25,7 +25,7 @@ module Pinnacle
25
25
  # is url encoded (i.e. replace the leading + with %2B). <br>
26
26
  # Must be a phone number that you own and have already [purchased](./buy) through
27
27
  # the API.
28
- # @param request [Pinnacle::Types::AttachWebhookSchemaWebhookId, Pinnacle::Types::AttachWebhookSchemaName]
28
+ # @param request [Pinnacle::Types::AttachWebhookByIdParams, Pinnacle::Types::CreateAndAttachWebhookByUrlParams]
29
29
  # @param request_options [Pinnacle::RequestOptions]
30
30
  # @return [Pinnacle::Types::ConfiguredWebhook]
31
31
  # @example
@@ -113,7 +113,7 @@ module Pinnacle
113
113
  # is url encoded (i.e. replace the leading + with %2B). <br>
114
114
  # Must be a phone number that you own and have already [purchased](./buy) through
115
115
  # the API.
116
- # @param request [Pinnacle::Types::AttachWebhookSchemaWebhookId, Pinnacle::Types::AttachWebhookSchemaName]
116
+ # @param request [Pinnacle::Types::AttachWebhookByIdParams, Pinnacle::Types::CreateAndAttachWebhookByUrlParams]
117
117
  # @param request_options [Pinnacle::RequestOptions]
118
118
  # @return [Pinnacle::Types::ConfiguredWebhook]
119
119
  # @example
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  require_relative "../../../requests"
4
- require_relative "types/file_upload_schema_options"
4
+ require_relative "types/upload_file_options"
5
5
  require_relative "../../types/upload_results"
6
6
  require "async"
7
7
 
@@ -28,7 +28,7 @@ module Pinnacle
28
28
  # - Documents: pdf, csv, rtf, calendar, vcard
29
29
  # @param size [Integer] Size of your file in bytes. Should be less than 100 MB.
30
30
  # @param name [String] Name of your file.
31
- # @param options [Hash] Additional configurations for your file.Request of type Pinnacle::Tools::File::Types::FileUploadSchemaOptions, as a Hash
31
+ # @param options [Hash] Additional configurations for your file.Request of type Pinnacle::Tools::File::Types::UploadFileOptions, as a Hash
32
32
  # * :download (Hash)
33
33
  # * :expires_at (String)
34
34
  # @param request_options [Pinnacle::RequestOptions]
@@ -91,7 +91,7 @@ module Pinnacle
91
91
  # - Documents: pdf, csv, rtf, calendar, vcard
92
92
  # @param size [Integer] Size of your file in bytes. Should be less than 100 MB.
93
93
  # @param name [String] Name of your file.
94
- # @param options [Hash] Additional configurations for your file.Request of type Pinnacle::Tools::File::Types::FileUploadSchemaOptions, as a Hash
94
+ # @param options [Hash] Additional configurations for your file.Request of type Pinnacle::Tools::File::Types::UploadFileOptions, as a Hash
95
95
  # * :download (Hash)
96
96
  # * :expires_at (String)
97
97
  # @param request_options [Pinnacle::RequestOptions]
@@ -8,7 +8,7 @@ module Pinnacle
8
8
  module File
9
9
  module Types
10
10
  # Configure download settings for your uploaded file.
11
- class FileUploadSchemaOptionsDownload
11
+ class DownloadOptions
12
12
  # @return [String] Set an expiration date for file download access.<br>
13
13
  # If this field is not provided, then a short permalink is generated instead.
14
14
  attr_reader :expires_at
@@ -23,7 +23,7 @@ module Pinnacle
23
23
  # @param expires_at [String] Set an expiration date for file download access.<br>
24
24
  # If this field is not provided, then a short permalink is generated instead.
25
25
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
26
- # @return [Pinnacle::Tools::File::Types::FileUploadSchemaOptionsDownload]
26
+ # @return [Pinnacle::Tools::File::Types::DownloadOptions]
27
27
  def initialize(expires_at: OMIT, additional_properties: nil)
28
28
  @expires_at = expires_at if expires_at != OMIT
29
29
  @additional_properties = additional_properties
@@ -32,10 +32,10 @@ module Pinnacle
32
32
  end
33
33
  end
34
34
 
35
- # Deserialize a JSON object to an instance of FileUploadSchemaOptionsDownload
35
+ # Deserialize a JSON object to an instance of DownloadOptions
36
36
  #
37
37
  # @param json_object [String]
38
- # @return [Pinnacle::Tools::File::Types::FileUploadSchemaOptionsDownload]
38
+ # @return [Pinnacle::Tools::File::Types::DownloadOptions]
39
39
  def self.from_json(json_object:)
40
40
  struct = JSON.parse(json_object, object_class: OpenStruct)
41
41
  parsed_json = JSON.parse(json_object)
@@ -43,7 +43,7 @@ module Pinnacle
43
43
  new(expires_at: expires_at, additional_properties: struct)
44
44
  end
45
45
 
46
- # Serialize an instance of FileUploadSchemaOptionsDownload to a JSON object
46
+ # Serialize an instance of DownloadOptions to a JSON object
47
47
  #
48
48
  # @return [String]
49
49
  def to_json(*_args)
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require_relative "file_upload_schema_options_download"
3
+ require_relative "download_options"
4
4
  require "ostruct"
5
5
  require "json"
6
6
 
@@ -9,8 +9,8 @@ module Pinnacle
9
9
  module File
10
10
  module Types
11
11
  # Additional configurations for your file.
12
- class FileUploadSchemaOptions
13
- # @return [Pinnacle::Tools::File::Types::FileUploadSchemaOptionsDownload] Configure download settings for your uploaded file.
12
+ class UploadFileOptions
13
+ # @return [Pinnacle::Tools::File::Types::DownloadOptions] Configure download settings for your uploaded file.
14
14
  attr_reader :download
15
15
  # @return [OpenStruct] Additional properties unmapped to the current class definition
16
16
  attr_reader :additional_properties
@@ -20,9 +20,9 @@ module Pinnacle
20
20
 
21
21
  OMIT = Object.new
22
22
 
23
- # @param download [Pinnacle::Tools::File::Types::FileUploadSchemaOptionsDownload] Configure download settings for your uploaded file.
23
+ # @param download [Pinnacle::Tools::File::Types::DownloadOptions] Configure download settings for your uploaded file.
24
24
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
25
- # @return [Pinnacle::Tools::File::Types::FileUploadSchemaOptions]
25
+ # @return [Pinnacle::Tools::File::Types::UploadFileOptions]
26
26
  def initialize(download: OMIT, additional_properties: nil)
27
27
  @download = download if download != OMIT
28
28
  @additional_properties = additional_properties
@@ -31,10 +31,10 @@ module Pinnacle
31
31
  end
32
32
  end
33
33
 
34
- # Deserialize a JSON object to an instance of FileUploadSchemaOptions
34
+ # Deserialize a JSON object to an instance of UploadFileOptions
35
35
  #
36
36
  # @param json_object [String]
37
- # @return [Pinnacle::Tools::File::Types::FileUploadSchemaOptions]
37
+ # @return [Pinnacle::Tools::File::Types::UploadFileOptions]
38
38
  def self.from_json(json_object:)
39
39
  struct = JSON.parse(json_object, object_class: OpenStruct)
40
40
  parsed_json = JSON.parse(json_object)
@@ -42,12 +42,12 @@ module Pinnacle
42
42
  download = nil
43
43
  else
44
44
  download = parsed_json["download"].to_json
45
- download = Pinnacle::Tools::File::Types::FileUploadSchemaOptionsDownload.from_json(json_object: download)
45
+ download = Pinnacle::Tools::File::Types::DownloadOptions.from_json(json_object: download)
46
46
  end
47
47
  new(download: download, additional_properties: struct)
48
48
  end
49
49
 
50
- # Serialize an instance of FileUploadSchemaOptions to a JSON object
50
+ # Serialize an instance of UploadFileOptions to a JSON object
51
51
  #
52
52
  # @return [String]
53
53
  def to_json(*_args)
@@ -61,7 +61,7 @@ module Pinnacle
61
61
  # @param obj [Object]
62
62
  # @return [Void]
63
63
  def self.validate_raw(obj:)
64
- obj.download.nil? || Pinnacle::Tools::File::Types::FileUploadSchemaOptionsDownload.validate_raw(obj: obj.download)
64
+ obj.download.nil? || Pinnacle::Tools::File::Types::DownloadOptions.validate_raw(obj: obj.download)
65
65
  end
66
66
  end
67
67
  end
@@ -7,7 +7,7 @@ require "json"
7
7
  module Pinnacle
8
8
  module Types
9
9
  # Attach a webhook you’ve already created in your account to this phone number.
10
- class AttachWebhookSchemaWebhookId
10
+ class AttachWebhookByIdParams
11
11
  # @return [Integer] The unique ID of the webhook you want to attach.<br>
12
12
  # Make sure this webhook is active and able to receive event notifications.
13
13
  attr_reader :webhook_id
@@ -29,7 +29,7 @@ module Pinnacle
29
29
  # Set to null if you want to listen to all event types for this phone number. <br>
30
30
  # Defaults to null.
31
31
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
32
- # @return [Pinnacle::Types::AttachWebhookSchemaWebhookId]
32
+ # @return [Pinnacle::Types::AttachWebhookByIdParams]
33
33
  def initialize(webhook_id:, event: OMIT, additional_properties: nil)
34
34
  @webhook_id = webhook_id
35
35
  @event = event if event != OMIT
@@ -39,10 +39,10 @@ module Pinnacle
39
39
  end
40
40
  end
41
41
 
42
- # Deserialize a JSON object to an instance of AttachWebhookSchemaWebhookId
42
+ # Deserialize a JSON object to an instance of AttachWebhookByIdParams
43
43
  #
44
44
  # @param json_object [String]
45
- # @return [Pinnacle::Types::AttachWebhookSchemaWebhookId]
45
+ # @return [Pinnacle::Types::AttachWebhookByIdParams]
46
46
  def self.from_json(json_object:)
47
47
  struct = JSON.parse(json_object, object_class: OpenStruct)
48
48
  parsed_json = JSON.parse(json_object)
@@ -55,7 +55,7 @@ module Pinnacle
55
55
  )
56
56
  end
57
57
 
58
- # Serialize an instance of AttachWebhookSchemaWebhookId to a JSON object
58
+ # Serialize an instance of AttachWebhookByIdParams to a JSON object
59
59
  #
60
60
  # @return [String]
61
61
  def to_json(*_args)
@@ -1,8 +1,8 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  require "json"
4
- require_relative "attach_webhook_schema_webhook_id"
5
- require_relative "attach_webhook_schema_name"
4
+ require_relative "attach_webhook_by_id_params"
5
+ require_relative "create_and_attach_webhook_by_url_params"
6
6
 
7
7
  module Pinnacle
8
8
  module Types
@@ -18,16 +18,16 @@ module Pinnacle
18
18
  def self.from_json(json_object:)
19
19
  struct = JSON.parse(json_object, object_class: OpenStruct)
20
20
  begin
21
- Pinnacle::Types::AttachWebhookSchemaWebhookId.validate_raw(obj: struct)
22
- return Pinnacle::Types::AttachWebhookSchemaWebhookId.from_json(json_object: struct) unless struct.nil?
21
+ Pinnacle::Types::AttachWebhookByIdParams.validate_raw(obj: struct)
22
+ return Pinnacle::Types::AttachWebhookByIdParams.from_json(json_object: struct) unless struct.nil?
23
23
 
24
24
  return nil
25
25
  rescue StandardError
26
26
  # noop
27
27
  end
28
28
  begin
29
- Pinnacle::Types::AttachWebhookSchemaName.validate_raw(obj: struct)
30
- return Pinnacle::Types::AttachWebhookSchemaName.from_json(json_object: struct) unless struct.nil?
29
+ Pinnacle::Types::CreateAndAttachWebhookByUrlParams.validate_raw(obj: struct)
30
+ return Pinnacle::Types::CreateAndAttachWebhookByUrlParams.from_json(json_object: struct) unless struct.nil?
31
31
 
32
32
  return nil
33
33
  rescue StandardError
@@ -44,12 +44,12 @@ module Pinnacle
44
44
  # @return [Void]
45
45
  def self.validate_raw(obj:)
46
46
  begin
47
- return Pinnacle::Types::AttachWebhookSchemaWebhookId.validate_raw(obj: obj)
47
+ return Pinnacle::Types::AttachWebhookByIdParams.validate_raw(obj: obj)
48
48
  rescue StandardError
49
49
  # noop
50
50
  end
51
51
  begin
52
- return Pinnacle::Types::AttachWebhookSchemaName.validate_raw(obj: obj)
52
+ return Pinnacle::Types::CreateAndAttachWebhookByUrlParams.validate_raw(obj: obj)
53
53
  rescue StandardError
54
54
  # noop
55
55
  end
@@ -6,7 +6,7 @@ require "json"
6
6
  module Pinnacle
7
7
  module Types
8
8
  # Retrieve conversation information by ID.
9
- class GetConversationRequestId
9
+ class ConversationByIdParams
10
10
  # @return [Integer] Unique identifier of the conversation you want to retrieve.
11
11
  attr_reader :id
12
12
  # @return [OpenStruct] Additional properties unmapped to the current class definition
@@ -19,17 +19,17 @@ module Pinnacle
19
19
 
20
20
  # @param id [Integer] Unique identifier of the conversation you want to retrieve.
21
21
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
22
- # @return [Pinnacle::Types::GetConversationRequestId]
22
+ # @return [Pinnacle::Types::ConversationByIdParams]
23
23
  def initialize(id:, additional_properties: nil)
24
24
  @id = id
25
25
  @additional_properties = additional_properties
26
26
  @_field_set = { "id": id }
27
27
  end
28
28
 
29
- # Deserialize a JSON object to an instance of GetConversationRequestId
29
+ # Deserialize a JSON object to an instance of ConversationByIdParams
30
30
  #
31
31
  # @param json_object [String]
32
- # @return [Pinnacle::Types::GetConversationRequestId]
32
+ # @return [Pinnacle::Types::ConversationByIdParams]
33
33
  def self.from_json(json_object:)
34
34
  struct = JSON.parse(json_object, object_class: OpenStruct)
35
35
  parsed_json = JSON.parse(json_object)
@@ -37,7 +37,7 @@ module Pinnacle
37
37
  new(id: id, additional_properties: struct)
38
38
  end
39
39
 
40
- # Serialize an instance of GetConversationRequestId to a JSON object
40
+ # Serialize an instance of ConversationByIdParams to a JSON object
41
41
  #
42
42
  # @return [String]
43
43
  def to_json(*_args)
@@ -6,7 +6,7 @@ require "json"
6
6
  module Pinnacle
7
7
  module Types
8
8
  # Retrieve conversation information by sender and recipient.
9
- class GetConversationRequestRecipient
9
+ class ConversationByParticipantsParams
10
10
  # @return [String] The recipient's phone number in E.164 format
11
11
  attr_reader :recipient
12
12
  # @return [String] The sender identifier. Can be either:
@@ -26,7 +26,7 @@ module Pinnacle
26
26
  # - A phone number in E.164 format
27
27
  # - An RCS agent ID prefixed with 'agent_'
28
28
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
29
- # @return [Pinnacle::Types::GetConversationRequestRecipient]
29
+ # @return [Pinnacle::Types::ConversationByParticipantsParams]
30
30
  def initialize(recipient:, sender:, additional_properties: nil)
31
31
  @recipient = recipient
32
32
  @sender = sender
@@ -34,10 +34,10 @@ module Pinnacle
34
34
  @_field_set = { "recipient": recipient, "sender": sender }
35
35
  end
36
36
 
37
- # Deserialize a JSON object to an instance of GetConversationRequestRecipient
37
+ # Deserialize a JSON object to an instance of ConversationByParticipantsParams
38
38
  #
39
39
  # @param json_object [String]
40
- # @return [Pinnacle::Types::GetConversationRequestRecipient]
40
+ # @return [Pinnacle::Types::ConversationByParticipantsParams]
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 GetConversationRequestRecipient to a JSON object
53
+ # Serialize an instance of ConversationByParticipantsParams to a JSON object
54
54
  #
55
55
  # @return [String]
56
56
  def to_json(*_args)
@@ -7,7 +7,7 @@ require "json"
7
7
  module Pinnacle
8
8
  module Types
9
9
  # Create a new webhook and immediately attach it to your phone number.
10
- class AttachWebhookSchemaName
10
+ class CreateAndAttachWebhookByUrlParams
11
11
  # @return [String] Name of your new webhook.
12
12
  attr_reader :name
13
13
  # @return [String] HTTPS endpoint where your webhook events will be sent as HTTP POST requests.
@@ -36,7 +36,7 @@ module Pinnacle
36
36
  # Set to null if you want to listen to all event types for this phone number. <br>
37
37
  # Defaults to null.
38
38
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
39
- # @return [Pinnacle::Types::AttachWebhookSchemaName]
39
+ # @return [Pinnacle::Types::CreateAndAttachWebhookByUrlParams]
40
40
  def initialize(name:, url:, event: OMIT, additional_properties: nil)
41
41
  @name = name
42
42
  @url = url
@@ -47,10 +47,10 @@ module Pinnacle
47
47
  end
48
48
  end
49
49
 
50
- # Deserialize a JSON object to an instance of AttachWebhookSchemaName
50
+ # Deserialize a JSON object to an instance of CreateAndAttachWebhookByUrlParams
51
51
  #
52
52
  # @param json_object [String]
53
- # @return [Pinnacle::Types::AttachWebhookSchemaName]
53
+ # @return [Pinnacle::Types::CreateAndAttachWebhookByUrlParams]
54
54
  def self.from_json(json_object:)
55
55
  struct = JSON.parse(json_object, object_class: OpenStruct)
56
56
  parsed_json = JSON.parse(json_object)
@@ -65,7 +65,7 @@ module Pinnacle
65
65
  )
66
66
  end
67
67
 
68
- # Serialize an instance of AttachWebhookSchemaName to a JSON object
68
+ # Serialize an instance of CreateAndAttachWebhookByUrlParams to a JSON object
69
69
  #
70
70
  # @return [String]
71
71
  def to_json(*_args)
@@ -18,6 +18,10 @@ module Pinnacle
18
18
  attr_reader :agent_id
19
19
  # @return [Pinnacle::Types::ExtendedBrand] Brand associated with this campaign.
20
20
  attr_reader :brand
21
+ # @return [String] Link to document verifying the brand's name. This may be the certificate of
22
+ # incorporation, business license, or other relevant document. You can typically
23
+ # find this on the Secretary of State website.
24
+ attr_reader :brand_verification_url
21
25
  # @return [Boolean] Indicates whether the brand has provided an attestation.
22
26
  attr_reader :brand_attestation
23
27
  # @return [Integer] Unique identifier for the campaign.
@@ -43,6 +47,9 @@ module Pinnacle
43
47
  # @param agent [Pinnacle::Types::RcsCampaignSchemaExtraAgent] Agent configured to the campaign.
44
48
  # @param agent_id [String] Agent's unique identifier.
45
49
  # @param brand [Pinnacle::Types::ExtendedBrand] Brand associated with this campaign.
50
+ # @param brand_verification_url [String] Link to document verifying the brand's name. This may be the certificate of
51
+ # incorporation, business license, or other relevant document. You can typically
52
+ # find this on the Secretary of State website.
46
53
  # @param brand_attestation [Boolean] Indicates whether the brand has provided an attestation.
47
54
  # @param campaign_id [Integer] Unique identifier for the campaign.
48
55
  # @param expected_agent_responses [Array<String>] List of what the agent might say to users.
@@ -52,11 +59,12 @@ module Pinnacle
52
59
  # @param use_case [Pinnacle::Types::RcsCampaignSchemaExtraUseCase] Use case classification for the campaign.
53
60
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
54
61
  # @return [Pinnacle::Types::ExtendedRcsCampaign]
55
- def initialize(agent:, agent_id:, brand:, brand_attestation:, campaign_id:, links:, opt_in:, opt_out:, use_case:,
62
+ def initialize(agent:, agent_id:, brand:, brand_attestation:, campaign_id:, links:, opt_in:, opt_out:, use_case:, brand_verification_url: OMIT,
56
63
  expected_agent_responses: OMIT, additional_properties: nil)
57
64
  @agent = agent
58
65
  @agent_id = agent_id
59
66
  @brand = brand
67
+ @brand_verification_url = brand_verification_url if brand_verification_url != OMIT
60
68
  @brand_attestation = brand_attestation
61
69
  @campaign_id = campaign_id
62
70
  @expected_agent_responses = expected_agent_responses if expected_agent_responses != OMIT
@@ -69,6 +77,7 @@ module Pinnacle
69
77
  "agent": agent,
70
78
  "agentId": agent_id,
71
79
  "brand": brand,
80
+ "brandVerificationUrl": brand_verification_url,
72
81
  "brandAttestation": brand_attestation,
73
82
  "campaignId": campaign_id,
74
83
  "expectedAgentResponses": expected_agent_responses,
@@ -101,6 +110,7 @@ module Pinnacle
101
110
  brand = parsed_json["brand"].to_json
102
111
  brand = Pinnacle::Types::ExtendedBrand.from_json(json_object: brand)
103
112
  end
113
+ brand_verification_url = parsed_json["brandVerificationUrl"]
104
114
  brand_attestation = parsed_json["brandAttestation"]
105
115
  campaign_id = parsed_json["campaignId"]
106
116
  expected_agent_responses = parsed_json["expectedAgentResponses"]
@@ -132,6 +142,7 @@ module Pinnacle
132
142
  agent: agent,
133
143
  agent_id: agent_id,
134
144
  brand: brand,
145
+ brand_verification_url: brand_verification_url,
135
146
  brand_attestation: brand_attestation,
136
147
  campaign_id: campaign_id,
137
148
  expected_agent_responses: expected_agent_responses,
@@ -160,6 +171,7 @@ module Pinnacle
160
171
  Pinnacle::Types::RcsCampaignSchemaExtraAgent.validate_raw(obj: obj.agent)
161
172
  obj.agent_id.is_a?(String) != false || raise("Passed value for field obj.agent_id is not the expected type, validation failed.")
162
173
  Pinnacle::Types::ExtendedBrand.validate_raw(obj: obj.brand)
174
+ obj.brand_verification_url&.is_a?(String) != false || raise("Passed value for field obj.brand_verification_url is not the expected type, validation failed.")
163
175
  obj.brand_attestation.is_a?(Boolean) != false || raise("Passed value for field obj.brand_attestation is not the expected type, validation failed.")
164
176
  obj.campaign_id.is_a?(Integer) != false || raise("Passed value for field obj.campaign_id is not the expected type, validation failed.")
165
177
  obj.expected_agent_responses&.is_a?(Array) != false || raise("Passed value for field obj.expected_agent_responses is not the expected type, validation failed.")
@@ -1,8 +1,8 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  require "json"
4
- require_relative "get_conversation_request_id"
5
- require_relative "get_conversation_request_recipient"
4
+ require_relative "conversation_by_id_params"
5
+ require_relative "conversation_by_participants_params"
6
6
 
7
7
  module Pinnacle
8
8
  module Types
@@ -15,16 +15,16 @@ module Pinnacle
15
15
  def self.from_json(json_object:)
16
16
  struct = JSON.parse(json_object, object_class: OpenStruct)
17
17
  begin
18
- Pinnacle::Types::GetConversationRequestId.validate_raw(obj: struct)
19
- return Pinnacle::Types::GetConversationRequestId.from_json(json_object: struct) unless struct.nil?
18
+ Pinnacle::Types::ConversationByIdParams.validate_raw(obj: struct)
19
+ return Pinnacle::Types::ConversationByIdParams.from_json(json_object: struct) unless struct.nil?
20
20
 
21
21
  return nil
22
22
  rescue StandardError
23
23
  # noop
24
24
  end
25
25
  begin
26
- Pinnacle::Types::GetConversationRequestRecipient.validate_raw(obj: struct)
27
- return Pinnacle::Types::GetConversationRequestRecipient.from_json(json_object: struct) unless struct.nil?
26
+ Pinnacle::Types::ConversationByParticipantsParams.validate_raw(obj: struct)
27
+ return Pinnacle::Types::ConversationByParticipantsParams.from_json(json_object: struct) unless struct.nil?
28
28
 
29
29
  return nil
30
30
  rescue StandardError
@@ -41,12 +41,12 @@ module Pinnacle
41
41
  # @return [Void]
42
42
  def self.validate_raw(obj:)
43
43
  begin
44
- return Pinnacle::Types::GetConversationRequestId.validate_raw(obj: obj)
44
+ return Pinnacle::Types::ConversationByIdParams.validate_raw(obj: obj)
45
45
  rescue StandardError
46
46
  # noop
47
47
  end
48
48
  begin
49
- return Pinnacle::Types::GetConversationRequestRecipient.validate_raw(obj: obj)
49
+ return Pinnacle::Types::ConversationByParticipantsParams.validate_raw(obj: obj)
50
50
  rescue StandardError
51
51
  # noop
52
52
  end
@@ -59,7 +59,7 @@ module Pinnacle
59
59
  # @return [Hash{String => Object}] Additional metadata as JSON object.
60
60
  attr_reader :metadata
61
61
  # @return [String] HTTP method used.
62
- attr_reader :method
62
+ attr_reader :method_
63
63
  # @return [Integer] Metro area code.
64
64
  attr_reader :metro_code
65
65
  # @return [Float] Network downlink speed estimate in Mbps.
@@ -142,7 +142,7 @@ module Pinnacle
142
142
  # @param link_id [Integer] ID of your shortened URL.
143
143
  # @param longitude [Float] Geographic longitude.
144
144
  # @param metadata [Hash{String => Object}] Additional metadata as JSON object.
145
- # @param method [String] HTTP method used.
145
+ # @param method_ [String] HTTP method used.
146
146
  # @param metro_code [Integer] Metro area code.
147
147
  # @param network_downlink [Float] Network downlink speed estimate in Mbps.
148
148
  # @param network_rtt [Integer] Network round-trip time in milliseconds.
@@ -170,7 +170,7 @@ module Pinnacle
170
170
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
171
171
  # @return [Pinnacle::Types::LinkClickEvent]
172
172
  def initialize(created_at:, id:, link_id:, accept_language: OMIT, accuracy_radius_km: OMIT, asn: OMIT, blocked_reason: OMIT,
173
- ch_ua_brand: OMIT, ch_ua_mobile: OMIT, ch_ua_platform: OMIT, city: OMIT, color_depth: OMIT, connection_type: OMIT, country: OMIT, error_details: OMIT, fbclid: OMIT, final_url: OMIT, fingerprint_id: OMIT, gclid: OMIT, ip_address: OMIT, ip_chain: OMIT, is_bot: OMIT, latency_ms: OMIT, latitude: OMIT, longitude: OMIT, metadata: OMIT, method: OMIT, metro_code: OMIT, network_downlink: OMIT, network_rtt: OMIT, performance_ttfb_ms: OMIT, postal_code: OMIT, redirect_hops: OMIT, referrer: OMIT, referrer_domain: OMIT, region: OMIT, resolved_at: OMIT, screen_res: OMIT, status_code: OMIT, timezone_offset_min: OMIT, tor_exit_node: OMIT, ua_browser: OMIT, ua_device: OMIT, ua_os: OMIT, ua_version: OMIT, user_agent: OMIT, utm_campaign: OMIT, utm_content: OMIT, utm_medium: OMIT, utm_source: OMIT, utm_term: OMIT, additional_properties: nil)
173
+ ch_ua_brand: OMIT, ch_ua_mobile: OMIT, ch_ua_platform: OMIT, city: OMIT, color_depth: OMIT, connection_type: OMIT, country: OMIT, error_details: OMIT, fbclid: OMIT, final_url: OMIT, fingerprint_id: OMIT, gclid: OMIT, ip_address: OMIT, ip_chain: OMIT, is_bot: OMIT, latency_ms: OMIT, latitude: OMIT, longitude: OMIT, metadata: OMIT, method_: OMIT, metro_code: OMIT, network_downlink: OMIT, network_rtt: OMIT, performance_ttfb_ms: OMIT, postal_code: OMIT, redirect_hops: OMIT, referrer: OMIT, referrer_domain: OMIT, region: OMIT, resolved_at: OMIT, screen_res: OMIT, status_code: OMIT, timezone_offset_min: OMIT, tor_exit_node: OMIT, ua_browser: OMIT, ua_device: OMIT, ua_os: OMIT, ua_version: OMIT, user_agent: OMIT, utm_campaign: OMIT, utm_content: OMIT, utm_medium: OMIT, utm_source: OMIT, utm_term: OMIT, additional_properties: nil)
174
174
  @accept_language = accept_language if accept_language != OMIT
175
175
  @accuracy_radius_km = accuracy_radius_km if accuracy_radius_km != OMIT
176
176
  @asn = asn if asn != OMIT
@@ -197,7 +197,7 @@ module Pinnacle
197
197
  @link_id = link_id
198
198
  @longitude = longitude if longitude != OMIT
199
199
  @metadata = metadata if metadata != OMIT
200
- @method = method if method != OMIT
200
+ @method_ = method_ if method_ != OMIT
201
201
  @metro_code = metro_code if metro_code != OMIT
202
202
  @network_downlink = network_downlink if network_downlink != OMIT
203
203
  @network_rtt = network_rtt if network_rtt != OMIT
@@ -250,7 +250,7 @@ module Pinnacle
250
250
  "link_id": link_id,
251
251
  "longitude": longitude,
252
252
  "metadata": metadata,
253
- "method": method,
253
+ "method": method_,
254
254
  "metro_code": metro_code,
255
255
  "network_downlink": network_downlink,
256
256
  "network_rtt": network_rtt,
@@ -313,7 +313,7 @@ module Pinnacle
313
313
  link_id = parsed_json["link_id"]
314
314
  longitude = parsed_json["longitude"]
315
315
  metadata = parsed_json["metadata"]
316
- method = parsed_json["method"]
316
+ method_ = parsed_json["method"]
317
317
  metro_code = parsed_json["metro_code"]
318
318
  network_downlink = parsed_json["network_downlink"]
319
319
  network_rtt = parsed_json["network_rtt"]
@@ -365,7 +365,7 @@ module Pinnacle
365
365
  link_id: link_id,
366
366
  longitude: longitude,
367
367
  metadata: metadata,
368
- method: method,
368
+ method_: method_,
369
369
  metro_code: metro_code,
370
370
  network_downlink: network_downlink,
371
371
  network_rtt: network_rtt,
@@ -434,7 +434,7 @@ module Pinnacle
434
434
  obj.link_id.is_a?(Integer) != false || raise("Passed value for field obj.link_id is not the expected type, validation failed.")
435
435
  obj.longitude&.is_a?(Float) != false || raise("Passed value for field obj.longitude is not the expected type, validation failed.")
436
436
  obj.metadata&.is_a?(Hash) != false || raise("Passed value for field obj.metadata is not the expected type, validation failed.")
437
- obj.method&.is_a?(String) != false || raise("Passed value for field obj.method is not the expected type, validation failed.")
437
+ obj.method_&.is_a?(String) != false || raise("Passed value for field obj.method_ is not the expected type, validation failed.")
438
438
  obj.metro_code&.is_a?(Integer) != false || raise("Passed value for field obj.metro_code is not the expected type, validation failed.")
439
439
  obj.network_downlink&.is_a?(Float) != false || raise("Passed value for field obj.network_downlink is not the expected type, validation failed.")
440
440
  obj.network_rtt&.is_a?(Integer) != false || raise("Passed value for field obj.network_rtt is not the expected type, validation failed.")
@@ -26,7 +26,7 @@ module Pinnacle
26
26
  # @return [Integer] Unique identifier of the message.
27
27
  attr_reader :id
28
28
  # @return [Pinnacle::Types::MessageMethodEnum]
29
- attr_reader :method
29
+ attr_reader :method_
30
30
  # @return [Integer] Number of segments the message was split into for delivery.
31
31
  attr_reader :num_segments
32
32
  # @return [String] Phone number that received the message in E.164 format.
@@ -58,7 +58,7 @@ module Pinnacle
58
58
  # <br>
59
59
  # Null indicates no errors.
60
60
  # @param id [Integer] Unique identifier of the message.
61
- # @param method [Pinnacle::Types::MessageMethodEnum]
61
+ # @param method_ [Pinnacle::Types::MessageMethodEnum]
62
62
  # @param num_segments [Integer] Number of segments the message was split into for delivery.
63
63
  # @param receiver [String] Phone number that received the message in E.164 format.
64
64
  # @param sender [String] Phone number or agent that sent the message.
@@ -68,14 +68,14 @@ module Pinnacle
68
68
  # @param type [Pinnacle::Types::MessageProtocolEnum]
69
69
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
70
70
  # @return [Pinnacle::Types::Message]
71
- def initialize(content:, id:, method:, num_segments:, receiver:, sender:, status:, type:, cost: OMIT,
71
+ def initialize(content:, id:, method_:, num_segments:, receiver:, sender:, status:, type:, cost: OMIT,
72
72
  delivered_at: OMIT, error: OMIT, sent_at: OMIT, additional_properties: nil)
73
73
  @content = content
74
74
  @cost = cost if cost != OMIT
75
75
  @delivered_at = delivered_at if delivered_at != OMIT
76
76
  @error = error if error != OMIT
77
77
  @id = id
78
- @method = method
78
+ @method_ = method_
79
79
  @num_segments = num_segments
80
80
  @receiver = receiver
81
81
  @sender = sender
@@ -89,7 +89,7 @@ module Pinnacle
89
89
  "deliveredAt": delivered_at,
90
90
  "error": error,
91
91
  "id": id,
92
- "method": method,
92
+ "method": method_,
93
93
  "numSegments": num_segments,
94
94
  "receiver": receiver,
95
95
  "sender": sender,
@@ -118,7 +118,7 @@ module Pinnacle
118
118
  delivered_at = parsed_json["deliveredAt"]
119
119
  error = parsed_json["error"]
120
120
  id = parsed_json["id"]
121
- method = parsed_json["method"]
121
+ method_ = parsed_json["method"]
122
122
  num_segments = parsed_json["numSegments"]
123
123
  receiver = parsed_json["receiver"]
124
124
  sender = parsed_json["sender"]
@@ -131,7 +131,7 @@ module Pinnacle
131
131
  delivered_at: delivered_at,
132
132
  error: error,
133
133
  id: id,
134
- method: method,
134
+ method_: method_,
135
135
  num_segments: num_segments,
136
136
  receiver: receiver,
137
137
  sender: sender,
@@ -161,7 +161,7 @@ module Pinnacle
161
161
  obj.delivered_at&.is_a?(String) != false || raise("Passed value for field obj.delivered_at is not the expected type, validation failed.")
162
162
  obj.error&.is_a?(String) != false || raise("Passed value for field obj.error is not the expected type, validation failed.")
163
163
  obj.id.is_a?(Integer) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
164
- obj.method.is_a?(Pinnacle::Types::MessageMethodEnum) != false || raise("Passed value for field obj.method is not the expected type, validation failed.")
164
+ obj.method_.is_a?(Pinnacle::Types::MessageMethodEnum) != false || raise("Passed value for field obj.method_ is not the expected type, validation failed.")
165
165
  obj.num_segments.is_a?(Integer) != false || raise("Passed value for field obj.num_segments is not the expected type, validation failed.")
166
166
  obj.receiver.is_a?(String) != false || raise("Passed value for field obj.receiver is not the expected type, validation failed.")
167
167
  obj.sender.is_a?(String) != false || raise("Passed value for field obj.sender is not the expected type, validation failed.")