trycourier 4.7.1 → 4.8.0

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

@@ -4,7 +4,7 @@ module Courier
   module Models
     module Users
       # @see Courier::Resources::Users::Tokens#add_single
-      class TokenAddSingleParams < Courier::Models::Users::UserToken
+      class TokenAddSingleParams < Courier::Internal::Type::BaseModel
         extend Courier::Internal::Type::RequestParameters::Converter
         include Courier::Internal::Type::RequestParameters
 
@@ -13,9 +13,175 @@ module Courier
         #   @return [String]
         required :user_id, String
 
-        # @!method initialize(user_id:, request_options: {})
+        # @!attribute token
+        #
+        #   @return [String]
+        required :token, String
+
+        # @!attribute provider_key
+        #
+        #   @return [Symbol, Courier::Models::Users::TokenAddSingleParams::ProviderKey]
+        required :provider_key, enum: -> { Courier::Users::TokenAddSingleParams::ProviderKey }
+
+        # @!attribute device
+        #   Information about the device the token came from.
+        #
+        #   @return [Courier::Models::Users::TokenAddSingleParams::Device, nil]
+        optional :device, -> { Courier::Users::TokenAddSingleParams::Device }, nil?: true
+
+        # @!attribute expiry_date
+        #   ISO 8601 formatted date the token expires. Defaults to 2 months. Set to false to
+        #   disable expiration.
+        #
+        #   @return [String, Boolean, nil]
+        optional :expiry_date, union: -> { Courier::Users::TokenAddSingleParams::ExpiryDate }, nil?: true
+
+        # @!attribute properties
+        #   Properties about the token.
+        #
+        #   @return [Object, nil]
+        optional :properties, Courier::Internal::Type::Unknown
+
+        # @!attribute tracking
+        #   Tracking information about the device the token came from.
+        #
+        #   @return [Courier::Models::Users::TokenAddSingleParams::Tracking, nil]
+        optional :tracking, -> { Courier::Users::TokenAddSingleParams::Tracking }, nil?: true
+
+        # @!method initialize(user_id:, token:, provider_key:, device: nil, expiry_date: nil, properties: nil, tracking: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Courier::Models::Users::TokenAddSingleParams} for more details.
+        #
         #   @param user_id [String]
