trycourier 3.1.4 → 3.4.0.pre.alpha0

data/lib/trycourier/models/translation_retrieve_response.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    TranslationRetrieveResponse = String
+  end
+end

data/lib/trycourier/models/translation_update_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    # @see Trycourier::Resources::Translations#update
+    class TranslationUpdateParams < Trycourier::Internal::Type::BaseModel
+      extend Trycourier::Internal::Type::RequestParameters::Converter
+      include Trycourier::Internal::Type::RequestParameters
+
+      # @!attribute domain
+      #
+      #   @return [String]
+      required :domain, String
+
+      # @!attribute body
+      #
+      #   @return [String]
+      required :body, String
+
+      # @!method initialize(domain:, body:, request_options: {})
+      #   @param domain [String]
+      #   @param body [String]
+      #   @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/trycourier/models/user_recipient.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class UserRecipient < Trycourier::Internal::Type::BaseModel
+      # @!attribute account_id
+      #   Use `tenant_id` instead.
+      #
+      #   @return [String, nil]
+      optional :account_id, String, nil?: true
+
+      # @!attribute context
+      #   Context such as tenant_id to send the notification with.
+      #
+      #   @return [Trycourier::Models::MessageContext, nil]
+      optional :context, -> { Trycourier::MessageContext }, nil?: true
+
+      # @!attribute data
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :data, Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::Unknown], nil?: true
+
+      # @!attribute email
+      #   The user's email address.
+      #
+      #   @return [String, nil]
+      optional :email, String, nil?: true
+
+      # @!attribute locale
+      #   The user's preferred ISO 639-1 language code.
+      #
+      #   @return [String, nil]
+      optional :locale, String, nil?: true
+
+      # @!attribute phone_number
+      #   The user's phone number.
+      #
+      #   @return [String, nil]
+      optional :phone_number, String, nil?: true
+
+      # @!attribute preferences
+      #
+      #   @return [Trycourier::Models::UserRecipient::Preferences, nil]
+      optional :preferences, -> { Trycourier::UserRecipient::Preferences }, nil?: true
+
+      # @!attribute tenant_id
+      #   The id of the tenant the user is associated with.
+      #
+      #   @return [String, nil]
+      optional :tenant_id, String, nil?: true
+
+      # @!attribute user_id
+      #   The user's unique identifier. Typically, this will match the user id of a user
+      #   in your system.
+      #
+      #   @return [String, nil]
+      optional :user_id, String, nil?: true
+
+      # @!method initialize(account_id: nil, context: nil, data: nil, email: nil, locale: nil, phone_number: nil, preferences: nil, tenant_id: nil, user_id: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Trycourier::Models::UserRecipient} for more details.
+      #
+      #   @param account_id [String, nil] Use `tenant_id` instead.
+      #
+      #   @param context [Trycourier::Models::MessageContext, nil] Context such as tenant_id to send the notification with.
+      #
+      #   @param data [Hash{Symbol=>Object}, nil]
+      #
+      #   @param email [String, nil] The user's email address.
+      #
+      #   @param locale [String, nil] The user's preferred ISO 639-1 language code.
+      #
+      #   @param phone_number [String, nil] The user's phone number.
+      #
+      #   @param preferences [Trycourier::Models::UserRecipient::Preferences, nil]
+      #
+      #   @param tenant_id [String, nil] The id of the tenant the user is associated with.
+      #
+      #   @param user_id [String, nil] The user's unique identifier. Typically, this will match the user id of a user i
+
+      # @see Trycourier::Models::UserRecipient#preferences
+      class Preferences < Trycourier::Internal::Type::BaseModel
+        # @!attribute notifications
+        #
+        #   @return [Hash{Symbol=>Trycourier::Models::Preference}]
+        required :notifications, -> { Trycourier::Internal::Type::HashOf[Trycourier::Preference] }
+
+        # @!attribute categories
+        #
+        #   @return [Hash{Symbol=>Trycourier::Models::Preference}, nil]
+        optional :categories, -> { Trycourier::Internal::Type::HashOf[Trycourier::Preference] }, nil?: true
+
+        # @!attribute template_id
+        #
+        #   @return [String, nil]
+        optional :template_id, String, api_name: :templateId, nil?: true
+
+        # @!method initialize(notifications:, categories: nil, template_id: nil)
+        #   @param notifications [Hash{Symbol=>Trycourier::Models::Preference}]
+        #   @param categories [Hash{Symbol=>Trycourier::Models::Preference}, nil]
+        #   @param template_id [String, nil]
+      end
+    end
+  end
+end

