trycourier 3.1.3 → 3.4.0.pre.alpha0

data/lib/trycourier/resources/translations.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Resources
+    class Translations
+      # Some parameter documentations has been truncated, see
+      # {Trycourier::Models::TranslationRetrieveParams} for more details.
+      #
+      # Get translations by locale
+      #
+      # @overload retrieve(locale, domain:, request_options: {})
+      #
+      # @param locale [String] The locale you want to retrieve the translations for
+      #
+      # @param domain [String] The domain you want to retrieve translations for. Only `default` is supported at
+      #
+      # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [String]
+      #
+      # @see Trycourier::Models::TranslationRetrieveParams
+      def retrieve(locale, params)
+        parsed, options = Trycourier::TranslationRetrieveParams.dump_request(params)
+        domain =
+          parsed.delete(:domain) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        @client.request(
+          method: :get,
+          path: ["translations/%1$s/%2$s", domain, locale],
+          model: String,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Trycourier::Models::TranslationUpdateParams} for more details.
+      #
+      # Update a translation
+      #
+      # @overload update(locale, domain:, body:, request_options: {})
+      #
+      # @param locale [String] Path param: The locale you want to retrieve the translations for
+      #
+      # @param domain [String] Path param: The domain you want to retrieve translations for. Only `default` is
+      #
+      # @param body [String] Body param:
+      #
+      # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Trycourier::Models::TranslationUpdateParams
+      def update(locale, params)
+        parsed, options = Trycourier::TranslationUpdateParams.dump_request(params)
+        domain =
+          parsed.delete(:domain) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        @client.request(
+          method: :put,
+          path: ["translations/%1$s/%2$s", domain, locale],
+          body: parsed[:body],
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Trycourier::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

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

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Resources
+    class Users
+      class Preferences
+        # Some parameter documentations has been truncated, see
+        # {Trycourier::Models::Users::PreferenceRetrieveParams} for more details.
+        #
+        # Fetch all user preferences.
+        #
+        # @overload retrieve(user_id, tenant_id: nil, request_options: {})
+        #
+        # @param user_id [String] A unique identifier associated with the user whose preferences you wish to retri
+        #
+        # @param tenant_id [String, nil] Query the preferences of a user for this specific tenant context.
+        #
+        # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Trycourier::Models::Users::PreferenceRetrieveResponse]
+        #
+        # @see Trycourier::Models::Users::PreferenceRetrieveParams
+        def retrieve(user_id, params = {})
+          parsed, options = Trycourier::Users::PreferenceRetrieveParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: ["users/%1$s/preferences", user_id],
+            query: parsed,
+            model: Trycourier::Models::Users::PreferenceRetrieveResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Trycourier::Models::Users::PreferenceRetrieveTopicParams} for more details.
+        #
+        # Fetch user preferences for a specific subscription topic.
+        #
+        # @overload retrieve_topic(topic_id, user_id:, tenant_id: nil, request_options: {})
+        #
+        # @param topic_id [String] Path param: A unique identifier associated with a subscription topic.
+        #
+        # @param user_id [String] Path param: A unique identifier associated with the user whose preferences you w
+        #
+        # @param tenant_id [String, nil] Query param: Query the preferences of a user for this specific tenant context.
+        #
+        # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Trycourier::Models::Users::PreferenceRetrieveTopicResponse]
+        #
+        # @see Trycourier::Models::Users::PreferenceRetrieveTopicParams
+        def retrieve_topic(topic_id, params)
+          parsed, options = Trycourier::Users::PreferenceRetrieveTopicParams.dump_request(params)
+          user_id =
+            parsed.delete(:user_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :get,
+            path: ["users/%1$s/preferences/%2$s", user_id, topic_id],
+            query: parsed,
+            model: Trycourier::Models::Users::PreferenceRetrieveTopicResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Trycourier::Models::Users::PreferenceUpdateOrCreateTopicParams} for more
+        # details.
+        #
+        # Update or Create user preferences for a specific subscription topic.
+        #
+        # @overload update_or_create_topic(topic_id, user_id:, topic:, tenant_id: nil, request_options: {})
+        #
+        # @param topic_id [String] Path param: A unique identifier associated with a subscription topic.
+        #
+        # @param user_id [String] Path param: A unique identifier associated with the user whose preferences you w
+        #
+        # @param topic [Trycourier::Models::Users::PreferenceUpdateOrCreateTopicParams::Topic] Body param:
+        #
+        # @param tenant_id [String, nil] Query param: Update the preferences of a user for this specific tenant context.
+        #
+        # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Trycourier::Models::Users::PreferenceUpdateOrCreateTopicResponse]
+        #
+        # @see Trycourier::Models::Users::PreferenceUpdateOrCreateTopicParams
+        def update_or_create_topic(topic_id, params)
+          parsed, options = Trycourier::Users::PreferenceUpdateOrCreateTopicParams.dump_request(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),
+            body: parsed.except(*query_params),
+            model: Trycourier::Models::Users::PreferenceUpdateOrCreateTopicResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Trycourier::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Resources
+    class Users
+      class Tenants
+        # Some parameter documentations has been truncated, see
+        # {Trycourier::Models::Users::TenantListParams} for more details.
+        #
+        # Returns a paginated list of user tenant associations.
+        #
+        # @overload list(user_id, cursor: nil, limit: nil, request_options: {})
+        #
+        # @param user_id [String] Id of the user to retrieve all associated tenants for.
+        #
+        # @param cursor [String, nil] Continue the pagination with the next cursor
+        #
+        # @param limit [Integer, nil] The number of accounts to return
+        #
+        # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Trycourier::Models::Users::TenantListResponse]
+        #
+        # @see Trycourier::Models::Users::TenantListParams
+        def list(user_id, params = {})
+          parsed, options = Trycourier::Users::TenantListParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: ["users/%1$s/tenants", user_id],
+            query: parsed,
+            model: Trycourier::Models::Users::TenantListResponse,
+            options: options
+          )
+        end
+
+        # This endpoint is used to add a user to multiple tenants in one call. A custom
+        # profile can also be supplied for each tenant. This profile will be merged with
+        # the user's main profile when sending to the user with that tenant.
+        #
+        # @overload add_multiple(user_id, tenants:, request_options: {})
+        #
+        # @param user_id [String] The user's ID. This can be any uniquely identifiable string.
+        #
+        # @param tenants [Array<Trycourier::Models::TenantAssociation>]
+        #
+        # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Trycourier::Models::Users::TenantAddMultipleParams
+        def add_multiple(user_id, params)
+          parsed, options = Trycourier::Users::TenantAddMultipleParams.dump_request(params)
+          @client.request(
+            method: :put,
+            path: ["users/%1$s/tenants", user_id],
+            body: parsed,
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # This endpoint is used to add a single tenant.
+        #
+        # A custom profile can also be supplied with the tenant. This profile will be
+        # merged with the user's main profile when sending to the user with that tenant.
+        #
+        # @overload add_single(tenant_id, user_id:, profile: nil, request_options: {})
+        #
+        # @param tenant_id [String] Path param: Id of the tenant the user should be added to.
+        #
+        # @param user_id [String] Path param: Id of the user to be added to the supplied tenant.
+        #
+        # @param profile [Hash{Symbol=>Object}, nil] Body param:
+        #
+        # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Trycourier::Models::Users::TenantAddSingleParams
+        def add_single(tenant_id, params)
+          parsed, options = Trycourier::Users::TenantAddSingleParams.dump_request(params)
+          user_id =
+            parsed.delete(:user_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :put,
+            path: ["users/%1$s/tenants/%2$s", user_id, tenant_id],
+            body: parsed,
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # Removes a user from any tenants they may have been associated with.
+        #
+        # @overload remove_all(user_id, request_options: {})
+        #
+        # @param user_id [String] Id of the user to be removed from the supplied tenant.
+        #
+        # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Trycourier::Models::Users::TenantRemoveAllParams
+        def remove_all(user_id, params = {})
+          @client.request(
+            method: :delete,
+            path: ["users/%1$s/tenants", user_id],
+            model: NilClass,
+            options: params[:request_options]
+          )
+        end
+
+        # Removes a user from the supplied tenant.
+        #
+        # @overload remove_single(tenant_id, user_id:, request_options: {})
+        #
+        # @param tenant_id [String] Id of the tenant the user should be removed from.
+        #
+        # @param user_id [String] Id of the user to be removed from the supplied tenant.
+        #
+        # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Trycourier::Models::Users::TenantRemoveSingleParams
+        def remove_single(tenant_id, params)
+          parsed, options = Trycourier::Users::TenantRemoveSingleParams.dump_request(params)
+          user_id =
+            parsed.delete(:user_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :delete,
+            path: ["users/%1$s/tenants/%2$s", user_id, tenant_id],
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Trycourier::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Resources
+    class Users
+      class Tokens
+        # Get single token available for a `:token`
+        #
+        # @overload retrieve(token, user_id:, request_options: {})
+        #
+        # @param token [String] The full token string.
+        #
+        # @param user_id [String] The user's ID. This can be any uniquely identifiable string.
+        #
+        # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Trycourier::Models::Users::TokenRetrieveResponse]
+        #
+        # @see Trycourier::Models::Users::TokenRetrieveParams
+        def retrieve(token, params)
+          parsed, options = Trycourier::Users::TokenRetrieveParams.dump_request(params)
+          user_id =
+            parsed.delete(:user_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :get,
+            path: ["users/%1$s/tokens/%2$s", user_id, token],
+            model: Trycourier::Models::Users::TokenRetrieveResponse,
+            options: options
+          )
+        end
+
+        # Apply a JSON Patch (RFC 6902) to the specified token.
+        #
+        # @overload update(token, user_id:, patch:, request_options: {})
+        #
+        # @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 patch [Array<Trycourier::Models::Users::TokenUpdateParams::Patch>] Body param:
+        #
+        # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Trycourier::Models::Users::TokenUpdateParams
+        def update(token, params)
+          parsed, options = Trycourier::Users::TokenUpdateParams.dump_request(params)
+          user_id =
+            parsed.delete(:user_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :patch,
+            path: ["users/%1$s/tokens/%2$s", user_id, token],
+            body: parsed,
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # Gets all tokens available for a :user_id
+        #
+        # @overload list(user_id, request_options: {})
+        #
+        # @param user_id [String] The user's ID. This can be any uniquely identifiable string.
+        #
+        # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Array<Trycourier::Models::UserToken>]
+        #
+        # @see Trycourier::Models::Users::TokenListParams
+        def list(user_id, params = {})
+          @client.request(
+            method: :get,
+            path: ["users/%1$s/tokens", user_id],
+            model: Trycourier::Internal::Type::ArrayOf[Trycourier::UserToken],
+            options: params[:request_options]
+          )
+        end
+
+        # Delete User Token
+        #
+        # @overload delete(token, user_id:, request_options: {})
+        #
+        # @param token [String] The full token string.
+        #
+        # @param user_id [String] The user's ID. This can be any uniquely identifiable string.
+        #
+        # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Trycourier::Models::Users::TokenDeleteParams
+        def delete(token, params)
+          parsed, options = Trycourier::Users::TokenDeleteParams.dump_request(params)
+          user_id =
+            parsed.delete(:user_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :delete,
+            path: ["users/%1$s/tokens/%2$s", user_id, token],
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # Adds multiple tokens to a user and overwrites matching existing tokens.
+        #
+        # @overload add_multiple(user_id, request_options: {})
+        #
+        # @param user_id [String] The user's ID. This can be any uniquely identifiable string.
+        #
+        # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Trycourier::Models::Users::TokenAddMultipleParams
+        def add_multiple(user_id, params = {})
+          @client.request(
+            method: :put,
+            path: ["users/%1$s/tokens", user_id],
+            model: NilClass,
+            options: params[:request_options]
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Trycourier::Models::Users::TokenAddSingleParams} for more details.
+        #
+        # Adds a single token to a user and overwrites a matching existing token.
+        #
+        # @overload add_single(path_token, user_id:, provider_key:, body_token: nil, device: nil, expiry_date: nil, properties: nil, tracking: nil, request_options: {})
+        #
+        # @param path_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 provider_key [Symbol, Trycourier::Models::UserToken::ProviderKey] Body param:
+        #
+        # @param body_token [String, nil] Body param: Full body of the token. Must match token in URL.
+        #
+        # @param device [Trycourier::Models::UserToken::Device, nil] Body param: Information about the device the token is associated with.
+        #
+        # @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 sent to the provider along with the token
+        #
+        # @param tracking [Trycourier::Models::UserToken::Tracking, nil] Body param: Information about the device the token is associated with.
+        #
+        # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Trycourier::Models::Users::TokenAddSingleParams
+        def add_single(path_token, params)
+          parsed, options = Trycourier::Users::TokenAddSingleParams.dump_request(params)
+          user_id =
+            parsed.delete(:user_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :put,
+            path: ["users/%1$s/tokens/%2$s", user_id, path_token],
+            body: parsed,
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Trycourier::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/trycourier/resources/users.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Resources
+    class Users
+      # @return [Trycourier::Resources::Users::Preferences]
+      attr_reader :preferences
+
+      # @return [Trycourier::Resources::Users::Tenants]
+      attr_reader :tenants
+
+      # @return [Trycourier::Resources::Users::Tokens]
+      attr_reader :tokens
+
+      # @api private
+      #
+      # @param client [Trycourier::Client]
+      def initialize(client:)
+        @client = client
+        @preferences = Trycourier::Resources::Users::Preferences.new(client: client)
+        @tenants = Trycourier::Resources::Users::Tenants.new(client: client)
+        @tokens = Trycourier::Resources::Users::Tokens.new(client: client)
+      end
+    end
+  end
+end

data/lib/trycourier/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Trycourier
+  VERSION = "3.4.0.pre.alpha0"
+end