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.
Files changed (77) 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 +25 -25
  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/{upsert_rcs_schema_agent.rb → upsert_rcs_agent.rb} +17 -17
  17. data/lib/rcs/campaigns/rcs/types/{upsert_rcs_schema_links.rb → upsert_rcs_links.rb} +5 -5
  18. data/lib/rcs/campaigns/rcs/types/{upsert_rcs_schema_opt_in.rb → upsert_rcs_opt_in.rb} +13 -13
  19. data/lib/rcs/campaigns/rcs/types/{upsert_rcs_schema_opt_out.rb → upsert_rcs_opt_out.rb} +5 -5
  20. data/lib/rcs/campaigns/rcs/types/{upsert_rcs_schema_use_case.rb → upsert_rcs_use_case.rb} +5 -5
  21. data/lib/rcs/campaigns/toll_free/client.rb +4 -4
  22. data/lib/rcs/campaigns/toll_free/types/toll_free_autofill_response.rb +10 -10
  23. data/lib/rcs/campaigns/toll_free/types/upsert_toll_free_schema_opt_in.rb +8 -8
  24. data/lib/rcs/conversations/client.rb +2 -2
  25. data/lib/rcs/messages/client.rb +24 -3
  26. data/lib/rcs/messages/mms/client.rb +118 -0
  27. data/lib/rcs/messages/{send/types/send_mms_response.rb → mms/types/mms_send_response.rb} +4 -4
  28. data/lib/rcs/messages/{send/types/send_mms_schema_options.rb → mms/types/send_mms_options.rb} +6 -6
  29. data/lib/rcs/messages/rcs/client.rb +68 -0
  30. data/lib/rcs/messages/{send/types/send_rcs_response.rb → rcs/types/rcs_send_response.rb} +4 -4
  31. data/lib/rcs/messages/sms/client.rb +198 -0
  32. data/lib/rcs/messages/{send/types/send_sms_schema_options.rb → sms/types/send_sms_options.rb} +6 -6
  33. data/lib/rcs/messages/{send/types/send_sms_response.rb → sms/types/sms_send_response.rb} +4 -4
  34. data/lib/rcs/messages/types/{message_reaction_schema_options.rb → react_message_options.rb} +5 -5
  35. data/lib/rcs/phone_numbers/client.rb +32 -18
  36. data/lib/rcs/phone_numbers/types/{phone_details_schema_options_enhanced_contact_info.rb → enhanced_contact_info.rb} +5 -7
  37. data/lib/rcs/phone_numbers/types/{phone_details_schema_options.rb → retrieve_phone_number_details_options.rb} +10 -10
  38. data/lib/rcs/phone_numbers/types/{search_schema_number.rb → search_phone_number_by_digits.rb} +5 -5
  39. data/lib/rcs/phone_numbers/types/{search_schema_location.rb → search_phone_number_by_location.rb} +5 -5
  40. data/lib/rcs/phone_numbers/types/{search_schema_options.rb → search_phone_number_options.rb} +5 -5
  41. data/lib/rcs/phone_numbers/webhook/client.rb +2 -2
  42. data/lib/rcs/tools/file/client.rb +3 -3
  43. data/lib/rcs/tools/file/types/{file_upload_schema_options_download.rb → download_options.rb} +5 -5
  44. data/lib/rcs/tools/file/types/{file_upload_schema_options.rb → upload_file_options.rb} +10 -10
  45. data/lib/rcs/types/{attach_webhook_schema_webhook_id.rb → attach_webhook_by_id_params.rb} +5 -5
  46. data/lib/rcs/types/attach_webhook_params.rb +8 -8
  47. data/lib/rcs/types/{get_conversation_request_id.rb → conversation_by_id_params.rb} +5 -5
  48. data/lib/rcs/types/{get_conversation_request_recipient.rb → conversation_by_participants_params.rb} +5 -5
  49. data/lib/rcs/types/{attach_webhook_schema_name.rb → create_and_attach_webhook_by_url_params.rb} +5 -5
  50. data/lib/rcs/types/get_conversation_params.rb +8 -8
  51. data/lib/rcs/types/link_click_event.rb +8 -8
  52. data/lib/rcs/types/message.rb +8 -8
  53. data/lib/rcs/types/rcs.rb +12 -12
  54. data/lib/rcs/types/rcs_campaign_schema_extra_opt_in.rb +8 -8
  55. data/lib/rcs/types/rcs_campaign_schema_opt_in.rb +8 -8
  56. data/lib/rcs/types/rcs_cards.rb +4 -4
  57. data/lib/rcs/types/rcs_cards_cards_item.rb +4 -4
  58. data/lib/rcs/types/rcs_cards_content.rb +4 -4
  59. data/lib/rcs/types/rcs_cards_content_cards_item.rb +4 -4
  60. data/lib/rcs/types/rcs_media_content.rb +4 -4
  61. data/lib/rcs/types/rcs_text_content.rb +4 -4
  62. data/lib/rcs/types/{rcs_button_content.rb → rich_button.rb} +10 -10
  63. data/lib/rcs/types/{rcs_card.rb → rich_cards_message.rb} +9 -9
  64. data/lib/rcs/types/{rcs_media.rb → rich_media_message.rb} +9 -9
  65. data/lib/rcs/types/{rcs_text.rb → rich_text_message.rb} +9 -9
  66. data/lib/rcs/types/toll_free_campaign.rb +10 -10
  67. data/lib/rcs/types/toll_free_campaign_with_extended_brand_and_status.rb +10 -10
  68. data/lib/rcs/types/{nullable_contact.rb → upsert_contact.rb} +5 -5
  69. data/lib/rcs/types/{toll_free_campaign_schema_opt_in.rb → upsert_toll_free_campaign_opt_in.rb} +13 -13
  70. data/lib/rcs/types/{toll_free_campaign_schema_use_case.rb → upsert_toll_free_campaign_use_case.rb} +5 -5
  71. data/lib/rcs.rb +0 -7
  72. data/lib/requests.rb +2 -2
  73. data/lib/types_export.rb +40 -40
  74. metadata +43 -45
  75. data/lib/rcs/message/client.rb +0 -30
  76. data/lib/rcs/message/sms/client.rb +0 -96
  77. data/lib/rcs/messages/send/client.rb +0 -318