+        #
+        #   @param token [String]
+        #
+        #   @param provider_key [Symbol, Courier::Models::Users::TokenAddSingleParams::ProviderKey]
+        #
+        #   @param device [Courier::Models::Users::TokenAddSingleParams::Device, nil] Information about the device the token came from.
+        #
+        #   @param expiry_date [String, Boolean, nil] ISO 8601 formatted date the token expires. Defaults to 2 months. Set to false to
+        #
+        #   @param properties [Object] Properties about the token.
+        #
+        #   @param tracking [Courier::Models::Users::TokenAddSingleParams::Tracking, nil] Tracking information about the device the token came from.
+        #
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+
+        module ProviderKey
+          extend Courier::Internal::Type::Enum
+
+          FIREBASE_FCM = :"firebase-fcm"
+          APN = :apn
+          EXPO = :expo
+          ONESIGNAL = :onesignal
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        class Device < Courier::Internal::Type::BaseModel
+          # @!attribute ad_id
+          #   Id of the advertising identifier
+          #
+          #   @return [String, nil]
+          optional :ad_id, String, nil?: true
+
+          # @!attribute app_id
+          #   Id of the application the token is used for
+          #
+          #   @return [String, nil]
+          optional :app_id, String, nil?: true
+
+          # @!attribute device_id
+          #   Id of the device the token is associated with
+          #
+          #   @return [String, nil]
+          optional :device_id, String, nil?: true
+
+          # @!attribute manufacturer
+          #   The device manufacturer
+          #
+          #   @return [String, nil]
+          optional :manufacturer, String, nil?: true
+
+          # @!attribute model
+          #   The device model
+          #
+          #   @return [String, nil]
+          optional :model, String, nil?: true
+
+          # @!attribute platform
+          #   The device platform i.e. android, ios, web
+          #
+          #   @return [String, nil]
+          optional :platform, String, nil?: true
+
+          # @!method initialize(ad_id: nil, app_id: nil, device_id: nil, manufacturer: nil, model: nil, platform: nil)
+          #   Information about the device the token came from.
+          #
+          #   @param ad_id [String, nil] Id of the advertising identifier
+          #
+          #   @param app_id [String, nil] Id of the application the token is used for
+          #
+          #   @param device_id [String, nil] Id of the device the token is associated with
+          #
+          #   @param manufacturer [String, nil] The device manufacturer
+          #
+          #   @param model [String, nil] The device model
+          #
+          #   @param platform [String, nil] The device platform i.e. android, ios, web
+        end
+
+        # ISO 8601 formatted date the token expires. Defaults to 2 months. Set to false to
+        # disable expiration.
+        module ExpiryDate
+          extend Courier::Internal::Type::Union
+
+          variant String
+
+          variant Courier::Internal::Type::Boolean
+
+          # @!method self.variants
+          #   @return [Array(String, Boolean)]
+        end
+
+        class Tracking < Courier::Internal::Type::BaseModel
+          # @!attribute ip
+          #   The IP address of the device
+          #
+          #   @return [String, nil]
+          optional :ip, String, nil?: true
+
+          # @!attribute lat
+          #   The latitude of the device
+          #
+          #   @return [String, nil]
+          optional :lat, String, nil?: true
+
+          # @!attribute long
+          #   The longitude of the device
+          #
+          #   @return [String, nil]
+          optional :long, String, nil?: true
+
+          # @!attribute os_version
+          #   The operating system version
+          #
+          #   @return [String, nil]
+          optional :os_version, String, nil?: true
+
+          # @!method initialize(ip: nil, lat: nil, long: nil, os_version: nil)
+          #   Tracking information about the device the token came from.
+          #
+          #   @param ip [String, nil] The IP address of the device
+          #
+          #   @param lat [String, nil] The latitude of the device
+          #
+          #   @param long [String, nil] The longitude of the device
+          #
+          #   @param os_version [String, nil] The operating system version
+        end
       end
     end
   end

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

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

data/lib/courier/models/users/token_list_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/token_retrieve_params.rb

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

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

@@ -13,13 +13,19 @@ module Courier
         #   @return [String]
         required :user_id, String
 
+        # @!attribute token
+        #
+        #   @return [String]
+        required :token, String
+
         # @!attribute patch
         #
         #   @return [Array<Courier::Models::Users::TokenUpdateParams::Patch>]
         required :patch, -> { Courier::Internal::Type::ArrayOf[Courier::Users::TokenUpdateParams::Patch] }
 
-        # @!method initialize(user_id:, patch:, request_options: {})
+        # @!method initialize(user_id:, token:, patch:, request_options: {})
         #   @param user_id [String]
+        #   @param token [String]
         #   @param patch [Array<Courier::Models::Users::TokenUpdateParams::Patch>]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
 

data/lib/courier/models.rb

@@ -179,6 +179,18 @@ module Courier
 
   IntercomRecipient = Courier::Models::IntercomRecipient
 
+  Journey = Courier::Models::Journey
+
+  JourneyInvokeParams = Courier::Models::JourneyInvokeParams
+
+  JourneyListParams = Courier::Models::JourneyListParams
+
+  JourneysInvokeRequest = Courier::Models::JourneysInvokeRequest
+
+  JourneysInvokeResponse = Courier::Models::JourneysInvokeResponse
+
+  JourneysListResponse = Courier::Models::JourneysListResponse
+
   ListDeleteParams = Courier::Models::ListDeleteParams
 
   ListFilter = Courier::Models::ListFilter

data/lib/courier/resources/audiences.rb

@@ -69,10 +69,11 @@ module Courier
       # @see Courier::Models::AudienceListParams
       def list(params = {})
         parsed, options = Courier::AudienceListParams.dump_request(params)
+        query = Courier::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "audiences",
-          query: parsed,
+          query: query,
           model: Courier::Models::AudienceListResponse,
           options: options
         )
@@ -113,10 +114,11 @@ module Courier
       # @see Courier::Models::AudienceListMembersParams
       def list_members(audience_id, params = {})
         parsed, options = Courier::AudienceListMembersParams.dump_request(params)
