feat(api): manual updates

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 19
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/sent%2Fsent-dm-2526b6ca490323393bd93f041268aa85f1d36bed4a639ecb3e72e7cd6f51e40d.yml
 openapi_spec_hash: 9f1e88c960a9057b40df68c059b640b8
-config_hash: 094d0205ec5660f35d72c520c81ae8eb
+config_hash: 558220e713f3aff5906078014139c92d

README.md

@@ -26,11 +26,13 @@ gem "sent-dm", "~> 0.0.1"
 require "bundler/setup"
 require "sent_dm"
 
-sent_dm = SentDm::Client.new(
-  customer_auth_scheme: ENV["SENT_DM_CUSTOMER_AUTH_SCHEME"] # This is the default and can be omitted
-)
+sent_dm = SentDm::Client.new(api_key: "My API Key", sender_id: "My Sender ID")
 
-result = sent_dm.templates.delete("REPLACE_ME")
+result = sent_dm.messages.send_to_phone(
+  phone_number: "+1234567890",
+  template_id: "7ba7b820-9dad-11d1-80b4-00c04fd430c8",
+  x_sender_id: "00000000-0000-0000-0000-000000000000"
+)
 
 puts(result)
 ```
@@ -41,7 +43,11 @@ When the library is unable to connect to the API, or if the API returns a non-su
 
 ```ruby
 begin
-  template = sent_dm.templates.delete("REPLACE_ME")
+  message = sent_dm.messages.send_to_phone(
+    phone_number: "+1234567890",
+    template_id: "7ba7b820-9dad-11d1-80b4-00c04fd430c8",
+    x_sender_id: "00000000-0000-0000-0000-000000000000"
+  )
 rescue SentDm::Errors::APIConnectionError => e
   puts("The server could not be reached")
   puts(e.cause)  # an underlying Exception, likely raised within `net/http`
@@ -80,11 +86,18 @@ You can use the `max_retries` option to configure or disable this:
 ```ruby
 # Configure the default for all requests:
 sent_dm = SentDm::Client.new(
-  max_retries: 0 # default is 2
+  max_retries: 0, # default is 2
+  api_key: "My API Key",
+  sender_id: "My Sender ID"
 )
 
 # Or, configure per-request:
-sent_dm.templates.delete("REPLACE_ME", request_options: {max_retries: 5})
+sent_dm.messages.send_to_phone(
+  phone_number: "+1234567890",
+  template_id: "7ba7b820-9dad-11d1-80b4-00c04fd430c8",
+  x_sender_id: "00000000-0000-0000-0000-000000000000",
+  request_options: {max_retries: 5}
+)
 ```
 
 ### Timeouts
@@ -94,11 +107,18 @@ By default, requests will time out after 60 seconds. You can use the timeout opt
 ```ruby
 # Configure the default for all requests:
 sent_dm = SentDm::Client.new(
-  timeout: nil # default is 60
+  timeout: nil, # default is 60
+  api_key: "My API Key",
+  sender_id: "My Sender ID"
 )
 
 # Or, configure per-request:
-sent_dm.templates.delete("REPLACE_ME", request_options: {timeout: 5})
+sent_dm.messages.send_to_phone(
+  phone_number: "+1234567890",
+  template_id: "7ba7b820-9dad-11d1-80b4-00c04fd430c8",
+  x_sender_id: "00000000-0000-0000-0000-000000000000",
+  request_options: {timeout: 5}
+)
 ```
 
 On timeout, `SentDm::Errors::APITimeoutError` is raised.
@@ -129,8 +149,10 @@ Note: the `extra_` parameters of the same name overrides the documented paramete
 
 ```ruby
 result =
-  sent_dm.templates.delete(
-    "REPLACE_ME",
+  sent_dm.messages.send_to_phone(
+    phone_number: "+1234567890",
+    template_id: "7ba7b820-9dad-11d1-80b4-00c04fd430c8",
+    x_sender_id: "00000000-0000-0000-0000-000000000000",
     request_options: {
       extra_query: {my_query_parameter: value},
       extra_body: {my_body_parameter: value},
@@ -176,18 +198,30 @@ This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitio
 You can provide typesafe request parameters like so:
 
 ```ruby
