rcs 1.0.11 → 1.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54823c553a438bf89b954065743e15829ebf1db01eeb65ebe13f33cf30fe0fc4
-  data.tar.gz: d94b27635af230d827fab19c712e43ad64f764425f0b40de32e15a6cf04f80e4
+  metadata.gz: 7bcabdc33fdbabdd3b7cfc7978a324d98e093c8a0b07d39114785fbab248fd60
+  data.tar.gz: 7c1dd8ac26f8eca62e4c3a219cb5e1fc8d658ec61133251467a94daf5f13b525
 SHA512:
-  metadata.gz: 127be8e67306a2993e1285ff5df2ca04ad4765697e4a8ccc569ccd902168fad40e4fba41bca80fc92821b00d58a098957d1d37790694a50862da39f8483e9add
-  data.tar.gz: f119fc63551bf7909de5368c21be3ca59f3dd934c3e764b02113d0dea90dccb026458f1cdaa9723fa55352e9036a2839d004535ff3b3f56c371fdef28b388c29
+  metadata.gz: 9681f12bdeeab84a1a7e41be608aea3b3ca9c5c978aea029218ec5d91e0f1db9eb5bceab473249acc28b82dd8d5b016302f57d61d1e322b22978ca11b5a3b33b
+  data.tar.gz: a6b0153c40257cc2e1443cd4247c0cb572014dae19f970e70eb569c031018a7ee6f2d8e9d3ee8baec18b7c0c9b3711a7b387e497a0a638ef1e04f196152201f7

data/lib/rcs/send/client.rb

@@ -3,6 +3,7 @@
 require_relative "../../requests"
 require_relative "../types/card"
 require_relative "../types/action"
+require_relative "types/rcs_fallback"
 require_relative "types/send_rcs_response"
 require_relative "types/send_sms_response"
 require_relative "types/send_mms_response"
@@ -54,6 +55,12 @@ module Pinnacle
     #   * :lat_long (Hash)
     #     * :lat (Float)
     #     * :lng (Float)
+    # @param fallback [Hash] Request of type Pinnacle::Send::RcsFallback, as a Hash
+    #   * :from (String)
+    #   * :text (String)
+    #   * :media_urls (Array<String>)
+    # @param status_callback [String] Optional URL to receive a POST request when the message status changes. Read
+    #  more about status callbacks [here](/api-reference/receive-msg-statuses).
     # @param request_options [Pinnacle::RequestOptions]
     # @return [Pinnacle::Send::SendRcsResponse]
     # @example
@@ -63,7 +70,8 @@ module Pinnacle
     #    api_key: "YOUR_API_KEY"
     #  )
     #  api.send.rcs(from: "from", to: "to")
-    def rcs(from:, to:, text: nil, media_url: nil, cards: nil, quick_replies: nil, request_options: nil)
+    def rcs(from:, to:, text: nil, media_url: nil, cards: nil, quick_replies: nil, fallback: nil, status_callback: nil,
+            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?
         req.headers["PINNACLE-API-Key"] = request_options.api_key unless request_options&.api_key.nil?
@@ -82,7 +90,9 @@ module Pinnacle
           text: text,
           mediaUrl: media_url,
           cards: cards,
-          quickReplies: quick_replies
+          quickReplies: quick_replies,
+          fallback: fallback,
+          statusCallback: status_callback
         }.compact
         req.url "#{@request_client.get_url(request_options: request_options)}/send/rcs"
       end
@@ -94,6 +104,8 @@ module Pinnacle
     # @param to [String] The recipient's phone number in E.164 format (e.g., +12345678901).
     # @param from [String] The sender's phone number in E.164 format. Must be owned by the user.
     # @param text [String] The SMS message content (max 1600 characters).
+    # @param status_callback [String] Optional URL to receive a POST request when the message status changes. Read
+    #  more about status callbacks [here](/api-reference/receive-msg-statuses).
     # @param request_options [Pinnacle::RequestOptions]
     # @return [Pinnacle::Send::SendSmsResponse]
     # @example
@@ -107,7 +119,7 @@ module Pinnacle
     #    from: "from",
     #    text: "text"
     #  )