+        query = Courier::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["audiences/%1$s/members", audience_id],
-          query: parsed,
+          query: query,
           model: Courier::Models::AudienceListMembersResponse,
           options: options
         )

data/lib/courier/resources/audit_events.rb

@@ -36,10 +36,11 @@ module Courier
       # @see Courier::Models::AuditEventListParams
       def list(params = {})
         parsed, options = Courier::AuditEventListParams.dump_request(params)
+        query = Courier::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "audit-events",
-          query: parsed,
+          query: query,
           model: Courier::Models::AuditEventListResponse,
           options: options
         )

data/lib/courier/resources/automations.rb

@@ -24,10 +24,11 @@ module Courier
       # @see Courier::Models::AutomationListParams
       def list(params = {})
         parsed, options = Courier::AutomationListParams.dump_request(params)
+        query = Courier::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "automations",
-          query: parsed,
+          query: query,
           model: Courier::AutomationTemplateListResponse,
           options: options
         )

data/lib/courier/resources/brands.rb

@@ -82,10 +82,11 @@ module Courier
       # @see Courier::Models::BrandListParams
       def list(params = {})
         parsed, options = Courier::BrandListParams.dump_request(params)
+        query = Courier::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "brands",
-          query: parsed,
+          query: query,
           model: Courier::Models::BrandListResponse,
           options: options
         )

data/lib/courier/resources/bulk.rb

@@ -80,10 +80,11 @@ module Courier
       # @see Courier::Models::BulkListUsersParams
       def list_users(job_id, params = {})
         parsed, options = Courier::BulkListUsersParams.dump_request(params)
+        query = Courier::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["bulk/%1$s/users", job_id],
-          query: parsed,
+          query: query,
           model: Courier::Models::BulkListUsersResponse,
           options: options
         )

data/lib/courier/resources/journeys.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Courier
+  module Resources
+    class Journeys
+      # Some parameter documentations has been truncated, see
+      # {Courier::Models::JourneyListParams} for more details.
+      #
+      # Get the list of journeys.
+      #
+      # @overload list(cursor: nil, version: nil, request_options: {})
+      #
+      # @param cursor [String] A cursor token for pagination. Use the cursor from the previous response to fetc
+      #
+      # @param version [Symbol, Courier::Models::JourneyListParams::Version] The version of journeys to retrieve. Accepted values are published (for publishe
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::JourneysListResponse]
+      #
+      # @see Courier::Models::JourneyListParams
+      def list(params = {})
+        parsed, options = Courier::JourneyListParams.dump_request(params)
+        query = Courier::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "journeys",
+          query: query,
+          model: Courier::JourneysListResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Courier::Models::JourneyInvokeParams} for more details.
+      #
+      # Invoke a journey run from a journey template.
+      #
+      # @overload invoke(template_id, data: nil, profile: nil, user_id: nil, request_options: {})
+      #
+      # @param template_id [String] A unique identifier representing the journey template to be invoked. This could
+      #
+      # @param data [Hash{Symbol=>Object}] Data payload passed to the journey. The expected shape can be predefined using t
+      #
+      # @param profile [Hash{Symbol=>Object}] Profile data for the user. Can contain contact information (email, phone_number)
+      #
+      # @param user_id [String] A unique identifier for the user. If not provided, the system will attempt to re
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::JourneysInvokeResponse]
+      #
+      # @see Courier::Models::JourneyInvokeParams
+      def invoke(template_id, params = {})
+        parsed, options = Courier::JourneyInvokeParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["journeys/%1$s/invoke", template_id],
+          body: parsed,
+          model: Courier::JourneysInvokeResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Courier::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/courier/resources/lists/subscriptions.rb

@@ -19,10 +19,11 @@ module Courier
         # @see Courier::Models::Lists::SubscriptionListParams
         def list(list_id, params = {})
           parsed, options = Courier::Lists::SubscriptionListParams.dump_request(params)
+          query = Courier::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["lists/%1$s/subscriptions", list_id],
-            query: parsed,
+            query: query,
             model: Courier::Models::Lists::SubscriptionListResponse,
             options: options
           )