-sent_dm.templates.delete("REPLACE_ME")
+sent_dm.messages.send_to_phone(
+  phone_number: "+1234567890",
+  template_id: "7ba7b820-9dad-11d1-80b4-00c04fd430c8",
+  x_sender_id: "00000000-0000-0000-0000-000000000000"
+)
 ```
 
 Or, equivalently:
 
 ```ruby
 # Hashes work, but are not typesafe:
-sent_dm.templates.delete("REPLACE_ME")
+sent_dm.messages.send_to_phone(
+  phone_number: "+1234567890",
+  template_id: "7ba7b820-9dad-11d1-80b4-00c04fd430c8",
+  x_sender_id: "00000000-0000-0000-0000-000000000000"
+)
 
 # You can also splat a full Params class:
-params = SentDm::TemplateDeleteParams.new
-sent_dm.templates.delete("REPLACE_ME", **params)
+params = SentDm::MessageSendToPhoneParams.new(
+  phone_number: "+1234567890",
+  template_id: "7ba7b820-9dad-11d1-80b4-00c04fd430c8",
+  x_sender_id: "00000000-0000-0000-0000-000000000000"
+)
+sent_dm.messages.send_to_phone(**params)
 ```
 
 ## Versioning

lib/sent_dm/client.rb

@@ -16,10 +16,10 @@ class Client < SentDm::Internal::Transport::BaseClient
     DEFAULT_MAX_RETRY_DELAY = 8.0
 
     # @return [String]
-    attr_reader :admin_auth_scheme
+    attr_reader :api_key
 
     # @return [String]
-    attr_reader :customer_auth_scheme
+    attr_reader :sender_id
 
     # @return [SentDm::Resources::Templates]
     attr_reader :templates
@@ -36,32 +36,11 @@ class Client < SentDm::Internal::Transport::BaseClient
     # @return [SentDm::Resources::Organizations]
     attr_reader :organizations
 
-    # @api private
-    #
-    # @return [Hash{String=>String}]
-    private def auth_headers
-      {**admin_authentication_scheme, **customer_authentication_scheme}
-    end
-
-    # @api private
-    #
-    # @return [Hash{String=>String}]
-    private def admin_authentication_scheme
-      {"x-api-key" => @admin_auth_scheme}
-    end
-
-    # @api private
-    #
-    # @return [Hash{String=>String}]
-    private def customer_authentication_scheme
-      {"x-sender-id" => @customer_auth_scheme}
-    end
-
     # Creates and returns a new client for interacting with the API.
     #
-    # @param admin_auth_scheme [String, nil] Defaults to `ENV["SENT_DM_ADMIN_AUTH_SCHEME"]`
+    # @param api_key [String, nil] Defaults to `ENV["SENT_DM_API_KEY"]`
     #
-    # @param customer_auth_scheme [String, nil] Defaults to `ENV["SENT_DM_CUSTOMER_AUTH_SCHEME"]`
+    # @param sender_id [String, nil] Defaults to `ENV["SENT_DM_SENDER_ID"]`
     #
     # @param base_url [String, nil] Override the default base URL for the API, e.g.,
     # `"https://api.example.com/v2/"`. Defaults to `ENV["SENT_DM_BASE_URL"]`
@@ -74,8 +53,8 @@ class Client < SentDm::Internal::Transport::BaseClient
     #
     # @param max_retry_delay [Float]
     def initialize(
-      admin_auth_scheme: ENV["SENT_DM_ADMIN_AUTH_SCHEME"],
-      customer_auth_scheme: ENV["SENT_DM_CUSTOMER_AUTH_SCHEME"],
+      api_key: ENV["SENT_DM_API_KEY"],
+      sender_id: ENV["SENT_DM_SENDER_ID"],
       base_url: ENV["SENT_DM_BASE_URL"],
       max_retries: self.class::DEFAULT_MAX_RETRIES,
       timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
@@ -84,15 +63,15 @@ def initialize(
     )
       base_url ||= "https://api.sent.dm"
 
-      if admin_auth_scheme.nil?
-        raise ArgumentError.new("admin_auth_scheme is required, and can be set via environ: \"SENT_DM_ADMIN_AUTH_SCHEME\"")
+      if api_key.nil?
+        raise ArgumentError.new("api_key is required, and can be set via environ: \"SENT_DM_API_KEY\"")
       end
-      if customer_auth_scheme.nil?
-        raise ArgumentError.new("customer_auth_scheme is required, and can be set via environ: \"SENT_DM_CUSTOMER_AUTH_SCHEME\"")
+      if sender_id.nil?
+        raise ArgumentError.new("sender_id is required, and can be set via environ: \"SENT_DM_SENDER_ID\"")
       end
 
-      @admin_auth_scheme = admin_auth_scheme.to_s
-      @customer_auth_scheme = customer_auth_scheme.to_s
+      @api_key = api_key.to_s
+      @sender_id = sender_id.to_s
 
       super(
         base_url: base_url,

lib/sent_dm/internal/transport/base_client.rb

@@ -215,11 +215,6 @@ def initialize(
           @max_retry_delay = max_retry_delay
         end
 
-        # @api private
-        #
-        # @return [Hash{String=>String}]
-        private def auth_headers = {}
-
         # @api private
         #
         # @return [String]
@@ -276,7 +271,6 @@ def initialize(
 
           headers = SentDm::Internal::Util.normalized_headers(
             @headers,
-            auth_headers,
             req[:headers].to_h,
             opts[:extra_headers].to_h
           )

lib/sent_dm/models/contact_list_params.rb

@@ -19,11 +19,25 @@ class ContactListParams < SentDm::Internal::Type::BaseModel
       #   @return [Integer]
       required :page_size, Integer
 
-      # @!method initialize(page:, page_size:, request_options: {})
+      # @!attribute x_api_key
+      #
+      #   @return [String]
+      required :x_api_key, String
+
+      # @!attribute x_sender_id
+      #
+      #   @return [String]
+      required :x_sender_id, String
+
+      # @!method initialize(page:, page_size:, x_api_key:, x_sender_id:, request_options: {})
       #   @param page [Integer] The page number (zero-indexed). Default is 0.
       #
       #   @param page_size [Integer] The number of items per page. Default is 20.
       #
+      #   @param x_api_key [String]
+      #
+      #   @param x_sender_id [String]
+      #
       #   @param request_options [SentDm::RequestOptions, Hash{Symbol=>Object}]
     end
   end

lib/sent_dm/models/contact_retrieve_by_phone_params.rb

@@ -13,9 +13,23 @@ class ContactRetrieveByPhoneParams < SentDm::Internal::Type::BaseModel
       #   @return [String]
       required :phone_number, String
 
-      # @!method initialize(phone_number:, request_options: {})
+      # @!attribute x_api_key
+      #
+      #   @return [String]
+      required :x_api_key, String
+
+      # @!attribute x_sender_id
+      #
+      #   @return [String]
+      required :x_sender_id, String
+
+      # @!method initialize(phone_number:, x_api_key:, x_sender_id:, request_options: {})
       #   @param phone_number [String] The phone number in international format (e.g., +1234567890)
       #
+      #   @param x_api_key [String]
+      #
+      #   @param x_sender_id [String]
+      #
       #   @param request_options [SentDm::RequestOptions, Hash{Symbol=>Object}]
     end
   end

lib/sent_dm/models/contact_retrieve_id_params.rb

@@ -13,9 +13,23 @@ class ContactRetrieveIDParams < SentDm::Internal::Type::BaseModel
       #   @return [String]
       required :id, String
 
-      # @!method initialize(id:, request_options: {})
+      # @!attribute x_api_key
+      #
+      #   @return [String]
+      required :x_api_key, String
+
+      # @!attribute x_sender_id
+      #
+      #   @return [String]
+      required :x_sender_id, String
+
+      # @!method initialize(id:, x_api_key:, x_sender_id:, request_options: {})
       #   @param id [String] The unique identifier (GUID) of the resource to retrieve
       #
+      #   @param x_api_key [String]
+      #
+      #   @param x_sender_id [String]
+      #
       #   @param request_options [SentDm::RequestOptions, Hash{Symbol=>Object}]
     end
   end

lib/sent_dm/models/message_retrieve_params.rb

@@ -7,7 +7,19 @@ class MessageRetrieveParams < SentDm::Internal::Type::BaseModel
       extend SentDm::Internal::Type::RequestParameters::Converter
       include SentDm::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute x_api_key
+      #
+      #   @return [String]
+      required :x_api_key, String
+
+      # @!attribute x_sender_id
+      #
+      #   @return [String]
+      required :x_sender_id, String
+
+      # @!method initialize(x_api_key:, x_sender_id:, request_options: {})
+      #   @param x_api_key [String]
+      #   @param x_sender_id [String]
       #   @param request_options [SentDm::RequestOptions, Hash{Symbol=>Object}]
     end
   end

lib/sent_dm/models/message_send_quick_message_params.rb

@@ -20,14 +20,28 @@ class MessageSendQuickMessageParams < SentDm::Internal::Type::BaseModel
       #   @return [String]
       required :phone_number, String, api_name: :phoneNumber
 
-      # @!method initialize(custom_message:, phone_number:, request_options: {})
+      # @!attribute x_api_key
+      #
+      #   @return [String]
+      required :x_api_key, String
+
+      # @!attribute x_sender_id
+      #
+      #   @return [String]
+      required :x_sender_id, String
+
+      # @!method initialize(custom_message:, phone_number:, x_api_key:, x_sender_id:, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {SentDm::Models::MessageSendQuickMessageParams} for more details.
       #
       #   @param custom_message [String] The custom message content to include in the template
       #
       #   @param phone_number [String] The phone number to send the message to, in international format (e.g., +1234567
       #
+      #   @param x_api_key [String]
+      #
+      #   @param x_sender_id [String]
+      #
       #   @param request_options [SentDm::RequestOptions, Hash{Symbol=>Object}]
     end
   end

lib/sent_dm/models/message_send_to_contact_params.rb

@@ -19,6 +19,16 @@ class MessageSendToContactParams < SentDm::Internal::Type::BaseModel
       #   @return [String]
       required :template_id, String, api_name: :templateId
 
+      # @!attribute x_api_key
+      #
+      #   @return [String]
+      required :x_api_key, String
+
+      # @!attribute x_sender_id
+      #
+      #   @return [String]
+      required :x_sender_id, String
+
       # @!attribute template_variables
       #   Optional key-value pairs of template variables to replace in the template body.
       #   For example, if your template contains "Hello {{name}}", you would provide {
@@ -30,14 +40,18 @@ class MessageSendToContactParams < SentDm::Internal::Type::BaseModel
                api_name: :templateVariables,
                nil?: true
 
-      # @!method initialize(contact_id:, template_id:, template_variables: nil, request_options: {})
+      # @!method initialize(contact_id:, template_id:, x_api_key:, x_sender_id:, template_variables: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {SentDm::Models::MessageSendToContactParams} for more details.
       #
       #   @param contact_id [String] The unique identifier of the contact to send the message to
       #
       #   @param template_id [String] The unique identifier of the template to use for the message
       #
+      #   @param x_api_key [String]
+      #
+      #   @param x_sender_id [String]
+      #
       #   @param template_variables [Hash{Symbol=>String}, nil] Optional key-value pairs of template variables to replace in the template body.
       #
       #   @param request_options [SentDm::RequestOptions, Hash{Symbol=>Object}]