sentdm 0.3.1 → 0.4.0

data/lib/sentdm/resources/templates.rb

@@ -11,7 +11,7 @@ module Sentdm
       # template can be submitted for review immediately or saved as draft for later
       # submission.
       #
-      # @overload create(category: nil, creation_source: nil, definition: nil, language: nil, submit_for_review: nil, test_mode: nil, idempotency_key: nil, request_options: {})
+      # @overload create(category: nil, creation_source: nil, definition: nil, language: nil, sandbox: nil, submit_for_review: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #
       # @param category [String, nil] Body param: Template category: MARKETING, UTILITY, AUTHENTICATION (optional, aut
       #
@@ -21,12 +21,14 @@ module Sentdm
       #
       # @param language [String, nil] Body param: Template language code (e.g., en_US) (optional, auto-detected if not
       #
-      # @param submit_for_review [Boolean] Body param: Whether to submit the template for review after creation (default: f
+      # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
       #
-      # @param test_mode [Boolean] Body param: Test mode flag - when true, the operation is simulated without side
+      # @param submit_for_review [Boolean] Body param: Whether to submit the template for review after creation (default: f
       #
       # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
       #
+      # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
+      #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Sentdm::Models::APIResponseTemplate]
@@ -34,7 +36,7 @@ module Sentdm
       # @see Sentdm::Models::TemplateCreateParams
       def create(params = {})
         parsed, options = Sentdm::TemplateCreateParams.dump_request(params)
-        header_params = {idempotency_key: "idempotency-key"}
+        header_params = {idempotency_key: "idempotency-key", x_profile_id: "x-profile-id"}
         @client.request(
           method: :post,
           path: "v3/templates",
@@ -45,24 +47,31 @@ module Sentdm
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Sentdm::Models::TemplateRetrieveParams} for more details.
+      #
       # Retrieves a specific template by its ID. Returns template details including
       # name, category, language, status, and definition.
       #
-      # @overload retrieve(id, request_options: {})
+      # @overload retrieve(id, x_profile_id: nil, request_options: {})
       #
       # @param id [String] Template ID from route parameter
       #
+      # @param x_profile_id [String] Profile UUID to scope the request to a child profile. Only organization API keys
+      #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Sentdm::Models::APIResponseTemplate]
       #
       # @see Sentdm::Models::TemplateRetrieveParams
       def retrieve(id, params = {})
+        parsed, options = Sentdm::TemplateRetrieveParams.dump_request(params)
         @client.request(
           method: :get,
           path: ["v3/templates/%1$s", id],
+          headers: parsed.transform_keys(x_profile_id: "x-profile-id"),
           model: Sentdm::APIResponseTemplate,
-          options: params[:request_options]
+          options: options
         )
       end
 
@@ -72,7 +81,7 @@ module Sentdm
       # Updates an existing template's name, category, language, definition, or submits
       # it for review.
       #
-      # @overload update(id, category: nil, definition: nil, language: nil, name: nil, submit_for_review: nil, test_mode: nil, idempotency_key: nil, request_options: {})
+      # @overload update(id, category: nil, definition: nil, language: nil, name: nil, sandbox: nil, submit_for_review: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #
       # @param id [String] Path param: Template ID from route parameter
       #
@@ -84,12 +93,14 @@ module Sentdm
       #
       # @param name [String, nil] Body param: Template display name
       #
-      # @param submit_for_review [Boolean] Body param: Whether to submit the template for review after updating (default: f
+      # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
       #
-      # @param test_mode [Boolean] Body param: Test mode flag - when true, the operation is simulated without side
+      # @param submit_for_review [Boolean] Body param: Whether to submit the template for review after updating (default: f
       #
       # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
       #
+      # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
+      #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Sentdm::Models::APIResponseTemplate]
@@ -97,7 +108,7 @@ module Sentdm
       # @see Sentdm::Models::TemplateUpdateParams
       def update(id, params = {})
         parsed, options = Sentdm::TemplateUpdateParams.dump_request(params)
-        header_params = {idempotency_key: "idempotency-key"}
+        header_params = {idempotency_key: "idempotency-key", x_profile_id: "x-profile-id"}
         @client.request(
           method: :put,
           path: ["v3/templates/%1$s", id],
@@ -108,20 +119,27 @@ module Sentdm
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Sentdm::Models::TemplateListParams} for more details.
+      #
       # Retrieves a paginated list of message templates for the authenticated customer.
       # Supports filtering by status, category, and search term.
       #
