rcs 2.0.0.pre.rc.4 → 2.0.0

data/lib/rcs/messages/client.rb

@@ -4,34 +4,23 @@ require_relative "../../requests"
 require_relative "../types/message"
 require_relative "types/react_message_options"
 require_relative "../types/reaction_result"
-require_relative "sms/client"
-require_relative "mms/client"
-require_relative "rcs/client"
 require "async"
 
 module Pinnacle
   class MessagesClient
     # @return [Pinnacle::RequestClient]
     attr_reader :request_client
-    # @return [Pinnacle::Messages::SmsClient]
-    attr_reader :sms
-    # @return [Pinnacle::Messages::MmsClient]
-    attr_reader :mms
-    # @return [Pinnacle::Messages::RcsClient]
-    attr_reader :rcs
 
     # @param request_client [Pinnacle::RequestClient]
     # @return [Pinnacle::MessagesClient]
     def initialize(request_client:)
       @request_client = request_client
-      @sms = Pinnacle::Messages::SmsClient.new(request_client: request_client)
-      @mms = Pinnacle::Messages::MmsClient.new(request_client: request_client)
-      @rcs = Pinnacle::Messages::RcsClient.new(request_client: request_client)
     end
 
     # Retrieve a previously sent message.
     #
-    # @param id [Integer] Unique identifier of the message.
+    # @param id [String] Unique identifier of the message. This identifier is a string that always begins
+    #  with the prefix `msg_`, for example: `msg_1234567890`.
     # @param request_options [Pinnacle::RequestOptions]
     # @return [Pinnacle::Types::Message]
     # @example
@@ -40,7 +29,7 @@ module Pinnacle
     #    environment: Pinnacle::Environment::DEFAULT,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.messages.get(id: 1240)
+    #  api.messages.get(id: "msg_1234567890")
     def get(id:, request_options: nil)
       response = @request_client.conn.get do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -63,7 +52,8 @@ module Pinnacle
 
     # Add or remove an emoji reaction to a previously sent message.
     #
-    # @param message_id [Integer] Unique identifier of the message.
+    # @param message_id [String] Unique identifier of the message. This identifier is a string that always begins
+    #  with the prefix `msg_`, for example: `msg_1234567890`.
     # @param options [Hash] Request of type Pinnacle::Messages::Types::ReactMessageOptions, as a Hash
     #   * :force (Boolean)
     # @param reaction [String] Unicode emoji to add. <br>
@@ -77,7 +67,7 @@ module Pinnacle
     #    api_key: "YOUR_API_KEY"
     #  )
     #  api.messages.react(
-    #    message_id: 1410,
+    #    message_id: "msg_1234567890",
     #    options: { force: true },
     #    reaction: "👍"
     #  )
@@ -108,25 +98,17 @@ module Pinnacle
   class AsyncMessagesClient
     # @return [Pinnacle::AsyncRequestClient]
     attr_reader :request_client
-    # @return [Pinnacle::Messages::AsyncSmsClient]
-    attr_reader :sms
-    # @return [Pinnacle::Messages::AsyncMmsClient]
-    attr_reader :mms
-    # @return [Pinnacle::Messages::AsyncRcsClient]
-    attr_reader :rcs
 
     # @param request_client [Pinnacle::AsyncRequestClient]
     # @return [Pinnacle::AsyncMessagesClient]
     def initialize(request_client:)
       @request_client = request_client
-      @sms = Pinnacle::Messages::AsyncSmsClient.new(request_client: request_client)
-      @mms = Pinnacle::Messages::AsyncMmsClient.new(request_client: request_client)
-      @rcs = Pinnacle::Messages::AsyncRcsClient.new(request_client: request_client)
     end
 
     # Retrieve a previously sent message.
     #
-    # @param id [Integer] Unique identifier of the message.
+    # @param id [String] Unique identifier of the message. This identifier is a string that always begins
+    #  with the prefix `msg_`, for example: `msg_1234567890`.
     # @param request_options [Pinnacle::RequestOptions]
     # @return [Pinnacle::Types::Message]
     # @example
@@ -135,7 +117,7 @@ module Pinnacle
     #    environment: Pinnacle::Environment::DEFAULT,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.messages.get(id: 1240)