@@ -6,7 +6,7 @@ require "json"
6
6
  module Pinnacle
7
7
  module Messages
8
8
  module Types
9
- class MessageReactionSchemaOptions
9
+ class ReactMessageOptions
10
10
  # @return [Boolean] By default, only messages sent with the `options.tracking` field can be
11
11
  # precisely reacted to. <br>
12
12
  # Set `options.force` to true to bypass this restriction (may react to a different
@@ -29,7 +29,7 @@ module Pinnacle
29
29
  # For MMS and RCS, only messages containing text can be tracked. Otherwise,
30
30
  # `options.force` is ignored.
31
31
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
32
- # @return [Pinnacle::Messages::Types::MessageReactionSchemaOptions]
32
+ # @return [Pinnacle::Messages::Types::ReactMessageOptions]
33
33
  def initialize(force: OMIT, additional_properties: nil)
34
34
  @force = force if force != OMIT
35
35
  @additional_properties = additional_properties
@@ -38,10 +38,10 @@ module Pinnacle
38
38
  end
39
39
  end
40
40
 
41
- # Deserialize a JSON object to an instance of MessageReactionSchemaOptions
41
+ # Deserialize a JSON object to an instance of ReactMessageOptions
42
42
  #
43
43
  # @param json_object [String]
44
- # @return [Pinnacle::Messages::Types::MessageReactionSchemaOptions]
44
+ # @return [Pinnacle::Messages::Types::ReactMessageOptions]
45
45
  def self.from_json(json_object:)
46
46
  struct = JSON.parse(json_object, object_class: OpenStruct)
47
47
  parsed_json = JSON.parse(json_object)