-    def sms(to:, from:, text:, request_options: nil)
+    def sms(to:, from:, text:, status_callback: nil, 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?
         req.headers["PINNACLE-API-Key"] = request_options.api_key unless request_options&.api_key.nil?
@@ -119,7 +131,13 @@ module Pinnacle
         unless request_options.nil? || request_options&.additional_query_parameters.nil?
           req.params = { **(request_options&.additional_query_parameters || {}) }.compact
         end
-        req.body = { **(request_options&.additional_body_parameters || {}), to: to, from: from, text: text }.compact
+        req.body = {
+          **(request_options&.additional_body_parameters || {}),
+          to: to,
+          from: from,
+          text: text,
+          statusCallback: status_callback
+        }.compact
         req.url "#{@request_client.get_url(request_options: request_options)}/send/sms"
       end
       Pinnacle::Send::SendSmsResponse.from_json(json_object: response.body)
@@ -133,6 +151,8 @@ module Pinnacle
     # @param media_urls [Array<String>] The URLs of media to include. `jpeg`, `jpg`, `gif`, and `png` file types are
     #  fully supported and have a size limit of 5 MB. 500 KB limit for other types. Up
     #  to 10 media URLs can be included.
+    # @param status_callback [String] Optional URL to receive a POST request when the message status changes. Read
+    #  more about status callbacks [here](/api-reference/receive-msg-statuses).
     # @param request_options [Pinnacle::RequestOptions]
     # @return [Pinnacle::Send::SendMmsResponse]
     # @example
@@ -146,7 +166,7 @@ module Pinnacle
     #    from: "from",
     #    media_urls: ["https://example.com/image1.jpg", "https://example.com/video.mp4"]
     #  )
-    def mms(to:, from:, media_urls:, text: nil, request_options: nil)
+    def mms(to:, from:, media_urls:, text: nil, status_callback: nil, 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?
         req.headers["PINNACLE-API-Key"] = request_options.api_key unless request_options&.api_key.nil?
@@ -163,7 +183,8 @@ module Pinnacle
           to: to,
           from: from,
           text: text,
-          mediaUrls: media_urls
+          mediaUrls: media_urls,
+          statusCallback: status_callback
         }.compact
         req.url "#{@request_client.get_url(request_options: request_options)}/send/mms"
       end
@@ -216,6 +237,12 @@ module Pinnacle
     #   * :lat_long (Hash)
     #     * :lat (Float)
     #     * :lng (Float)
+    # @param fallback [Hash] Request of type Pinnacle::Send::RcsFallback, as a Hash
+    #   * :from (String)
+    #   * :text (String)
+    #   * :media_urls (Array<String>)
+    # @param status_callback [String] Optional URL to receive a POST request when the message status changes. Read
+    #  more about status callbacks [here](/api-reference/receive-msg-statuses).
     # @param request_options [Pinnacle::RequestOptions]
     # @return [Pinnacle::Send::SendRcsResponse]
     # @example
@@ -225,7 +252,8 @@ module Pinnacle
     #    api_key: "YOUR_API_KEY"
     #  )
     #  api.send.rcs(from: "from", to: "to")
-    def rcs(from:, to:, text: nil, media_url: nil, cards: nil, quick_replies: nil, request_options: nil)
+    def rcs(from:, to:, text: nil, media_url: nil, cards: nil, quick_replies: nil, fallback: nil, status_callback: nil,
+            request_options: nil)
       Async do
         response = @request_client.conn.post do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -245,7 +273,9 @@ module Pinnacle
             text: text,
             mediaUrl: media_url,
             cards: cards,
-            quickReplies: quick_replies
+            quickReplies: quick_replies,
+            fallback: fallback,
+            statusCallback: status_callback
           }.compact
           req.url "#{@request_client.get_url(request_options: request_options)}/send/rcs"
         end
@@ -258,6 +288,8 @@ module Pinnacle
     # @param to [String] The recipient's phone number in E.164 format (e.g., +12345678901).
     # @param from [String] The sender's phone number in E.164 format. Must be owned by the user.
     # @param text [String] The SMS message content (max 1600 characters).
+    # @param status_callback [String] Optional URL to receive a POST request when the message status changes. Read
+    #  more about status callbacks [here](/api-reference/receive-msg-statuses).
     # @param request_options [Pinnacle::RequestOptions]
     # @return [Pinnacle::Send::SendSmsResponse]
     # @example
@@ -271,7 +303,7 @@ module Pinnacle
     #    from: "from",
     #    text: "text"
     #  )