+    #  api.messages.get(id: "msg_1234567890")
     def get(id:, request_options: nil)
       Async do
         response = @request_client.conn.get do |req|
@@ -160,7 +142,8 @@ module Pinnacle
 
     # Add or remove an emoji reaction to a previously sent message.
     #
-    # @param message_id [Integer] Unique identifier of the message.
+    # @param message_id [String] Unique identifier of the message. This identifier is a string that always begins
+    #  with the prefix `msg_`, for example: `msg_1234567890`.
     # @param options [Hash] Request of type Pinnacle::Messages::Types::ReactMessageOptions, as a Hash
     #   * :force (Boolean)
     # @param reaction [String] Unicode emoji to add. <br>
@@ -174,7 +157,7 @@ module Pinnacle
     #    api_key: "YOUR_API_KEY"
     #  )
     #  api.messages.react(
-    #    message_id: 1410,
+    #    message_id: "msg_1234567890",
     #    options: { force: true },
     #    reaction: "👍"
     #  )

data/lib/rcs/messages/mms/client.rb

@@ -28,7 +28,7 @@ module Pinnacle
       # @param options [Hash] Control how your MMS is processed and delivered.Request of type Pinnacle::Messages::Mms::Types::SendMmsOptions, as a Hash
       #   * :multiple_messages (Boolean)
       #   * :schedule (Hash)
-      #     * :end_date (DateTime)
+      #     * :end_date (String)
       #     * :recurrence (String)
       #     * :send_at (String)
       #     * :timezone (String)
@@ -128,7 +128,7 @@ module Pinnacle
       # @param options [Hash] Control how your MMS is processed and delivered.Request of type Pinnacle::Messages::Mms::Types::SendMmsOptions, as a Hash
       #   * :multiple_messages (Boolean)
       #   * :schedule (Hash)
-      #     * :end_date (DateTime)
+      #     * :end_date (String)
       #     * :recurrence (String)
       #     * :send_at (String)
       #     * :timezone (String)

data/lib/rcs/messages/rcs/client.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "../../../requests"
-require_relative "../../types/rcs"
+require_relative "../../types/rich_message"
 require_relative "types/rcs_send_response"
 require_relative "../../types/rcs_validate_content"
 require_relative "../../types/rcs_validation_result"

data/lib/rcs/messages/sms/client.rb

@@ -24,7 +24,7 @@ module Pinnacle
       # @param from [String] Phone number that sends the message in E.164 format.
       # @param options [Hash] Additional settings to customize SMS delivery.Request of type Pinnacle::Messages::Sms::Types::SendSmsOptions, as a Hash
       #   * :schedule (Hash)
-      #     * :end_date (DateTime)
+      #     * :end_date (String)
       #     * :recurrence (String)
       #     * :send_at (String)
       #     * :timezone (String)
@@ -115,7 +115,7 @@ module Pinnacle
       # @param from [String] Phone number that sends the message in E.164 format.
       # @param options [Hash] Additional settings to customize SMS delivery.Request of type Pinnacle::Messages::Sms::Types::SendSmsOptions, as a Hash
       #   * :schedule (Hash)
-      #     * :end_date (DateTime)
+      #     * :end_date (String)
       #     * :recurrence (String)
       #     * :send_at (String)
       #     * :timezone (String)

data/lib/rcs/phone_numbers/campaign/client.rb

@@ -18,11 +18,18 @@ module Pinnacle
         @request_client = request_client
       end
 
-      # Link a phone number to a specific campaign.
+      # Link a phone number to a specific campaign. Phone numbers must be linked to a
+      #  campaign to send messages.
       #
       # @param phones [Array<String>] List of phone number (E.164 format).
       # @param campaign_type [Pinnacle::Types::MessagingProfileEnum]
-      # @param campaign_id [Integer] Campaign's identifier.
+      # @param campaign_id [String] Unique identifier for the campaign. <br>
+      #  - **TOLL_FREE** campaigns:
+      #  - Must begin with the prefix `tf_`
+      #  - Example: `tf_1234567890`
+      #  - **10DLC** campaigns:
+      #  - Must begin with the prefix `dlc_`
+      #  - Example: `dlc_1234567890`
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Types::AttachedPhoneNumberResult]
       # @example