@@ -49,7 +49,7 @@ module Pinnacle
49
49
  new(force: force, additional_properties: struct)
50
50
  end
51
51
 
52
- # Serialize an instance of MessageReactionSchemaOptions to a JSON object
52
+ # Serialize an instance of ReactMessageOptions to a JSON object
53
53
  #
54
54
  # @return [String]
55
55
  def to_json(*_args)
@@ -2,27 +2,35 @@
2
2
 
3
3
  require_relative "../../requests"
4
4
  require_relative "../types/phone_feature_enum"
5
- require_relative "types/search_schema_location"
6
- require_relative "types/search_schema_number"
7
- require_relative "types/search_schema_options"
5
+ require_relative "types/search_phone_number_by_location"
6
+ require_relative "types/search_phone_number_by_digits"
7
+ require_relative "types/search_phone_number_options"
8
8
  require_relative "../types/phone_enum"
9
9
  require_relative "../types/phone_number_details"
10
10
  require "json"
11
11
  require_relative "../types/purchased_number"
12
12
  require_relative "types/phone_details_schema_level"
13
- require_relative "types/phone_details_schema_options"
13
+ require_relative "types/retrieve_phone_number_details_options"
14
14
  require_relative "types/phone_numbers_get_response"
15
+ require_relative "campaign/client"
16
+ require_relative "webhook/client"
15
17
  require "async"
16
18
 
17
19
  module Pinnacle
18
20
  class PhoneNumbersClient
19
21
  # @return [Pinnacle::RequestClient]
20
22
  attr_reader :request_client
23
+ # @return [Pinnacle::PhoneNumbers::CampaignClient]
24
+ attr_reader :campaign
25
+ # @return [Pinnacle::PhoneNumbers::WebhookClient]
26
+ attr_reader :webhook
21
27
 
22
28
  # @param request_client [Pinnacle::RequestClient]
23
29
  # @return [Pinnacle::PhoneNumbersClient]
24
30
  def initialize(request_client:)
25
31
  @request_client = request_client
32
+ @campaign = Pinnacle::PhoneNumbers::CampaignClient.new(request_client: request_client)
33
+ @webhook = Pinnacle::PhoneNumbers::WebhookClient.new(request_client: request_client)
26
34
  end
27
35
 
28
36
  # Search for available phone numbers that match your exact criteria.
@@ -30,16 +38,16 @@ module Pinnacle
30
38
  # @param features [Array<Pinnacle::Types::PhoneFeatureEnum>]
31
39
  # @param location [Hash] Filter your search by geographic location to find numbers in specific regions.
32
40
  # <br>
33
- # Toll-free numbers ignore city and state filters.Request of type Pinnacle::PhoneNumbers::Types::SearchSchemaLocation, as a Hash
41
+ # Toll-free numbers ignore city and state filters.Request of type Pinnacle::PhoneNumbers::Types::SearchPhoneNumberByLocation, as a Hash
34
42
  # * :city (String)
35
43
  # * :country_code (String)
36
44
  # * :national_destination_code (String)
37
45
  # * :state (String)
38
- # @param phone_number_digit_filters [Hash] Filter your search by digit pattern.Request of type Pinnacle::PhoneNumbers::Types::SearchSchemaNumber, as a Hash
46
+ # @param number [Hash] Filter your search by digit pattern.Request of type Pinnacle::PhoneNumbers::Types::SearchPhoneNumberByDigits, as a Hash
39
47
  # * :contains (String)
40
48
  # * :ends_with (String)
41
49
  # * :starts_with (String)
42
- # @param options [Hash] Extra search settings to control how many results you get.Request of type Pinnacle::PhoneNumbers::Types::SearchSchemaOptions, as a Hash
50
+ # @param options [Hash] Extra search settings to control how many results you get.Request of type Pinnacle::PhoneNumbers::Types::SearchPhoneNumberOptions, as a Hash
43
51
  # * :limit (Integer)
44
52
  # @param type [Array<Pinnacle::Types::PhoneEnum>] Types of phone numbers to return in your search.
