trycourier 4.7.1 → 4.8.0

data/lib/courier/models/notifications/draft_retrieve_content_params.rb

@@ -8,7 +8,13 @@ module Courier
         extend Courier::Internal::Type::RequestParameters::Converter
         include Courier::Internal::Type::RequestParameters
 
-        # @!method initialize(request_options: {})
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:, request_options: {})
+        #   @param id [String]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/courier/models/profile_create_params.rb

@@ -7,12 +7,18 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
+      # @!attribute user_id
+      #
+      #   @return [String]
+      required :user_id, String
+
       # @!attribute profile
       #
       #   @return [Hash{Symbol=>Object}]
       required :profile, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown]
 
-      # @!method initialize(profile:, request_options: {})
+      # @!method initialize(user_id:, profile:, request_options: {})
+      #   @param user_id [String]
       #   @param profile [Hash{Symbol=>Object}]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/courier/models/profile_delete_params.rb

@@ -7,7 +7,13 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute user_id
+      #
+      #   @return [String]
+      required :user_id, String
+
+      # @!method initialize(user_id:, request_options: {})
+      #   @param user_id [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/courier/models/profile_replace_params.rb

@@ -7,12 +7,18 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
+      # @!attribute user_id
+      #
+      #   @return [String]
+      required :user_id, String
+
       # @!attribute profile
       #
       #   @return [Hash{Symbol=>Object}]
       required :profile, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown]
 
-      # @!method initialize(profile:, request_options: {})
+      # @!method initialize(user_id:, profile:, request_options: {})
+      #   @param user_id [String]
       #   @param profile [Hash{Symbol=>Object}]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/courier/models/profile_retrieve_params.rb

@@ -7,7 +7,13 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute user_id
+      #
+      #   @return [String]
+      required :user_id, String
+
+      # @!method initialize(user_id:, request_options: {})
+      #   @param user_id [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/courier/models/profile_update_params.rb

@@ -7,13 +7,20 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
+      # @!attribute user_id
+      #
+      #   @return [String]
+      required :user_id, String
+
       # @!attribute patch
       #   List of patch operations to apply to the profile.
       #
       #   @return [Array<Courier::Models::ProfileUpdateParams::Patch>]
       required :patch, -> { Courier::Internal::Type::ArrayOf[Courier::ProfileUpdateParams::Patch] }
 
-      # @!method initialize(patch:, request_options: {})
+      # @!method initialize(user_id:, patch:, request_options: {})
+      #   @param user_id [String]
+      #
       #   @param patch [Array<Courier::Models::ProfileUpdateParams::Patch>] List of patch operations to apply to the profile.
       #
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]

data/lib/courier/models/profiles/list_delete_params.rb

@@ -8,7 +8,13 @@ module Courier
         extend Courier::Internal::Type::RequestParameters::Converter
         include Courier::Internal::Type::RequestParameters
 
-        # @!method initialize(request_options: {})
+        # @!attribute user_id
+        #
+        #   @return [String]
+        required :user_id, String
+
+        # @!method initialize(user_id:, request_options: {})
+        #   @param user_id [String]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/courier/models/profiles/list_retrieve_params.rb

@@ -8,13 +8,20 @@ module Courier
         extend Courier::Internal::Type::RequestParameters::Converter
         include Courier::Internal::Type::RequestParameters
 
+        # @!attribute user_id
+        #
+        #   @return [String]
+        required :user_id, String
+
         # @!attribute cursor
         #   A unique identifier that allows for fetching the next set of message statuses.
         #
         #   @return [String, nil]
         optional :cursor, String, nil?: true
 
-        # @!method initialize(cursor: nil, request_options: {})
+        # @!method initialize(user_id:, cursor: nil, request_options: {})
+        #   @param user_id [String]
+        #
         #   @param cursor [String, nil] A unique identifier that allows for fetching the next set of message statuses.
         #
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]

data/lib/courier/models/profiles/list_subscribe_params.rb

@@ -8,12 +8,18 @@ module Courier
         extend Courier::Internal::Type::RequestParameters::Converter
         include Courier::Internal::Type::RequestParameters
 
+        # @!attribute user_id
+        #
+        #   @return [String]
+        required :user_id, String
+
         # @!attribute lists
         #
         #   @return [Array<Courier::Models::SubscribeToListsRequestItem>]
         required :lists, -> { Courier::Internal::Type::ArrayOf[Courier::SubscribeToListsRequestItem] }
 
-        # @!method initialize(lists:, request_options: {})
+        # @!method initialize(user_id:, lists:, request_options: {})
+        #   @param user_id [String]
         #   @param lists [Array<Courier::Models::SubscribeToListsRequestItem>]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
       end