-    def sms(to:, from:, text:, request_options: nil)
+    def sms(to:, from:, text:, status_callback: nil, request_options: nil)
       Async do
         response = @request_client.conn.post do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -284,7 +316,13 @@ module Pinnacle
           unless request_options.nil? || request_options&.additional_query_parameters.nil?
             req.params = { **(request_options&.additional_query_parameters || {}) }.compact
           end
-          req.body = { **(request_options&.additional_body_parameters || {}), to: to, from: from, text: text }.compact
+          req.body = {
+            **(request_options&.additional_body_parameters || {}),
+            to: to,
+            from: from,
+            text: text,
+            statusCallback: status_callback
+          }.compact
           req.url "#{@request_client.get_url(request_options: request_options)}/send/sms"
         end
         Pinnacle::Send::SendSmsResponse.from_json(json_object: response.body)
@@ -299,6 +337,8 @@ module Pinnacle
     # @param media_urls [Array<String>] The URLs of media to include. `jpeg`, `jpg`, `gif`, and `png` file types are
     #  fully supported and have a size limit of 5 MB. 500 KB limit for other types. Up
     #  to 10 media URLs can be included.
+    # @param status_callback [String] Optional URL to receive a POST request when the message status changes. Read
+    #  more about status callbacks [here](/api-reference/receive-msg-statuses).
     # @param request_options [Pinnacle::RequestOptions]
     # @return [Pinnacle::Send::SendMmsResponse]
     # @example
@@ -312,7 +352,7 @@ module Pinnacle
     #    from: "from",
     #    media_urls: ["https://example.com/image1.jpg", "https://example.com/video.mp4"]
     #  )
-    def mms(to:, from:, media_urls:, text: nil, request_options: nil)
+    def mms(to:, from:, media_urls:, text: nil, status_callback: nil, request_options: nil)
       Async do
         response = @request_client.conn.post do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -330,7 +370,8 @@ module Pinnacle
             to: to,
             from: from,
             text: text,
-            mediaUrls: media_urls
+            mediaUrls: media_urls,
+            statusCallback: status_callback
           }.compact
           req.url "#{@request_client.get_url(request_options: request_options)}/send/mms"
         end