45
53
  # @param request_options [Pinnacle::RequestOptions]
@@ -53,11 +61,11 @@ module Pinnacle
53
61
  # api.phone_numbers.search(
54
62
  # features: [SMS, MMS],
55
63
  # location: { city: "New York", national_destination_code: "212" },
56
- # phone_number_digit_filters: { contains: "514", starts_with: "45" },
64
+ # number: { contains: "514", starts_with: "45" },
57
65
  # options: { limit: 4 },
58
66
  # type: [LOCAL]
59
67
  # )
60
- def search(type:, features: nil, location: nil, phone_number_digit_filters: nil, options: nil, request_options: nil)
68
+ def search(type:, features: nil, location: nil, number: nil, options: nil, request_options: nil)
61
69
  response = @request_client.conn.post do |req|
62
70
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
63
71
  req.headers["PINNACLE-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
@@ -73,7 +81,7 @@ module Pinnacle
73
81
  **(request_options&.additional_body_parameters || {}),
74
82
  features: features,
75
83
  location: location,
76
- number: phone_number_digit_filters,
84
+ number: number,
77
85
  options: options,
78
86
  type: type
79
87
  }.compact
@@ -134,7 +142,7 @@ module Pinnacle
134
142
  # - `basic`: Receive essential info like carrier, location, and format.
135
143
  # - `advanced`: Receive a deeper analysis including fraud risk, detailed location,
136
144
  # and enhanced contact info.
137
- # @param options [Hash] Customize your lookup with additional options.Request of type Pinnacle::PhoneNumbers::Types::PhoneDetailsSchemaOptions, as a Hash
145
+ # @param options [Hash] Customize your lookup with additional options.Request of type Pinnacle::PhoneNumbers::Types::RetrievePhoneNumberDetailsOptions, as a Hash
138
146
  # * :force (Boolean)
139
147
  # * :risk (Boolean)
140
148
  # * :enhanced_contact_info (Hash)
@@ -179,11 +187,17 @@ module Pinnacle
179
187
  class AsyncPhoneNumbersClient
180
188
  # @return [Pinnacle::AsyncRequestClient]
181
189
  attr_reader :request_client
190
+ # @return [Pinnacle::PhoneNumbers::AsyncCampaignClient]
191
+ attr_reader :campaign
192
+ # @return [Pinnacle::PhoneNumbers::AsyncWebhookClient]
193
+ attr_reader :webhook
182
194
 
183
195
  # @param request_client [Pinnacle::AsyncRequestClient]
184
196
  # @return [Pinnacle::AsyncPhoneNumbersClient]
185
197
  def initialize(request_client:)
186
198
  @request_client = request_client
199
+ @campaign = Pinnacle::PhoneNumbers::AsyncCampaignClient.new(request_client: request_client)
200
+ @webhook = Pinnacle::PhoneNumbers::AsyncWebhookClient.new(request_client: request_client)
187
201
  end
188
202
 
189
203
  # Search for available phone numbers that match your exact criteria.
@@ -191,16 +205,16 @@ module Pinnacle
191
205
  # @param features [Array<Pinnacle::Types::PhoneFeatureEnum>]
192
206
  # @param location [Hash] Filter your search by geographic location to find numbers in specific regions.
193
207
  # <br>
194
- # Toll-free numbers ignore city and state filters.Request of type Pinnacle::PhoneNumbers::Types::SearchSchemaLocation, as a Hash
208
+ # Toll-free numbers ignore city and state filters.Request of type Pinnacle::PhoneNumbers::Types::SearchPhoneNumberByLocation, as a Hash
195
209
  # * :city (String)
196
210
  # * :country_code (String)
197
211
  # * :national_destination_code (String)
198
212
  # * :state (String)
199
- # @param phone_number_digit_filters [Hash] Filter your search by digit pattern.Request of type Pinnacle::PhoneNumbers::Types::SearchSchemaNumber, as a Hash
213
+ # @param number [Hash] Filter your search by digit pattern.Request of type Pinnacle::PhoneNumbers::Types::SearchPhoneNumberByDigits, as a Hash
200
214
  # * :contains (String)