data/lib/courier/models/request_archive_params.rb

@@ -7,7 +7,13 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute request_id
+      #
+      #   @return [String]
+      required :request_id, String
+
+      # @!method initialize(request_id:, request_options: {})
+      #   @param request_id [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/courier/models/tenant_delete_params.rb

@@ -7,7 +7,13 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute tenant_id
+      #
+      #   @return [String]
+      required :tenant_id, String
+
+      # @!method initialize(tenant_id:, request_options: {})
+      #   @param tenant_id [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/courier/models/tenant_list_users_params.rb

@@ -7,6 +7,11 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
+      # @!attribute tenant_id
+      #
+      #   @return [String]
+      required :tenant_id, String
+
       # @!attribute cursor
       #   Continue the pagination with the next cursor
       #
@@ -19,10 +24,12 @@ module Courier
       #   @return [Integer, nil]
       optional :limit, Integer, nil?: true
 
-      # @!method initialize(cursor: nil, limit: nil, request_options: {})
+      # @!method initialize(tenant_id:, cursor: nil, limit: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Courier::Models::TenantListUsersParams} for more details.
       #
+      #   @param tenant_id [String]
+      #
       #   @param cursor [String, nil] Continue the pagination with the next cursor
       #
       #   @param limit [Integer, nil] The number of accounts to return

data/lib/courier/models/tenant_retrieve_params.rb

@@ -7,7 +7,13 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute tenant_id
+      #
+      #   @return [String]
+      required :tenant_id, String
+
+      # @!method initialize(tenant_id:, request_options: {})
+      #   @param tenant_id [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/courier/models/tenant_update_params.rb

@@ -7,6 +7,11 @@ module Courier
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 
+      # @!attribute tenant_id
+      #
+      #   @return [String]
+      required :tenant_id, String
+
       # @!attribute name
       #   Name of the tenant.
       #
@@ -44,10 +49,12 @@ module Courier
       #   @return [Hash{Symbol=>Object}, nil]
       optional :user_profile, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown], nil?: true
 
-      # @!method initialize(name:, brand_id: nil, default_preferences: nil, parent_tenant_id: nil, properties: nil, user_profile: nil, request_options: {})
+      # @!method initialize(tenant_id:, name:, brand_id: nil, default_preferences: nil, parent_tenant_id: nil, properties: nil, user_profile: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Courier::Models::TenantUpdateParams} for more details.
       #
+      #   @param tenant_id [String]
+      #
       #   @param name [String] Name of the tenant.
       #
       #   @param brand_id [String, nil] Brand to be used for the account when one is not specified by the send call.

data/lib/courier/models/tenants/preferences/item_delete_params.rb

@@ -14,8 +14,14 @@ module Courier
           #   @return [String]
           required :tenant_id, String
 
-          # @!method initialize(tenant_id:, request_options: {})
+          # @!attribute topic_id
+          #
+          #   @return [String]
+          required :topic_id, String
+
+          # @!method initialize(tenant_id:, topic_id:, request_options: {})
           #   @param tenant_id [String]
+          #   @param topic_id [String]
           #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
         end
       end

data/lib/courier/models/tenants/preferences/item_update_params.rb

@@ -14,8 +14,14 @@ module Courier
           #   @return [String]
           required :tenant_id, String
 
-          # @!method initialize(tenant_id:, request_options: {})
+          # @!attribute topic_id
+          #
+          #   @return [String]
+          required :topic_id, String
+
+          # @!method initialize(tenant_id:, topic_id:, request_options: {})
           #   @param tenant_id [String]
+          #   @param topic_id [String]
           #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
         end
       end

data/lib/courier/models/tenants/template_list_params.rb

@@ -8,6 +8,11 @@ module Courier
         extend Courier::Internal::Type::RequestParameters::Converter
         include Courier::Internal::Type::RequestParameters
 
+        # @!attribute tenant_id
+        #
+        #   @return [String]
+        required :tenant_id, String
+
         # @!attribute cursor
         #   Continue the pagination with the next cursor
         #
@@ -20,7 +25,9 @@ module Courier
         #   @return [Integer, nil]
         optional :limit, Integer, nil?: true
 
-        # @!method initialize(cursor: nil, limit: nil, request_options: {})
+        # @!method initialize(tenant_id:, cursor: nil, limit: nil, request_options: {})
+        #   @param tenant_id [String]
+        #
         #   @param cursor [String, nil] Continue the pagination with the next cursor
         #
         #   @param limit [Integer, nil] The number of templates to return (defaults to 20, maximum value of 100)