data/lib/courier/resources/lists.rb

@@ -70,10 +70,11 @@ module Courier
       # @see Courier::Models::ListListParams
       def list(params = {})
         parsed, options = Courier::ListListParams.dump_request(params)
+        query = Courier::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "lists",
-          query: parsed,
+          query: query,
           model: Courier::Models::ListListResponse,
           options: options
         )

data/lib/courier/resources/messages.rb

@@ -68,10 +68,11 @@ module Courier
       # @see Courier::Models::MessageListParams
       def list(params = {})
         parsed, options = Courier::MessageListParams.dump_request(params)
+        query = Courier::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "messages",
-          query: parsed.transform_keys(message_id: "messageId", trace_id: "traceId"),
+          query: query.transform_keys(message_id: "messageId", trace_id: "traceId"),
           model: Courier::Models::MessageListResponse,
           options: options
         )
@@ -139,10 +140,11 @@ module Courier
       # @see Courier::Models::MessageHistoryParams
       def history(message_id, params = {})
         parsed, options = Courier::MessageHistoryParams.dump_request(params)
+        query = Courier::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["messages/%1$s/history", message_id],
-          query: parsed,
+          query: query,
           model: Courier::Models::MessageHistoryResponse,
           options: options
         )

data/lib/courier/resources/notifications.rb

@@ -22,10 +22,11 @@ module Courier
       # @see Courier::Models::NotificationListParams
       def list(params = {})
         parsed, options = Courier::NotificationListParams.dump_request(params)
+        query = Courier::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "notifications",
-          query: parsed,
+          query: query,
           model: Courier::Models::NotificationListResponse,
           options: options
         )

data/lib/courier/resources/profiles/lists.rb

@@ -22,10 +22,11 @@ module Courier
         # @see Courier::Models::Profiles::ListRetrieveParams
         def retrieve(user_id, params = {})
           parsed, options = Courier::Profiles::ListRetrieveParams.dump_request(params)
+          query = Courier::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["profiles/%1$s/lists", user_id],
-            query: parsed,
+            query: query,
             model: Courier::Models::Profiles::ListRetrieveResponse,
             options: options
           )

data/lib/courier/resources/tenants/templates.rb

@@ -51,10 +51,11 @@ module Courier
         # @see Courier::Models::Tenants::TemplateListParams
         def list(tenant_id, params = {})
           parsed, options = Courier::Tenants::TemplateListParams.dump_request(params)
+          query = Courier::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["tenants/%1$s/templates", tenant_id],
-            query: parsed,
+            query: query,
             model: Courier::Models::Tenants::TemplateListResponse,
             options: options
           )

data/lib/courier/resources/tenants.rb

@@ -86,10 +86,11 @@ module Courier
       # @see Courier::Models::TenantListParams
       def list(params = {})
         parsed, options = Courier::TenantListParams.dump_request(params)
+        query = Courier::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "tenants",
-          query: parsed,
+          query: query,
           model: Courier::Models::TenantListResponse,
           options: options
         )
@@ -135,10 +136,11 @@ module Courier
       # @see Courier::Models::TenantListUsersParams
       def list_users(tenant_id, params = {})
         parsed, options = Courier::TenantListUsersParams.dump_request(params)
+        query = Courier::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["tenants/%1$s/users", tenant_id],
-          query: parsed,
+          query: query,
           model: Courier::Models::TenantListUsersResponse,
           options: options
         )

data/lib/courier/resources/users/preferences.rb

@@ -22,10 +22,11 @@ module Courier
         # @see Courier::Models::Users::PreferenceRetrieveParams
         def retrieve(user_id, params = {})
           parsed, options = Courier::Users::PreferenceRetrieveParams.dump_request(params)
+          query = Courier::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["users/%1$s/preferences", user_id],
-            query: parsed,
+            query: query,
             model: Courier::Models::Users::PreferenceRetrieveResponse,
             options: options
           )
@@ -51,6 +52,7 @@ module Courier
         # @see Courier::Models::Users::PreferenceRetrieveTopicParams
         def retrieve_topic(topic_id, params)
           parsed, options = Courier::Users::PreferenceRetrieveTopicParams.dump_request(params)