201
215
  # * :ends_with (String)
202
216
  # * :starts_with (String)
203
- # @param options [Hash] Extra search settings to control how many results you get.Request of type Pinnacle::PhoneNumbers::Types::SearchSchemaOptions, as a Hash
217
+ # @param options [Hash] Extra search settings to control how many results you get.Request of type Pinnacle::PhoneNumbers::Types::SearchPhoneNumberOptions, as a Hash
204
218
  # * :limit (Integer)
205
219
  # @param type [Array<Pinnacle::Types::PhoneEnum>] Types of phone numbers to return in your search.
206
220
  # @param request_options [Pinnacle::RequestOptions]
@@ -214,11 +228,11 @@ module Pinnacle
214
228
  # api.phone_numbers.search(
215
229
  # features: [SMS, MMS],
216
230
  # location: { city: "New York", national_destination_code: "212" },
217
- # phone_number_digit_filters: { contains: "514", starts_with: "45" },
231
+ # number: { contains: "514", starts_with: "45" },
218
232
  # options: { limit: 4 },
219
233
  # type: [LOCAL]
220
234
  # )
221
- def search(type:, features: nil, location: nil, phone_number_digit_filters: nil, options: nil, request_options: nil)
235
+ def search(type:, features: nil, location: nil, number: nil, options: nil, request_options: nil)
222
236
  Async do
223
237
  response = @request_client.conn.post do |req|
224
238
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -235,7 +249,7 @@ module Pinnacle
235
249
  **(request_options&.additional_body_parameters || {}),
236
250
  features: features,
237
251
  location: location,
238
- number: phone_number_digit_filters,
252
+ number: number,
239
253
  options: options,
240
254
  type: type
241
255
  }.compact
@@ -299,7 +313,7 @@ module Pinnacle
299
313
  # - `basic`: Receive essential info like carrier, location, and format.
300
314
  # - `advanced`: Receive a deeper analysis including fraud risk, detailed location,
301
315
  # and enhanced contact info.
302
- # @param options [Hash] Customize your lookup with additional options.Request of type Pinnacle::PhoneNumbers::Types::PhoneDetailsSchemaOptions, as a Hash
316
+ # @param options [Hash] Customize your lookup with additional options.Request of type Pinnacle::PhoneNumbers::Types::RetrievePhoneNumberDetailsOptions, as a Hash
303
317
  # * :force (Boolean)
304
318
  # * :risk (Boolean)
305
319
  # * :enhanced_contact_info (Hash)
@@ -7,7 +7,7 @@ module Pinnacle
7
7
  module PhoneNumbers
8
8
  module Types
9
9
  # Additional information to tailor lookup.
10
- class PhoneDetailsSchemaOptionsEnhancedContactInfo
10
+ class EnhancedContactInfo
11
11
  # @return [String] Business context.
12
12
  attr_reader :context
13
13
  # @return [OpenStruct] Additional properties unmapped to the current class definition
@@ -20,7 +20,7 @@ module Pinnacle
20
20
 
21
21
  # @param context [String] Business context.
22
22
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
23
- # @return [Pinnacle::PhoneNumbers::Types::PhoneDetailsSchemaOptionsEnhancedContactInfo]
23
+ # @return [Pinnacle::PhoneNumbers::Types::EnhancedContactInfo]
24
24
  def initialize(context: OMIT, additional_properties: nil)
25
25
  @context = context if context != OMIT
26
26
  @additional_properties = additional_properties
@@ -29,11 +29,10 @@ module Pinnacle
29
29
  end
30
30
  end
31
31
 
32
- # Deserialize a JSON object to an instance of
33
- # PhoneDetailsSchemaOptionsEnhancedContactInfo
32
+ # Deserialize a JSON object to an instance of EnhancedContactInfo
34
33
  #
35
34
  # @param json_object [String]