@@ -34,7 +41,7 @@ module Pinnacle
       #  api.phone_numbers.campaign.attach(
       #    phones: ["+14155550123", "+14155559876", "+14155550111"],
       #    campaign_type: TOLL_FREE,
-      #    campaign_id: 101
+      #    campaign_id: "tf_1234567890"
       #  )
       def attach(phones:, campaign_type:, campaign_id:, request_options: nil)
         response = @request_client.conn.post do |req|
@@ -100,11 +107,18 @@ module Pinnacle
         @request_client = request_client
       end
 
-      # Link a phone number to a specific campaign.
+      # Link a phone number to a specific campaign. Phone numbers must be linked to a
+      #  campaign to send messages.
       #
       # @param phones [Array<String>] List of phone number (E.164 format).
       # @param campaign_type [Pinnacle::Types::MessagingProfileEnum]
-      # @param campaign_id [Integer] Campaign's identifier.
+      # @param campaign_id [String] Unique identifier for the campaign. <br>
+      #  - **TOLL_FREE** campaigns:
+      #  - Must begin with the prefix `tf_`
+      #  - Example: `tf_1234567890`
+      #  - **10DLC** campaigns:
+      #  - Must begin with the prefix `dlc_`
+      #  - Example: `dlc_1234567890`
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Types::AttachedPhoneNumberResult]
       # @example
@@ -116,7 +130,7 @@ module Pinnacle
       #  api.phone_numbers.campaign.attach(
       #    phones: ["+14155550123", "+14155559876", "+14155550111"],
       #    campaign_type: TOLL_FREE,
-      #    campaign_id: 101
+      #    campaign_id: "tf_1234567890"
       #  )
       def attach(phones:, campaign_type:, campaign_id:, request_options: nil)
         Async do

data/lib/rcs/phone_numbers/client.rb

@@ -12,25 +12,17 @@ require_relative "../types/purchased_number"
 require_relative "types/phone_details_schema_level"
 require_relative "types/retrieve_phone_number_details_options"
 require_relative "types/phone_numbers_get_response"
-require_relative "campaign/client"
-require_relative "webhook/client"
 require "async"
 
 module Pinnacle
   class PhoneNumbersClient
     # @return [Pinnacle::RequestClient]
     attr_reader :request_client
-    # @return [Pinnacle::PhoneNumbers::CampaignClient]
-    attr_reader :campaign
-    # @return [Pinnacle::PhoneNumbers::WebhookClient]
-    attr_reader :webhook
 
     # @param request_client [Pinnacle::RequestClient]
     # @return [Pinnacle::PhoneNumbersClient]
     def initialize(request_client:)
       @request_client = request_client
-      @campaign = Pinnacle::PhoneNumbers::CampaignClient.new(request_client: request_client)
-      @webhook = Pinnacle::PhoneNumbers::WebhookClient.new(request_client: request_client)
     end
 
     # Search for available phone numbers that match your exact criteria.
@@ -187,17 +179,11 @@ module Pinnacle
   class AsyncPhoneNumbersClient
     # @return [Pinnacle::AsyncRequestClient]
     attr_reader :request_client
-    # @return [Pinnacle::PhoneNumbers::AsyncCampaignClient]
-    attr_reader :campaign
-    # @return [Pinnacle::PhoneNumbers::AsyncWebhookClient]
-    attr_reader :webhook
 
     # @param request_client [Pinnacle::AsyncRequestClient]
     # @return [Pinnacle::AsyncPhoneNumbersClient]
     def initialize(request_client:)
       @request_client = request_client
-      @campaign = Pinnacle::PhoneNumbers::AsyncCampaignClient.new(request_client: request_client)
-      @webhook = Pinnacle::PhoneNumbers::AsyncWebhookClient.new(request_client: request_client)
     end
 
     # Search for available phone numbers that match your exact criteria.

data/lib/rcs/phone_numbers/webhook/client.rb

@@ -24,7 +24,7 @@ module Pinnacle
       # @param phone [String] The phone number you want to attach the webhook to in E.164 format. Make sure it
       #  is url encoded (i.e. replace the leading + with %2B). <br>
       #  Must be a phone number that you own and have already [purchased](./buy) through