+          query = Courier::Internal::Util.encode_query_params(parsed)
           user_id =
             parsed.delete(:user_id) do
               raise ArgumentError.new("missing required path argument #{_1}")
@@ -58,7 +60,7 @@ module Courier
           @client.request(
             method: :get,
             path: ["users/%1$s/preferences/%2$s", user_id, topic_id],
-            query: parsed,
+            query: query,
             model: Courier::Models::Users::PreferenceRetrieveTopicResponse,
             options: options
           )
@@ -85,16 +87,17 @@ module Courier
         #
         # @see Courier::Models::Users::PreferenceUpdateOrCreateTopicParams
         def update_or_create_topic(topic_id, params)
+          query_params = [:tenant_id]
           parsed, options = Courier::Users::PreferenceUpdateOrCreateTopicParams.dump_request(params)
+          query = Courier::Internal::Util.encode_query_params(parsed.slice(*query_params))
           user_id =
             parsed.delete(:user_id) do
               raise ArgumentError.new("missing required path argument #{_1}")
             end
-          query_params = [:tenant_id]
           @client.request(
             method: :put,
             path: ["users/%1$s/preferences/%2$s", user_id, topic_id],
-            query: parsed.slice(*query_params),
+            query: query,
             body: parsed.except(*query_params),
             model: Courier::Models::Users::PreferenceUpdateOrCreateTopicResponse,
             options: options

data/lib/courier/resources/users/tenants.rb

@@ -24,10 +24,11 @@ module Courier
         # @see Courier::Models::Users::TenantListParams
         def list(user_id, params = {})
           parsed, options = Courier::Users::TenantListParams.dump_request(params)
+          query = Courier::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["users/%1$s/tenants", user_id],
-            query: parsed,
+            query: query,
             model: Courier::Models::Users::TenantListResponse,
             options: options
           )

data/lib/courier/resources/users/tokens.rb

@@ -133,30 +133,28 @@ module Courier
         #
         # Adds a single token to a user and overwrites a matching existing token.
         #
-        # @overload add_single(path_token, user_id:, body_token:, provider_key:, device: nil, expiry_date: nil, properties: nil, tracking: nil, request_options: {})
+        # @overload add_single(token, user_id:, provider_key:, device: nil, expiry_date: nil, properties: nil, tracking: nil, request_options: {})
         #
-        # @param path_token [String] Path param: The full token string.
+        # @param token [String] Path param: The full token string.
         #
         # @param user_id [String] Path param: The user's ID. This can be any uniquely identifiable string.
         #
-        # @param body_token [String] Body param: Full body of the token. Must match token in URL path parameter.
-        #
-        # @param provider_key [Symbol, Courier::Models::Users::UserToken::ProviderKey] Body param
+        # @param provider_key [Symbol, Courier::Models::Users::TokenAddSingleParams::ProviderKey] Body param
         #
-        # @param device [Courier::Models::Users::UserToken::Device, nil] Body param: Information about the device the token came from.
+        # @param device [Courier::Models::Users::TokenAddSingleParams::Device, nil] Body param: Information about the device the token came from.
         #
         # @param expiry_date [String, Boolean, nil] Body param: ISO 8601 formatted date the token expires. Defaults to 2 months. Set
         #
         # @param properties [Object] Body param: Properties about the token.
         #
-        # @param tracking [Courier::Models::Users::UserToken::Tracking, nil] Body param: Tracking information about the device the token came from.
+        # @param tracking [Courier::Models::Users::TokenAddSingleParams::Tracking, nil] Body param: Tracking information about the device the token came from.
         #
         # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [nil]
         #
         # @see Courier::Models::Users::TokenAddSingleParams
-        def add_single(path_token, params)
+        def add_single(token, params)
           parsed, options = Courier::Users::TokenAddSingleParams.dump_request(params)
           user_id =
             parsed.delete(:user_id) do
@@ -164,7 +162,7 @@ module Courier
             end
           @client.request(
             method: :put,
-            path: ["users/%1$s/tokens/%2$s", user_id, path_token],
+            path: ["users/%1$s/tokens/%2$s", user_id, token],
             body: parsed,
             model: NilClass,
             options: options