36
- # @return [Pinnacle::PhoneNumbers::Types::PhoneDetailsSchemaOptionsEnhancedContactInfo]
35
+ # @return [Pinnacle::PhoneNumbers::Types::EnhancedContactInfo]
37
36
  def self.from_json(json_object:)
38
37
  struct = JSON.parse(json_object, object_class: OpenStruct)
39
38
  parsed_json = JSON.parse(json_object)
@@ -41,8 +40,7 @@ module Pinnacle
41
40
  new(context: context, additional_properties: struct)
42
41
  end
43
42
 
44
- # Serialize an instance of PhoneDetailsSchemaOptionsEnhancedContactInfo to a JSON
45
- # object
43
+ # Serialize an instance of EnhancedContactInfo to a JSON object
46
44
  #
47
45
  # @return [String]
48
46
  def to_json(*_args)
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require_relative "phone_details_schema_options_enhanced_contact_info"
3
+ require_relative "enhanced_contact_info"
4
4
  require "ostruct"
5
5
  require "json"
6
6
 
@@ -8,14 +8,14 @@ module Pinnacle
8
8
  module PhoneNumbers
9
9
  module Types
10
10
  # Customize your lookup with additional options.
11
- class PhoneDetailsSchemaOptions
11
+ class RetrievePhoneNumberDetailsOptions
12
12
  # @return [Boolean] Allows you to force a fresh lookup from primary sources instead of cached data.
13
13
  # <br>
14
14
  # Fresh lookups will take longer to complete than cached lookups.
15
15
  attr_reader :force
16
16
  # @return [Boolean] Include a fraud risk and security analysis.
17
17
  attr_reader :risk
18
- # @return [Pinnacle::PhoneNumbers::Types::PhoneDetailsSchemaOptionsEnhancedContactInfo] Additional information to tailor lookup.
18
+ # @return [Pinnacle::PhoneNumbers::Types::EnhancedContactInfo] Additional information to tailor lookup.
19
19
  attr_reader :enhanced_contact_info
20
20
  # @return [OpenStruct] Additional properties unmapped to the current class definition
21
21
  attr_reader :additional_properties
@@ -29,9 +29,9 @@ module Pinnacle
29
29
  # <br>
30
30
  # Fresh lookups will take longer to complete than cached lookups.
31
31
  # @param risk [Boolean] Include a fraud risk and security analysis.
32
- # @param enhanced_contact_info [Pinnacle::PhoneNumbers::Types::PhoneDetailsSchemaOptionsEnhancedContactInfo] Additional information to tailor lookup.
32
+ # @param enhanced_contact_info [Pinnacle::PhoneNumbers::Types::EnhancedContactInfo] Additional information to tailor lookup.
33
33
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
34
- # @return [Pinnacle::PhoneNumbers::Types::PhoneDetailsSchemaOptions]
34
+ # @return [Pinnacle::PhoneNumbers::Types::RetrievePhoneNumberDetailsOptions]
35
35
  def initialize(force: OMIT, risk: OMIT, enhanced_contact_info: OMIT, additional_properties: nil)
36
36
  @force = force if force != OMIT
37
37
  @risk = risk if risk != OMIT
@@ -46,10 +46,10 @@ module Pinnacle
46
46
  end
47
47
  end
48
48
 
49
- # Deserialize a JSON object to an instance of PhoneDetailsSchemaOptions
49
+ # Deserialize a JSON object to an instance of RetrievePhoneNumberDetailsOptions
50
50
  #
51
51
  # @param json_object [String]
52
- # @return [Pinnacle::PhoneNumbers::Types::PhoneDetailsSchemaOptions]
52
+ # @return [Pinnacle::PhoneNumbers::Types::RetrievePhoneNumberDetailsOptions]
53
53
  def self.from_json(json_object:)
54
54
  struct = JSON.parse(json_object, object_class: OpenStruct)
55
55
  parsed_json = JSON.parse(json_object)
@@ -59,7 +59,7 @@ module Pinnacle
59
59
  enhanced_contact_info = nil