-      # @overload list(page:, page_size:, category: nil, search: nil, status: nil, request_options: {})
+      # @overload list(page:, page_size:, category: nil, is_welcome_playground: nil, search: nil, status: nil, x_profile_id: nil, request_options: {})
+      #
+      # @param page [Integer] Query param: Page number (1-indexed)
       #
-      # @param page [Integer] Page number (1-indexed)
+      # @param page_size [Integer] Query param: Number of items per page
       #
-      # @param page_size [Integer]
+      # @param category [String, nil] Query param: Optional category filter: MARKETING, UTILITY, AUTHENTICATION
       #
-      # @param category [String, nil] Optional category filter: MARKETING, UTILITY, AUTHENTICATION
+      # @param is_welcome_playground [Boolean, nil] Query param: Optional filter by welcome playground flag
       #
-      # @param search [String, nil] Optional search term for filtering templates
+      # @param search [String, nil] Query param: Optional search term for filtering templates
       #
-      # @param status [String, nil] Optional status filter: APPROVED, PENDING, REJECTED
+      # @param status [String, nil] Query param: Optional status filter: APPROVED, PENDING, REJECTED
+      #
+      # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -129,12 +147,14 @@ module Sentdm
       #
       # @see Sentdm::Models::TemplateListParams
       def list(params)
+        query_params = [:page, :page_size, :category, :is_welcome_playground, :search, :status]
         parsed, options = Sentdm::TemplateListParams.dump_request(params)
-        query = Sentdm::Internal::Util.encode_query_params(parsed)
+        query = Sentdm::Internal::Util.encode_query_params(parsed.slice(*query_params))
         @client.request(
           method: :get,
           path: "v3/templates",
-          query: query.transform_keys(page_size: "pageSize"),
+          query: query,
+          headers: parsed.except(*query_params).transform_keys(x_profile_id: "x-profile-id"),
           model: Sentdm::Models::TemplateListResponse,
           options: options
         )
@@ -146,13 +166,15 @@ module Sentdm
       # Deletes a template by ID. Optionally, you can also delete the template from
       # WhatsApp/Meta by setting delete_from_meta=true.
       #
-      # @overload delete(id, delete_from_meta: nil, test_mode: nil, request_options: {})
+      # @overload delete(id, delete_from_meta: nil, sandbox: nil, x_profile_id: nil, request_options: {})
       #
-      # @param id [String] Template ID from route parameter
+      # @param id [String] Path param: Template ID from route parameter
+      #
+      # @param delete_from_meta [Boolean, nil] Body param: Whether to also delete the template from WhatsApp/Meta (optional, de
       #
-      # @param delete_from_meta [Boolean, nil] Whether to also delete the template from WhatsApp/Meta (optional, defaults to fa
+      # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
       #
-      # @param test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
+      # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -161,11 +183,12 @@ module Sentdm
       # @see Sentdm::Models::TemplateDeleteParams
       def delete(id, params = {})
         parsed, options = Sentdm::TemplateDeleteParams.dump_request(params)
+        header_params = {x_profile_id: "x-profile-id"}
         @client.request(
           method: :delete,
           path: ["v3/templates/%1$s", id],
-          headers: {"content-type" => "*/*"},
-          body: parsed,
+          headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+          body: parsed.except(*header_params.keys),
           model: NilClass,
           options: options
         )

data/lib/sentdm/resources/users.rb

@@ -4,31 +4,44 @@ module Sentdm
   module Resources
     # Invite, update, and manage organization users and roles
     class Users
+      # Some parameter documentations has been truncated, see
+      # {Sentdm::Models::UserRetrieveParams} for more details.
+      #
       # Retrieves detailed information about a specific user in an organization or
       # profile. Requires developer role or higher.
       #
-      # @overload retrieve(user_id, request_options: {})
+      # @overload retrieve(user_id, x_profile_id: nil, request_options: {})
       #
       # @param user_id [String]
+      #
+      # @param x_profile_id [String] Profile UUID to scope the request to a child profile. Only organization API keys
+      #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Sentdm::Models::APIResponseOfUser]
       #
       # @see Sentdm::Models::UserRetrieveParams
       def retrieve(user_id, params = {})
+        parsed, options = Sentdm::UserRetrieveParams.dump_request(params)
         @client.request(
           method: :get,
           path: ["v3/users/%1$s", user_id],
+          headers: parsed.transform_keys(x_profile_id: "x-profile-id"),
           model: Sentdm::APIResponseOfUser,
-          options: params[:request_options]
+          options: options
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Sentdm::Models::UserListParams} for more details.
+      #
       # Retrieves all users who have access to the organization or profile identified by
       # the API key, including their roles and status. Shows invited users (pending
       # acceptance) and active users. Requires developer role or higher.
       #