-      #  the API.
+      #  the API. A phone number can have multiple webhooks attached to it.
       # @param request [Pinnacle::Types::AttachWebhookByIdParams, Pinnacle::Types::CreateAndAttachWebhookByUrlParams]
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Types::ConfiguredWebhook]
@@ -34,7 +34,7 @@ module Pinnacle
       #    environment: Pinnacle::Environment::DEFAULT,
       #    api_key: "YOUR_API_KEY"
       #  )
-      #  api.phone_numbers.webhook.attach(phone: "%2B14155551234", request: { webhook_id: 1 })
+      #  api.phone_numbers.webhook.attach(phone: "%2B14155551234", request: { webhook_id: "wh_1234567890", event: MESSAGE_STATUS })
       def attach(phone:, request:, request_options: nil)
         response = @request_client.conn.post do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -62,10 +62,11 @@ module Pinnacle
       #  is url encoded (i.e. replace the leading + with %2B). <br>
       #  Must be a phone number that you own and currently has the specified webhook
       #  attached.
-      # @param webhook_id [Integer] The unique identifier of the webhook you want to detach from the phone number.
+      # @param webhook_id [String] The unique identifier of the webhook you want to detach from the phone number.
       #  <br>
       #  This must be a valid webhook ID that is currently attached to the specified
-      #  phone number.
+      #  phone number. This identifier is a string that always begins with the prefix
+      #  `wh_`, for example: `wh_1234567890`.
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Types::DetachedWebhookInfo]
       # @example
@@ -74,7 +75,7 @@ module Pinnacle
       #    environment: Pinnacle::Environment::DEFAULT,
       #    api_key: "YOUR_API_KEY"
       #  )
-      #  api.phone_numbers.webhook.detach(phone: "+14155551234", webhook_id: 123)
+      #  api.phone_numbers.webhook.detach(phone: "+14155551234", webhook_id: "wh_1234567890")
       def detach(phone:, webhook_id:, request_options: nil)
         response = @request_client.conn.delete do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -112,7 +113,7 @@ module Pinnacle
       # @param phone [String] The phone number you want to attach the webhook to in E.164 format. Make sure it
       #  is url encoded (i.e. replace the leading + with %2B). <br>
       #  Must be a phone number that you own and have already [purchased](./buy) through
-      #  the API.
+      #  the API. A phone number can have multiple webhooks attached to it.
       # @param request [Pinnacle::Types::AttachWebhookByIdParams, Pinnacle::Types::CreateAndAttachWebhookByUrlParams]
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Types::ConfiguredWebhook]
@@ -122,7 +123,7 @@ module Pinnacle
       #    environment: Pinnacle::Environment::DEFAULT,
       #    api_key: "YOUR_API_KEY"
       #  )
-      #  api.phone_numbers.webhook.attach(phone: "%2B14155551234", request: { webhook_id: 1 })
+      #  api.phone_numbers.webhook.attach(phone: "%2B14155551234", request: { webhook_id: "wh_1234567890", event: MESSAGE_STATUS })
       def attach(phone:, request:, request_options: nil)
         Async do
           response = @request_client.conn.post do |req|
@@ -152,10 +153,11 @@ module Pinnacle
       #  is url encoded (i.e. replace the leading + with %2B). <br>
       #  Must be a phone number that you own and currently has the specified webhook
       #  attached.
-      # @param webhook_id [Integer] The unique identifier of the webhook you want to detach from the phone number.
+      # @param webhook_id [String] The unique identifier of the webhook you want to detach from the phone number.
       #  <br>
       #  This must be a valid webhook ID that is currently attached to the specified
-      #  phone number.
+      #  phone number. This identifier is a string that always begins with the prefix
+      #  `wh_`, for example: `wh_1234567890`.
       # @param request_options [Pinnacle::RequestOptions]
       # @return [Pinnacle::Types::DetachedWebhookInfo]
       # @example
@@ -164,7 +166,7 @@ module Pinnacle
       #    environment: Pinnacle::Environment::DEFAULT,
       #    api_key: "YOUR_API_KEY"
       #  )
-      #  api.phone_numbers.webhook.detach(phone: "+14155551234", webhook_id: 123)
+      #  api.phone_numbers.webhook.detach(phone: "+14155551234", webhook_id: "wh_1234567890")
       def detach(phone:, webhook_id:, request_options: nil)
         Async do
           response = @request_client.conn.delete do |req|