60
60
  else
61
61
  enhanced_contact_info = parsed_json["enhanced_contact_info"].to_json
62
- enhanced_contact_info = Pinnacle::PhoneNumbers::Types::PhoneDetailsSchemaOptionsEnhancedContactInfo.from_json(json_object: enhanced_contact_info)
62
+ enhanced_contact_info = Pinnacle::PhoneNumbers::Types::EnhancedContactInfo.from_json(json_object: enhanced_contact_info)
63
63
  end
64
64
  new(
65
65
  force: force,
@@ -69,7 +69,7 @@ module Pinnacle
69
69
  )
70
70
  end
71
71
 
72
- # Serialize an instance of PhoneDetailsSchemaOptions to a JSON object
72
+ # Serialize an instance of RetrievePhoneNumberDetailsOptions to a JSON object
73
73
  #
74
74
  # @return [String]
75
75
  def to_json(*_args)
@@ -85,7 +85,7 @@ module Pinnacle
85
85
  def self.validate_raw(obj:)
86
86
  obj.force&.is_a?(Boolean) != false || raise("Passed value for field obj.force is not the expected type, validation failed.")
87
87
  obj.risk&.is_a?(Boolean) != false || raise("Passed value for field obj.risk is not the expected type, validation failed.")
88
- obj.enhanced_contact_info.nil? || Pinnacle::PhoneNumbers::Types::PhoneDetailsSchemaOptionsEnhancedContactInfo.validate_raw(obj: obj.enhanced_contact_info)
88
+ obj.enhanced_contact_info.nil? || Pinnacle::PhoneNumbers::Types::EnhancedContactInfo.validate_raw(obj: obj.enhanced_contact_info)
89
89
  end
90
90
  end
91
91
  end
@@ -7,7 +7,7 @@ module Pinnacle
7
7
  module PhoneNumbers
8
8
  module Types
9
9
  # Filter your search by digit pattern.
10
- class SearchSchemaNumber
10
+ class SearchPhoneNumberByDigits
11
11
  # @return [String] Your search will return only numbers that contain this digit sequence anywhere
12
12
  # within them.
13
13
  attr_reader :contains
@@ -28,7 +28,7 @@ module Pinnacle
28
28
  # @param ends_with [String] Your search will return only numbers that end with these digits.
29
29
  # @param starts_with [String] Your search will return only numbers that begin with these digits.
30
30
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
31
- # @return [Pinnacle::PhoneNumbers::Types::SearchSchemaNumber]
31
+ # @return [Pinnacle::PhoneNumbers::Types::SearchPhoneNumberByDigits]
32
32
  def initialize(contains: OMIT, ends_with: OMIT, starts_with: OMIT, additional_properties: nil)
33
33
  @contains = contains if contains != OMIT
34
34
  @ends_with = ends_with if ends_with != OMIT
@@ -39,10 +39,10 @@ module Pinnacle
39
39
  end
40
40
  end
41
41
 
42
- # Deserialize a JSON object to an instance of SearchSchemaNumber
42
+ # Deserialize a JSON object to an instance of SearchPhoneNumberByDigits
43
43
  #
44
44
  # @param json_object [String]
45
- # @return [Pinnacle::PhoneNumbers::Types::SearchSchemaNumber]
45
+ # @return [Pinnacle::PhoneNumbers::Types::SearchPhoneNumberByDigits]
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)
@@ -57,7 +57,7 @@ module Pinnacle
57
57
  )
58
58
  end
59
59
 
60
- # Serialize an instance of SearchSchemaNumber to a JSON object
60
+ # Serialize an instance of SearchPhoneNumberByDigits to a JSON object
61
61
  #
62
62
  # @return [String]
63
63
  def to_json(*_args)
@@ -9,7 +9,7 @@ module Pinnacle
9
9
  # Filter your search by geographic location to find numbers in specific regions.
10
10
  # <br>
11
11
  # Toll-free numbers ignore city and state filters.