data/lib/courier/models/tenants/template_publish_params.rb

@@ -13,8 +13,14 @@ module Courier
         #   @return [String]
         required :tenant_id, String
 
-        # @!method initialize(tenant_id:, request_options: {})
+        # @!attribute template_id
+        #
+        #   @return [String]
+        required :template_id, String
+
+        # @!method initialize(tenant_id:, template_id:, request_options: {})
         #   @param tenant_id [String]
+        #   @param template_id [String]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/courier/models/tenants/template_replace_params.rb

@@ -13,8 +13,14 @@ module Courier
         #   @return [String]
         required :tenant_id, String
 
-        # @!method initialize(tenant_id:, request_options: {})
+        # @!attribute template_id
+        #
+        #   @return [String]
+        required :template_id, String
+
+        # @!method initialize(tenant_id:, template_id:, request_options: {})
         #   @param tenant_id [String]
+        #   @param template_id [String]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/courier/models/tenants/template_retrieve_params.rb

@@ -13,8 +13,14 @@ module Courier
         #   @return [String]
         required :tenant_id, String
 
-        # @!method initialize(tenant_id:, request_options: {})
+        # @!attribute template_id
+        #
+        #   @return [String]
+        required :template_id, String
+
+        # @!method initialize(tenant_id:, template_id:, request_options: {})
         #   @param tenant_id [String]
+        #   @param template_id [String]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/courier/models/tenants/templates/version_retrieve_params.rb

@@ -19,9 +19,15 @@ module Courier
           #   @return [String]
           required :template_id, String
 
-          # @!method initialize(tenant_id:, template_id:, request_options: {})
+          # @!attribute version
+          #
+          #   @return [String]
+          required :version, String
+
+          # @!method initialize(tenant_id:, template_id:, version:, request_options: {})
           #   @param tenant_id [String]
           #   @param template_id [String]
+          #   @param version [String]
           #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
         end
       end

data/lib/courier/models/translation_retrieve_params.rb

@@ -12,8 +12,14 @@ module Courier
       #   @return [String]
       required :domain, String
 
-      # @!method initialize(domain:, request_options: {})
+      # @!attribute locale
+      #
+      #   @return [String]
+      required :locale, String
+
+      # @!method initialize(domain:, locale:, request_options: {})
       #   @param domain [String]
+      #   @param locale [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/courier/models/translation_update_params.rb

@@ -12,13 +12,19 @@ module Courier
       #   @return [String]
       required :domain, String
 
+      # @!attribute locale
+      #
+      #   @return [String]
+      required :locale, String
+
       # @!attribute body
       #
       #   @return [String]
       required :body, String
 
-      # @!method initialize(domain:, body:, request_options: {})
+      # @!method initialize(domain:, locale:, body:, request_options: {})
       #   @param domain [String]
+      #   @param locale [String]
       #   @param body [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/courier/models/users/preference_retrieve_params.rb

@@ -8,13 +8,20 @@ module Courier
         extend Courier::Internal::Type::RequestParameters::Converter
         include Courier::Internal::Type::RequestParameters
 
+        # @!attribute user_id
+        #
+        #   @return [String]
+        required :user_id, String
+
         # @!attribute tenant_id
         #   Query the preferences of a user for this specific tenant context.
         #
         #   @return [String, nil]
         optional :tenant_id, String, nil?: true
 
-        # @!method initialize(tenant_id: nil, request_options: {})
+        # @!method initialize(user_id:, tenant_id: nil, request_options: {})
+        #   @param user_id [String]
+        #
         #   @param tenant_id [String, nil] Query the preferences of a user for this specific tenant context.
         #
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]

data/lib/courier/models/users/preference_retrieve_topic_params.rb

@@ -13,15 +13,22 @@ module Courier
         #   @return [String]
         required :user_id, String
 
+        # @!attribute topic_id
+        #
+        #   @return [String]
+        required :topic_id, String
+
         # @!attribute tenant_id
         #   Query the preferences of a user for this specific tenant context.
         #
         #   @return [String, nil]
         optional :tenant_id, String, nil?: true
 
-        # @!method initialize(user_id:, tenant_id: nil, request_options: {})
+        # @!method initialize(user_id:, topic_id:, tenant_id: nil, request_options: {})
         #   @param user_id [String]
         #
+        #   @param topic_id [String]
+        #
         #   @param tenant_id [String, nil] Query the preferences of a user for this specific tenant context.
         #
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]

data/lib/courier/models/users/preference_update_or_create_topic_params.rb

@@ -13,6 +13,11 @@ module Courier
         #   @return [String]
         required :user_id, String
 