-      # @overload list(request_options: {})
+      # @overload list(x_profile_id: nil, request_options: {})
+      #
+      # @param x_profile_id [String] Profile UUID to scope the request to a child profile. Only organization API keys
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -36,11 +49,13 @@ module Sentdm
       #
       # @see Sentdm::Models::UserListParams
       def list(params = {})
+        parsed, options = Sentdm::UserListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "v3/users",
+          headers: parsed.transform_keys(x_profile_id: "x-profile-id"),
           model: Sentdm::Models::UserListResponse,
-          options: params[:request_options]
+          options: options
         )
       end
 
@@ -51,7 +66,7 @@ module Sentdm
       # specific role. Requires admin role. The user will receive an invitation email
       # with a token to accept. Invitation tokens expire after 7 days.
       #
-      # @overload invite(email: nil, name: nil, role: nil, test_mode: nil, idempotency_key: nil, request_options: {})
+      # @overload invite(email: nil, name: nil, role: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #
       # @param email [String] Body param: User email address (required)
       #
@@ -59,10 +74,12 @@ module Sentdm
       #
       # @param role [String] Body param: User role: admin, billing, or developer (required)
       #
-      # @param test_mode [Boolean] Body param: Test mode flag - when true, the operation is simulated without side
+      # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
       #
       # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
       #
+      # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
+      #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Sentdm::Models::APIResponseOfUser]
@@ -70,7 +87,7 @@ module Sentdm
       # @see Sentdm::Models::UserInviteParams
       def invite(params = {})
         parsed, options = Sentdm::UserInviteParams.dump_request(params)
-        header_params = {idempotency_key: "idempotency-key"}
+        header_params = {idempotency_key: "idempotency-key", x_profile_id: "x-profile-id"}
         @client.request(
           method: :post,
           path: "v3/users",
@@ -87,26 +104,26 @@ module Sentdm
       # Removes a user's access to an organization or profile. Requires admin role. You
       # cannot remove yourself or remove the last admin.
       #
-      # @overload remove(path_user_id, test_mode: nil, body_user_id: nil, request_options: {})
+      # @overload remove(user_id, body:, x_profile_id: nil, request_options: {})
       #
-      # @param path_user_id [String]
+      # @param user_id [String] Path param
       #
-      # @param test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
+      # @param body [Sentdm::Models::UserRemoveParams::Body] Body param: Request to remove a user from an organization
       #
-      # @param body_user_id [String] User ID from route parameter
+      # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
       #
       # @see Sentdm::Models::UserRemoveParams
-      def remove(path_user_id, params = {})
+      def remove(user_id, params)
         parsed, options = Sentdm::UserRemoveParams.dump_request(params)
         @client.request(
           method: :delete,
-          path: ["v3/users/%1$s", path_user_id],
-          headers: {"content-type" => "*/*"},
-          body: parsed,
+          path: ["v3/users/%1$s", user_id],
+          headers: parsed.except(:body).transform_keys(x_profile_id: "x-profile-id"),
+          body: parsed[:body],
           model: NilClass,
           options: options
         )
@@ -118,29 +135,29 @@ module Sentdm
       # Updates a user's role in the organization or profile. Requires admin role. You
       # cannot change your own role or demote the last admin.
       #
-      # @overload update_role(path_user_id, role: nil, test_mode: nil, body_user_id: nil, idempotency_key: nil, request_options: {})
+      # @overload update_role(user_id, role: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #
-      # @param path_user_id [String] Path param
+      # @param user_id [String] Path param
       #
       # @param role [String] Body param: User role: admin, billing, or developer (required)
       #
-      # @param test_mode [Boolean] Body param: Test mode flag - when true, the operation is simulated without side
-      #
-      # @param body_user_id [String] Body param: User ID from route parameter
+      # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
       #
       # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
       #
+      # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
+      #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Sentdm::Models::APIResponseOfUser]
       #
       # @see Sentdm::Models::UserUpdateRoleParams
-      def update_role(path_user_id, params = {})
+      def update_role(user_id, params = {})
         parsed, options = Sentdm::UserUpdateRoleParams.dump_request(params)
-        header_params = {idempotency_key: "idempotency-key"}
+        header_params = {idempotency_key: "idempotency-key", x_profile_id: "x-profile-id"}
         @client.request(
           method: :patch,
-          path: ["v3/users/%1$s", path_user_id],
+          path: ["v3/users/%1$s", user_id],
           headers: parsed.slice(*header_params.keys).transform_keys(header_params),
           body: parsed.except(*header_params.keys),
           model: Sentdm::APIResponseOfUser,