12
- class SearchSchemaLocation
12
+ class SearchPhoneNumberByLocation
13
13
  # @return [String] Search for numbers in your target city.
14
14
  attr_reader :city
15
15
  # @return [String] Currently, only US numbers are supported.
@@ -33,7 +33,7 @@ module Pinnacle
33
33
  # For US numbers, this is usually the 3-digit area code.
34
34
  # @param state [String] Search for numbers in your target state or province using a two-letter code.
35
35
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
36
- # @return [Pinnacle::PhoneNumbers::Types::SearchSchemaLocation]
36
+ # @return [Pinnacle::PhoneNumbers::Types::SearchPhoneNumberByLocation]
37
37
  def initialize(city: OMIT, country_code: OMIT, national_destination_code: OMIT, state: OMIT,
38
38
  additional_properties: nil)
39
39
  @city = city if city != OMIT
@@ -51,10 +51,10 @@ module Pinnacle
51
51
  end
52
52
  end
53
53
 
54
- # Deserialize a JSON object to an instance of SearchSchemaLocation
54
+ # Deserialize a JSON object to an instance of SearchPhoneNumberByLocation
55
55
  #
56
56
  # @param json_object [String]
57
- # @return [Pinnacle::PhoneNumbers::Types::SearchSchemaLocation]
57
+ # @return [Pinnacle::PhoneNumbers::Types::SearchPhoneNumberByLocation]
58
58
  def self.from_json(json_object:)
59
59
  struct = JSON.parse(json_object, object_class: OpenStruct)
60
60
  parsed_json = JSON.parse(json_object)
@@ -71,7 +71,7 @@ module Pinnacle
71
71
  )
72
72
  end
73
73
 
74
- # Serialize an instance of SearchSchemaLocation to a JSON object
74
+ # Serialize an instance of SearchPhoneNumberByLocation to a JSON object
75
75
  #
76
76
  # @return [String]
77
77
  def to_json(*_args)
@@ -7,7 +7,7 @@ module Pinnacle
7
7
  module PhoneNumbers
8
8
  module Types
9
9
  # Extra search settings to control how many results you get.
10
- class SearchSchemaOptions
10
+ class SearchPhoneNumberOptions
11
11
  # @return [Integer] Set the maximum number of phone numbers to return.
12
12
  attr_reader :limit
13
13
  # @return [OpenStruct] Additional properties unmapped to the current class definition
@@ -20,7 +20,7 @@ module Pinnacle
20
20
 
21
21
  # @param limit [Integer] Set the maximum number of phone numbers to return.
22
22
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
23
- # @return [Pinnacle::PhoneNumbers::Types::SearchSchemaOptions]
23
+ # @return [Pinnacle::PhoneNumbers::Types::SearchPhoneNumberOptions]
24
24
  def initialize(limit: OMIT, additional_properties: nil)
25
25
  @limit = limit if limit != OMIT
26
26
  @additional_properties = additional_properties
@@ -29,10 +29,10 @@ module Pinnacle
29
29
  end
30
30
  end
31
31
 
32
- # Deserialize a JSON object to an instance of SearchSchemaOptions
32
+ # Deserialize a JSON object to an instance of SearchPhoneNumberOptions
33
33
  #
34
34
  # @param json_object [String]
35
- # @return [Pinnacle::PhoneNumbers::Types::SearchSchemaOptions]
35
+ # @return [Pinnacle::PhoneNumbers::Types::SearchPhoneNumberOptions]
36
36
  def self.from_json(json_object:)
37
37
  struct = JSON.parse(json_object, object_class: OpenStruct)
38
38
  parsed_json = JSON.parse(json_object)
@@ -40,7 +40,7 @@ module Pinnacle
40
40
  new(limit: limit, additional_properties: struct)
41
41
  end
42
42
 
43
- # Serialize an instance of SearchSchemaOptions to a JSON object
43
+ # Serialize an instance of SearchPhoneNumberOptions to a JSON object
44
44
  #
45
45
  # @return [String]
46
46
  def to_json(*_args)
@@ -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)