+        # @!attribute topic_id
+        #
+        #   @return [String]
+        required :topic_id, String
+
         # @!attribute topic
         #
         #   @return [Courier::Models::Users::PreferenceUpdateOrCreateTopicParams::Topic]
@@ -24,9 +29,11 @@ module Courier
         #   @return [String, nil]
         optional :tenant_id, String, nil?: true
 
-        # @!method initialize(user_id:, topic:, tenant_id: nil, request_options: {})
+        # @!method initialize(user_id:, topic_id:, topic:, tenant_id: nil, request_options: {})
         #   @param user_id [String]
         #
+        #   @param topic_id [String]
+        #
         #   @param topic [Courier::Models::Users::PreferenceUpdateOrCreateTopicParams::Topic]
         #
         #   @param tenant_id [String, nil] Update the preferences of a user for this specific tenant context.

data/lib/courier/models/users/tenant_add_multiple_params.rb

@@ -8,12 +8,18 @@ module Courier
         extend Courier::Internal::Type::RequestParameters::Converter
         include Courier::Internal::Type::RequestParameters
 
+        # @!attribute user_id
+        #
+        #   @return [String]
+        required :user_id, String
+
         # @!attribute tenants
         #
         #   @return [Array<Courier::Models::TenantAssociation>]
         required :tenants, -> { Courier::Internal::Type::ArrayOf[Courier::TenantAssociation] }
 
-        # @!method initialize(tenants:, request_options: {})
+        # @!method initialize(user_id:, tenants:, request_options: {})
+        #   @param user_id [String]
         #   @param tenants [Array<Courier::Models::TenantAssociation>]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
       end

data/lib/courier/models/users/tenant_add_single_params.rb

@@ -13,13 +13,19 @@ module Courier
         #   @return [String]
         required :user_id, String
 
+        # @!attribute tenant_id
+        #
+        #   @return [String]
+        required :tenant_id, String
+
         # @!attribute profile
         #
         #   @return [Hash{Symbol=>Object}, nil]
         optional :profile, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown], nil?: true
 
-        # @!method initialize(user_id:, profile: nil, request_options: {})
+        # @!method initialize(user_id:, tenant_id:, profile: nil, request_options: {})
         #   @param user_id [String]
+        #   @param tenant_id [String]
         #   @param profile [Hash{Symbol=>Object}, nil]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
       end

data/lib/courier/models/users/tenant_list_params.rb

@@ -8,6 +8,11 @@ module Courier
         extend Courier::Internal::Type::RequestParameters::Converter
         include Courier::Internal::Type::RequestParameters
 
+        # @!attribute user_id
+        #
+        #   @return [String]
+        required :user_id, String
+
         # @!attribute cursor
         #   Continue the pagination with the next cursor
         #
@@ -20,10 +25,12 @@ module Courier
         #   @return [Integer, nil]
         optional :limit, Integer, nil?: true
 
-        # @!method initialize(cursor: nil, limit: nil, request_options: {})
+        # @!method initialize(user_id:, cursor: nil, limit: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Courier::Models::Users::TenantListParams} for more details.
         #
+        #   @param user_id [String]
+        #
         #   @param cursor [String, nil] Continue the pagination with the next cursor
         #
         #   @param limit [Integer, nil] The number of accounts to return

data/lib/courier/models/users/tenant_remove_all_params.rb

@@ -8,7 +8,13 @@ module Courier
         extend Courier::Internal::Type::RequestParameters::Converter
         include Courier::Internal::Type::RequestParameters
 
-        # @!method initialize(request_options: {})
+        # @!attribute user_id
+        #
+        #   @return [String]
+        required :user_id, String
+
+        # @!method initialize(user_id:, request_options: {})
+        #   @param user_id [String]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/courier/models/users/tenant_remove_single_params.rb

@@ -13,8 +13,14 @@ module Courier
         #   @return [String]
         required :user_id, String
 
-        # @!method initialize(user_id:, request_options: {})
+        # @!attribute tenant_id
+        #
+        #   @return [String]
+        required :tenant_id, String
+
+        # @!method initialize(user_id:, tenant_id:, request_options: {})
         #   @param user_id [String]
+        #   @param tenant_id [String]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/courier/models/users/token_add_multiple_params.rb

@@ -8,7 +8,13 @@ module Courier
         extend Courier::Internal::Type::RequestParameters::Converter
         include Courier::Internal::Type::RequestParameters
 
-        # @!method initialize(request_options: {})
+        # @!attribute user_id
+        #
+        #   @return [String]
+        required :user_id, String
+
+        # @!method initialize(user_id:, request_options: {})
+        #   @param user_id [String]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
       end
     end