data/lib/rcs/send/types/rcs_fallback.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Pinnacle
+  class Send
+    class RcsFallback
+      # @return [String] The sender's phone number in E.164 format. Must be owned by the user.
+      attr_reader :from
+      # @return [String] The fallback message content (max 1600 characters). One of 'text' or 'mediaUrls'
+      #  must be provided.
+      attr_reader :text
+      # @return [Array<String>] The URLs of media to include. One of 'text' or 'mediaUrls' must be provided.
+      #  `jpeg`, `jpg`, `gif`, and `png` file types are fully supported and have a size
+      #  limit of 5 MB. 500 KB limit for other types. Up to 10 media URLs can be
+      #  included.
+      attr_reader :media_urls
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param from [String] The sender's phone number in E.164 format. Must be owned by the user.
+      # @param text [String] The fallback message content (max 1600 characters). One of 'text' or 'mediaUrls'
+      #  must be provided.
+      # @param media_urls [Array<String>] The URLs of media to include. One of 'text' or 'mediaUrls' must be provided.
+      #  `jpeg`, `jpg`, `gif`, and `png` file types are fully supported and have a size
+      #  limit of 5 MB. 500 KB limit for other types. Up to 10 media URLs can be
+      #  included.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Pinnacle::Send::RcsFallback]
+      def initialize(from: OMIT, text: OMIT, media_urls: OMIT, additional_properties: nil)
+        @from = from if from != OMIT
+        @text = text if text != OMIT
+        @media_urls = media_urls if media_urls != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "from": from, "text": text, "mediaUrls": media_urls }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of RcsFallback
+      #
+      # @param json_object [String]
+      # @return [Pinnacle::Send::RcsFallback]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        from = parsed_json["from"]
+        text = parsed_json["text"]
+        media_urls = parsed_json["mediaUrls"]
+        new(
+          from: from,
+          text: text,
+          media_urls: media_urls,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of RcsFallback to a JSON object
+      #
+      # @return [String]
+      def to_json(*_args)
+        @_field_set&.to_json
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given
+      #  hash and check each fields type against the current object's property
+      #  definitions.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        obj.from&.is_a?(String) != false || raise("Passed value for field obj.from is not the expected type, validation failed.")
+        obj.text&.is_a?(String) != false || raise("Passed value for field obj.text is not the expected type, validation failed.")
+        obj.media_urls&.is_a?(Array) != false || raise("Passed value for field obj.media_urls is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/rcs/types/action.rb

@@ -19,11 +19,15 @@ module Pinnacle
     #  URL to open. For 'call', the payload is the phone number to dial. For 'trigger',
     #  the payload is the predefined payload to send to the webhook.
     attr_reader :payload
-    # @return [String] Optional metadata. This is sent alongside the payload to the webhook.
+    # @return [String] Optional metadata. Only used for type 'trigger' ignored for other action types.
+    #  When the user presses the action, the metadata is sent to the webhook alongside
+    #  the payload.
     attr_reader :metadata
-    # @return [String] Start time for events. Required for 'scheduleEvent'.
+    # @return [String] Start time for events in ISO 8601 format. For example, '2022-01-01T12:00:00Z'.
+    #  Required for 'scheduleEvent'.
     attr_reader :event_start_time
-    # @return [String] End time for events. Required for 'scheduleEvent'.
+    # @return [String] End time for events in ISO 8601 format. For example, '2022-01-01T12:00:00Z'.
+    #  Required for 'scheduleEvent'.
     attr_reader :event_end_time
     # @return [String] Event title. Required for 'scheduleEvent'.
     attr_reader :event_title
@@ -48,9 +52,13 @@ module Pinnacle
     #  fields for the action type and is required. For 'openUrl', the payload is the
     #  URL to open. For 'call', the payload is the phone number to dial. For 'trigger',
     #  the payload is the predefined payload to send to the webhook.
-    # @param metadata [String] Optional metadata. This is sent alongside the payload to the webhook.
-    # @param event_start_time [String] Start time for events. Required for 'scheduleEvent'.
-    # @param event_end_time [String] End time for events. Required for 'scheduleEvent'.
+    # @param metadata [String] Optional metadata. Only used for type 'trigger' ignored for other action types.
+    #  When the user presses the action, the metadata is sent to the webhook alongside
+    #  the payload.
+    # @param event_start_time [String] Start time for events in ISO 8601 format. For example, '2022-01-01T12:00:00Z'.
+    #  Required for 'scheduleEvent'.
+    # @param event_end_time [String] End time for events in ISO 8601 format. For example, '2022-01-01T12:00:00Z'.
+    #  Required for 'scheduleEvent'.
     # @param event_title [String] Event title. Required for 'scheduleEvent'.
     # @param event_description [String] Optional event description.
     # @param lat_long [Pinnacle::ActionLatLong] Latitude and longitude coordinates. Required for 'sendLocation'.

data/lib/requests.rb

@@ -43,7 +43,7 @@ module Pinnacle
 
     # @return [Hash{String => String}]
     def get_headers
-      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "rcs", "X-Fern-SDK-Version": "1.0.11" }
+      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "rcs", "X-Fern-SDK-Version": "1.0.12" }
       headers["PINNACLE-API-Key"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
       headers
     end
@@ -87,7 +87,7 @@ module Pinnacle
 
     # @return [Hash{String => String}]
     def get_headers
-      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "rcs", "X-Fern-SDK-Version": "1.0.11" }
+      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "rcs", "X-Fern-SDK-Version": "1.0.12" }
       headers["PINNACLE-API-Key"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
       headers
     end

data/lib/types_export.rb

@@ -4,6 +4,7 @@ require_relative "rcs/company/types/company_register_response_brand"
 require_relative "rcs/company/types/company_register_response"
 require_relative "rcs/company/types/company_update_response_brand"
 require_relative "rcs/company/types/company_update_response"
+require_relative "rcs/send/types/rcs_fallback"
 require_relative "rcs/send/types/send_rcs_response"
 require_relative "rcs/send/types/send_sms_response"
 require_relative "rcs/send/types/send_mms_response"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rcs
 version: !ruby/object:Gem::Version
-  version: 1.0.11
+  version: 1.0.12
 platform: ruby
 authors:
 - ''
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-10-22 00:00:00.000000000 Z
+date: 2024-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http-faraday
@@ -105,6 +105,7 @@ files:
 - lib/rcs/company/types/company_update_response.rb
 - lib/rcs/company/types/company_update_response_brand.rb
 - lib/rcs/send/client.rb
+- lib/rcs/send/types/rcs_fallback.rb
 - lib/rcs/send/types/send_mms_response.rb
 - lib/rcs/send/types/send_rcs_response.rb
 - lib/rcs/send/types/send_sms_response.rb