data/lib/trycourier/models/user_token.rb

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class UserToken < Trycourier::Internal::Type::BaseModel
+      # @!attribute provider_key
+      #
+      #   @return [Symbol, Trycourier::Models::UserToken::ProviderKey]
+      required :provider_key, enum: -> { Trycourier::UserToken::ProviderKey }
+
+      # @!attribute token
+      #   Full body of the token. Must match token in URL.
+      #
+      #   @return [String, nil]
+      optional :token, String, nil?: true
+
+      # @!attribute device
+      #   Information about the device the token is associated with.
+      #
+      #   @return [Trycourier::Models::UserToken::Device, nil]
+      optional :device, -> { Trycourier::UserToken::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: -> { Trycourier::UserToken::ExpiryDate }, nil?: true
+
+      # @!attribute properties
+      #   Properties sent to the provider along with the token
+      #
+      #   @return [Object, nil]
+      optional :properties, Trycourier::Internal::Type::Unknown
+
+      # @!attribute tracking
+      #   Information about the device the token is associated with.
+      #
+      #   @return [Trycourier::Models::UserToken::Tracking, nil]
+      optional :tracking, -> { Trycourier::UserToken::Tracking }, nil?: true
+
+      # @!method initialize(provider_key:, token: nil, device: nil, expiry_date: nil, properties: nil, tracking: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Trycourier::Models::UserToken} for more details.
+      #
+      #   @param provider_key [Symbol, Trycourier::Models::UserToken::ProviderKey]
+      #
+      #   @param token [String, nil] Full body of the token. Must match token in URL.
+      #
+      #   @param device [Trycourier::Models::UserToken::Device, nil] Information about the device the token is associated with.
+      #
+      #   @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 sent to the provider along with the token
+      #
+      #   @param tracking [Trycourier::Models::UserToken::Tracking, nil] Information about the device the token is associated with.
+
+      # @see Trycourier::Models::UserToken#provider_key
+      module ProviderKey
+        extend Trycourier::Internal::Type::Enum
+
+        FIREBASE_FCM = :"firebase-fcm"
+        APN = :apn
+        EXPO = :expo
+        ONESIGNAL = :onesignal
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Trycourier::Models::UserToken#device
+      class Device < Trycourier::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 is associated with.
+        #
+        #   @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.
+      #
+      # @see Trycourier::Models::UserToken#expiry_date
+      module ExpiryDate
+        extend Trycourier::Internal::Type::Union
+
+        variant String
+
+        variant Trycourier::Internal::Type::Boolean
+
+        # @!method self.variants
+        #   @return [Array(String, Boolean)]
+      end
+
+      # @see Trycourier::Models::UserToken#tracking
+      class Tracking < Trycourier::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)
+        #   Information about the device the token is associated with.
+        #
+        #   @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/trycourier/models/users/preference_retrieve_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module Users
+      # @see Trycourier::Resources::Users::Preferences#retrieve
+      class PreferenceRetrieveParams < Trycourier::Internal::Type::BaseModel
+        extend Trycourier::Internal::Type::RequestParameters::Converter
+        include Trycourier::Internal::Type::RequestParameters
+
+        # @!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: {})
+        #   @param tenant_id [String, nil] Query the preferences of a user for this specific tenant context.
+        #
+        #   @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/trycourier/models/users/preference_retrieve_response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module Users
+      # @see Trycourier::Resources::Users::Preferences#retrieve
+      class PreferenceRetrieveResponse < Trycourier::Internal::Type::BaseModel
+        # @!attribute items
+        #   The Preferences associated with the user_id.
+        #
+        #   @return [Array<Trycourier::Models::TopicPreference>]
+        required :items, -> { Trycourier::Internal::Type::ArrayOf[Trycourier::TopicPreference] }
+
+        # @!attribute paging
+        #   Deprecated - Paging not implemented on this endpoint
+        #
+        #   @return [Trycourier::Models::Paging]
+        required :paging, -> { Trycourier::Paging }
+
+        # @!method initialize(items:, paging:)
+        #   @param items [Array<Trycourier::Models::TopicPreference>] The Preferences associated with the user_id.
+        #
+        #   @param paging [Trycourier::Models::Paging] Deprecated - Paging not implemented on this endpoint
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module Users
+      # @see Trycourier::Resources::Users::Preferences#retrieve_topic
+      class PreferenceRetrieveTopicParams < Trycourier::Internal::Type::BaseModel
+        extend Trycourier::Internal::Type::RequestParameters::Converter
+        include Trycourier::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(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 [Trycourier::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/trycourier/models/users/preference_retrieve_topic_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module Users
+      # @see Trycourier::Resources::Users::Preferences#retrieve_topic
+      class PreferenceRetrieveTopicResponse < Trycourier::Internal::Type::BaseModel
+        # @!attribute topic
+        #
+        #   @return [Trycourier::Models::TopicPreference]
+        required :topic, -> { Trycourier::TopicPreference }
+
+        # @!method initialize(topic:)
+        #   @param topic [Trycourier::Models::TopicPreference]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module Users
+      # @see Trycourier::Resources::Users::Preferences#update_or_create_topic
+      class PreferenceUpdateOrCreateTopicParams < Trycourier::Internal::Type::BaseModel
+        extend Trycourier::Internal::Type::RequestParameters::Converter
+        include Trycourier::Internal::Type::RequestParameters
+
+        # @!attribute user_id
+        #
+        #   @return [String]
+        required :user_id, String
+
+        # @!attribute topic
+        #
+        #   @return [Trycourier::Models::Users::PreferenceUpdateOrCreateTopicParams::Topic]
+        required :topic, -> { Trycourier::Users::PreferenceUpdateOrCreateTopicParams::Topic }
+
+        # @!attribute tenant_id
+        #   Update the preferences of a user for this specific tenant context.
+        #
+        #   @return [String, nil]
+        optional :tenant_id, String, nil?: true
+
+        # @!method initialize(user_id:, topic:, tenant_id: nil, request_options: {})
+        #   @param user_id [String]
+        #
+        #   @param topic [Trycourier::Models::Users::PreferenceUpdateOrCreateTopicParams::Topic]
+        #
+        #   @param tenant_id [String, nil] Update the preferences of a user for this specific tenant context.
+        #
+        #   @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}]
+
+        class Topic < Trycourier::Internal::Type::BaseModel
+          # @!attribute status
+          #
+          #   @return [Symbol, Trycourier::Models::PreferenceStatus]
+          required :status, enum: -> { Trycourier::PreferenceStatus }
+
+          # @!attribute custom_routing
+          #   The Channels a user has chosen to receive notifications through for this topic
+          #
+          #   @return [Array<Symbol, Trycourier::Models::ChannelClassification>, nil]
+          optional :custom_routing,
+                   -> { Trycourier::Internal::Type::ArrayOf[enum: Trycourier::ChannelClassification] },
+                   nil?: true
+
+          # @!attribute has_custom_routing
+          #
+          #   @return [Boolean, nil]
+          optional :has_custom_routing, Trycourier::Internal::Type::Boolean, nil?: true
+
+          # @!method initialize(status:, custom_routing: nil, has_custom_routing: nil)
+          #   @param status [Symbol, Trycourier::Models::PreferenceStatus]
+          #
+          #   @param custom_routing [Array<Symbol, Trycourier::Models::ChannelClassification>, nil] The Channels a user has chosen to receive notifications through for this topic
+          #
+          #   @param has_custom_routing [Boolean, nil]
+        end
+      end
+    end
+  end
+end

data/lib/trycourier/models/users/preference_update_or_create_topic_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module Users
+      # @see Trycourier::Resources::Users::Preferences#update_or_create_topic
+      class PreferenceUpdateOrCreateTopicResponse < Trycourier::Internal::Type::BaseModel
+        # @!attribute message
+        #
+        #   @return [String]
+        required :message, String
+
+        # @!method initialize(message:)
+        #   @param message [String]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module Users
+      # @see Trycourier::Resources::Users::Tenants#add_multiple
+      class TenantAddMultipleParams < Trycourier::Internal::Type::BaseModel
+        extend Trycourier::Internal::Type::RequestParameters::Converter
+        include Trycourier::Internal::Type::RequestParameters
+
+        # @!attribute tenants
+        #
+        #   @return [Array<Trycourier::Models::TenantAssociation>]
+        required :tenants, -> { Trycourier::Internal::Type::ArrayOf[Trycourier::TenantAssociation] }
+
+        # @!method initialize(tenants:, request_options: {})
+        #   @param tenants [Array<Trycourier::Models::TenantAssociation>]
+        #   @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module Users
+      # @see Trycourier::Resources::Users::Tenants#add_single
+      class TenantAddSingleParams < Trycourier::Internal::Type::BaseModel
+        extend Trycourier::Internal::Type::RequestParameters::Converter
+        include Trycourier::Internal::Type::RequestParameters
+
+        # @!attribute user_id
+        #
+        #   @return [String]
+        required :user_id, String
+
+        # @!attribute profile
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :profile, Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::Unknown], nil?: true
+
+        # @!method initialize(user_id:, profile: nil, request_options: {})
+        #   @param user_id [String]
+        #   @param profile [Hash{Symbol=>Object}, nil]
+        #   @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module Users
+      # @see Trycourier::Resources::Users::Tenants#list
+      class TenantListParams < Trycourier::Internal::Type::BaseModel
+        extend Trycourier::Internal::Type::RequestParameters::Converter
+        include Trycourier::Internal::Type::RequestParameters
+
+        # @!attribute cursor
+        #   Continue the pagination with the next cursor
+        #
+        #   @return [String, nil]
+        optional :cursor, String, nil?: true
+
+        # @!attribute limit
+        #   The number of accounts to return (defaults to 20, maximum value of 100)
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer, nil?: true
+
+        # @!method initialize(cursor: nil, limit: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Trycourier::Models::Users::TenantListParams} for more details.
+        #
+        #   @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}]
+      end
+    end
+  end
+end

data/lib/trycourier/models/users/tenant_list_response.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module Users
+      # @see Trycourier::Resources::Users::Tenants#list
+      class TenantListResponse < Trycourier::Internal::Type::BaseModel
+        # @!attribute has_more
+        #   Set to true when there are more pages that can be retrieved.
+        #
+        #   @return [Boolean]
+        required :has_more, Trycourier::Internal::Type::Boolean
+
+        # @!attribute type
+        #   Always set to `list`. Represents the type of this object.
+        #
+        #   @return [Symbol, Trycourier::Models::Users::TenantListResponse::Type]
+        required :type, enum: -> { Trycourier::Models::Users::TenantListResponse::Type }
+
+        # @!attribute url
+        #   A url that may be used to generate these results.
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!attribute cursor
+        #   A pointer to the next page of results. Defined only when `has_more` is set to
+        #   true
+        #
+        #   @return [String, nil]
+        optional :cursor, String, nil?: true
+
+        # @!attribute items
+        #
+        #   @return [Array<Trycourier::Models::TenantAssociation>, nil]
+        optional :items, -> { Trycourier::Internal::Type::ArrayOf[Trycourier::TenantAssociation] }, nil?: true
+
+        # @!attribute next_url
+        #   A url that may be used to generate fetch the next set of results. Defined only
+        #   when `has_more` is set to true
+        #
+        #   @return [String, nil]
+        optional :next_url, String, nil?: true
+
+        # @!method initialize(has_more:, type:, url:, cursor: nil, items: nil, next_url: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Trycourier::Models::Users::TenantListResponse} for more details.
+        #
+        #   @param has_more [Boolean] Set to true when there are more pages that can be retrieved.
+        #
+        #   @param type [Symbol, Trycourier::Models::Users::TenantListResponse::Type] Always set to `list`. Represents the type of this object.
+        #
+        #   @param url [String] A url that may be used to generate these results.
+        #
+        #   @param cursor [String, nil] A pointer to the next page of results. Defined
+        #
+        #   @param items [Array<Trycourier::Models::TenantAssociation>, nil]
+        #
+        #   @param next_url [String, nil] A url that may be used to generate fetch the next set of results.
+
+        # Always set to `list`. Represents the type of this object.
+        #
+        # @see Trycourier::Models::Users::TenantListResponse#type
+        module Type
+          extend Trycourier::Internal::Type::Enum
+
+          LIST = :list
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end