trycourier 3.1.4 → 3.4.0.pre.alpha0

data/sig/trycourier/models/user_token.rbs

@@ -0,0 +1,137 @@
+module Trycourier
+  module Models
+    type user_token =
+      {
+        provider_key: Trycourier::Models::UserToken::provider_key,
+        token: String?,
+        device: Trycourier::UserToken::Device?,
+        expiry_date: Trycourier::Models::UserToken::expiry_date?,
+        properties: top,
+        tracking: Trycourier::UserToken::Tracking?
+      }
+
+    class UserToken < Trycourier::Internal::Type::BaseModel
+      attr_accessor provider_key: Trycourier::Models::UserToken::provider_key
+
+      attr_accessor token: String?
+
+      attr_accessor device: Trycourier::UserToken::Device?
+
+      attr_accessor expiry_date: Trycourier::Models::UserToken::expiry_date?
+
+      attr_reader properties: top?
+
+      def properties=: (top) -> top
+
+      attr_accessor tracking: Trycourier::UserToken::Tracking?
+
+      def initialize: (
+        provider_key: Trycourier::Models::UserToken::provider_key,
+        ?token: String?,
+        ?device: Trycourier::UserToken::Device?,
+        ?expiry_date: Trycourier::Models::UserToken::expiry_date?,
+        ?properties: top,
+        ?tracking: Trycourier::UserToken::Tracking?
+      ) -> void
+
+      def to_hash: -> {
+        provider_key: Trycourier::Models::UserToken::provider_key,
+        token: String?,
+        device: Trycourier::UserToken::Device?,
+        expiry_date: Trycourier::Models::UserToken::expiry_date?,
+        properties: top,
+        tracking: Trycourier::UserToken::Tracking?
+      }
+
+      type provider_key = :"firebase-fcm" | :apn | :expo | :onesignal
+
+      module ProviderKey
+        extend Trycourier::Internal::Type::Enum
+
+        FIREBASE_FCM: :"firebase-fcm"
+        APN: :apn
+        EXPO: :expo
+        ONESIGNAL: :onesignal
+
+        def self?.values: -> ::Array[Trycourier::Models::UserToken::provider_key]
+      end
+
+      type device =
+        {
+          ad_id: String?,
+          app_id: String?,
+          device_id: String?,
+          manufacturer: String?,
+          model: String?,
+          platform: String?
+        }
+
+      class Device < Trycourier::Internal::Type::BaseModel
+        attr_accessor ad_id: String?
+
+        attr_accessor app_id: String?
+
+        attr_accessor device_id: String?
+
+        attr_accessor manufacturer: String?
+
+        attr_accessor model: String?
+
+        attr_accessor platform: String?
+
+        def initialize: (
+          ?ad_id: String?,
+          ?app_id: String?,
+          ?device_id: String?,
+          ?manufacturer: String?,
+          ?model: String?,
+          ?platform: String?
+        ) -> void
+
+        def to_hash: -> {
+          ad_id: String?,
+          app_id: String?,
+          device_id: String?,
+          manufacturer: String?,
+          model: String?,
+          platform: String?
+        }
+      end
+
+      type expiry_date = String | bool
+
+      module ExpiryDate
+        extend Trycourier::Internal::Type::Union
+
+        def self?.variants: -> ::Array[Trycourier::Models::UserToken::expiry_date]
+      end
+
+      type tracking =
+        { ip: String?, lat: String?, long: String?, os_version: String? }
+
+      class Tracking < Trycourier::Internal::Type::BaseModel
+        attr_accessor ip: String?
+
+        attr_accessor lat: String?
+
+        attr_accessor long: String?
+
+        attr_accessor os_version: String?
+
+        def initialize: (
+          ?ip: String?,
+          ?lat: String?,
+          ?long: String?,
+          ?os_version: String?
+        ) -> void
+
+        def to_hash: -> {
+          ip: String?,
+          lat: String?,
+          long: String?,
+          os_version: String?
+        }
+      end
+    end
+  end
+end

data/sig/trycourier/models/users/preference_retrieve_params.rbs

@@ -0,0 +1,25 @@
+module Trycourier
+  module Models
+    module Users
+      type preference_retrieve_params =
+        { tenant_id: String? } & Trycourier::Internal::Type::request_parameters
+
+      class PreferenceRetrieveParams < Trycourier::Internal::Type::BaseModel
+        extend Trycourier::Internal::Type::RequestParameters::Converter
+        include Trycourier::Internal::Type::RequestParameters
+
+        attr_accessor tenant_id: String?
+
+        def initialize: (
+          ?tenant_id: String?,
+          ?request_options: Trycourier::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          tenant_id: String?,
+          request_options: Trycourier::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/trycourier/models/users/preference_retrieve_response.rbs

@@ -0,0 +1,27 @@
+module Trycourier
+  module Models
+    module Users
+      type preference_retrieve_response =
+        {
+          items: ::Array[Trycourier::TopicPreference],
+          paging: Trycourier::Paging
+        }
+
+      class PreferenceRetrieveResponse < Trycourier::Internal::Type::BaseModel
+        attr_accessor items: ::Array[Trycourier::TopicPreference]
+
+        attr_accessor paging: Trycourier::Paging
+
+        def initialize: (
+          items: ::Array[Trycourier::TopicPreference],
+          paging: Trycourier::Paging
+        ) -> void
+
+        def to_hash: -> {
+          items: ::Array[Trycourier::TopicPreference],
+          paging: Trycourier::Paging
+        }
+      end
+    end
+  end
+end

data/sig/trycourier/models/users/preference_retrieve_topic_params.rbs

@@ -0,0 +1,30 @@
+module Trycourier
+  module Models
+    module Users
+      type preference_retrieve_topic_params =
+        { user_id: String, tenant_id: String? }
+        & Trycourier::Internal::Type::request_parameters
+
+      class PreferenceRetrieveTopicParams < Trycourier::Internal::Type::BaseModel
+        extend Trycourier::Internal::Type::RequestParameters::Converter
+        include Trycourier::Internal::Type::RequestParameters
+
+        attr_accessor user_id: String
+
+        attr_accessor tenant_id: String?
+
+        def initialize: (
+          user_id: String,
+          ?tenant_id: String?,
+          ?request_options: Trycourier::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          user_id: String,
+          tenant_id: String?,
+          request_options: Trycourier::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/trycourier/models/users/preference_retrieve_topic_response.rbs

@@ -0,0 +1,16 @@
+module Trycourier
+  module Models
+    module Users
+      type preference_retrieve_topic_response =
+        { topic: Trycourier::TopicPreference }
+
+      class PreferenceRetrieveTopicResponse < Trycourier::Internal::Type::BaseModel
+        attr_accessor topic: Trycourier::TopicPreference
+
+        def initialize: (topic: Trycourier::TopicPreference) -> void
+
+        def to_hash: -> { topic: Trycourier::TopicPreference }
+      end
+    end
+  end
+end

data/sig/trycourier/models/users/preference_update_or_create_topic_params.rbs

@@ -0,0 +1,65 @@
+module Trycourier
+  module Models
+    module Users
+      type preference_update_or_create_topic_params =
+        {
+          user_id: String,
+          topic: Trycourier::Users::PreferenceUpdateOrCreateTopicParams::Topic,
+          tenant_id: String?
+        }
+        & Trycourier::Internal::Type::request_parameters
+
+      class PreferenceUpdateOrCreateTopicParams < Trycourier::Internal::Type::BaseModel
+        extend Trycourier::Internal::Type::RequestParameters::Converter
+        include Trycourier::Internal::Type::RequestParameters
+
+        attr_accessor user_id: String
+
+        attr_accessor topic: Trycourier::Users::PreferenceUpdateOrCreateTopicParams::Topic
+
+        attr_accessor tenant_id: String?
+
+        def initialize: (
+          user_id: String,
+          topic: Trycourier::Users::PreferenceUpdateOrCreateTopicParams::Topic,
+          ?tenant_id: String?,
+          ?request_options: Trycourier::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          user_id: String,
+          topic: Trycourier::Users::PreferenceUpdateOrCreateTopicParams::Topic,
+          tenant_id: String?,
+          request_options: Trycourier::RequestOptions
+        }
+
+        type topic =
+          {
+            status: Trycourier::Models::preference_status,
+            custom_routing: ::Array[Trycourier::Models::channel_classification]?,
+            has_custom_routing: bool?
+          }
+
+        class Topic < Trycourier::Internal::Type::BaseModel
+          attr_accessor status: Trycourier::Models::preference_status
+
+          attr_accessor custom_routing: ::Array[Trycourier::Models::channel_classification]?
+
+          attr_accessor has_custom_routing: bool?
+
+          def initialize: (
+            status: Trycourier::Models::preference_status,
+            ?custom_routing: ::Array[Trycourier::Models::channel_classification]?,
+            ?has_custom_routing: bool?
+          ) -> void
+
+          def to_hash: -> {
+            status: Trycourier::Models::preference_status,
+            custom_routing: ::Array[Trycourier::Models::channel_classification]?,
+            has_custom_routing: bool?
+          }
+        end
+      end
+    end
+  end
+end

data/sig/trycourier/models/users/preference_update_or_create_topic_response.rbs

@@ -0,0 +1,15 @@
+module Trycourier
+  module Models
+    module Users
+      type preference_update_or_create_topic_response = { message: String }
+
+      class PreferenceUpdateOrCreateTopicResponse < Trycourier::Internal::Type::BaseModel
+        attr_accessor message: String
+
+        def initialize: (message: String) -> void
+
+        def to_hash: -> { message: String }
+      end
+    end
+  end
+end

data/sig/trycourier/models/users/tenant_add_multiple_params.rbs

@@ -0,0 +1,26 @@
+module Trycourier
+  module Models
+    module Users
+      type tenant_add_multiple_params =
+        { tenants: ::Array[Trycourier::TenantAssociation] }
+        & Trycourier::Internal::Type::request_parameters
+
+      class TenantAddMultipleParams < Trycourier::Internal::Type::BaseModel
+        extend Trycourier::Internal::Type::RequestParameters::Converter
+        include Trycourier::Internal::Type::RequestParameters
+
+        attr_accessor tenants: ::Array[Trycourier::TenantAssociation]
+
+        def initialize: (
+          tenants: ::Array[Trycourier::TenantAssociation],
+          ?request_options: Trycourier::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          tenants: ::Array[Trycourier::TenantAssociation],
+          request_options: Trycourier::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/trycourier/models/users/tenant_add_single_params.rbs

@@ -0,0 +1,30 @@
+module Trycourier
+  module Models
+    module Users
+      type tenant_add_single_params =
+        { user_id: String, profile: ::Hash[Symbol, top]? }
+        & Trycourier::Internal::Type::request_parameters
+
+      class TenantAddSingleParams < Trycourier::Internal::Type::BaseModel
+        extend Trycourier::Internal::Type::RequestParameters::Converter
+        include Trycourier::Internal::Type::RequestParameters
+
+        attr_accessor user_id: String
+
+        attr_accessor profile: ::Hash[Symbol, top]?
+
+        def initialize: (
+          user_id: String,
+          ?profile: ::Hash[Symbol, top]?,
+          ?request_options: Trycourier::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          user_id: String,
+          profile: ::Hash[Symbol, top]?,
+          request_options: Trycourier::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/trycourier/models/users/tenant_list_params.rbs

@@ -0,0 +1,30 @@
+module Trycourier
+  module Models
+    module Users
+      type tenant_list_params =
+        { cursor: String?, limit: Integer? }
+        & Trycourier::Internal::Type::request_parameters
+
+      class TenantListParams < Trycourier::Internal::Type::BaseModel
+        extend Trycourier::Internal::Type::RequestParameters::Converter
+        include Trycourier::Internal::Type::RequestParameters
+
+        attr_accessor cursor: String?
+
+        attr_accessor limit: Integer?
+
+        def initialize: (
+          ?cursor: String?,
+          ?limit: Integer?,
+          ?request_options: Trycourier::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          cursor: String?,
+          limit: Integer?,
+          request_options: Trycourier::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/trycourier/models/users/tenant_list_response.rbs

@@ -0,0 +1,57 @@
+module Trycourier
+  module Models
+    module Users
+      type tenant_list_response =
+        {
+          has_more: bool,
+          type: Trycourier::Models::Users::TenantListResponse::type_,
+          url: String,
+          cursor: String?,
+          items: ::Array[Trycourier::TenantAssociation]?,
+          next_url: String?
+        }
+
+      class TenantListResponse < Trycourier::Internal::Type::BaseModel
+        attr_accessor has_more: bool
+
+        attr_accessor type: Trycourier::Models::Users::TenantListResponse::type_
+
+        attr_accessor url: String
+
+        attr_accessor cursor: String?
+
+        attr_accessor items: ::Array[Trycourier::TenantAssociation]?
+
+        attr_accessor next_url: String?
+
+        def initialize: (
+          has_more: bool,
+          type: Trycourier::Models::Users::TenantListResponse::type_,
+          url: String,
+          ?cursor: String?,
+          ?items: ::Array[Trycourier::TenantAssociation]?,
+          ?next_url: String?
+        ) -> void
+
+        def to_hash: -> {
+          has_more: bool,
+          type: Trycourier::Models::Users::TenantListResponse::type_,
+          url: String,
+          cursor: String?,
+          items: ::Array[Trycourier::TenantAssociation]?,
+          next_url: String?
+        }
+
+        type type_ = :list
+
+        module Type
+          extend Trycourier::Internal::Type::Enum
+
+          LIST: :list
+
+          def self?.values: -> ::Array[Trycourier::Models::Users::TenantListResponse::type_]
+        end
+      end
+    end
+  end
+end

data/sig/trycourier/models/users/tenant_remove_all_params.rbs

@@ -0,0 +1,17 @@
+module Trycourier
+  module Models
+    module Users
+      type tenant_remove_all_params =
+        {  } & Trycourier::Internal::Type::request_parameters
+
+      class TenantRemoveAllParams < Trycourier::Internal::Type::BaseModel
+        extend Trycourier::Internal::Type::RequestParameters::Converter
+        include Trycourier::Internal::Type::RequestParameters
+
+        def initialize: (?request_options: Trycourier::request_opts) -> void
+
+        def to_hash: -> { request_options: Trycourier::RequestOptions }
+      end
+    end
+  end
+end

data/sig/trycourier/models/users/tenant_remove_single_params.rbs

@@ -0,0 +1,25 @@
+module Trycourier
+  module Models
+    module Users
+      type tenant_remove_single_params =
+        { user_id: String } & Trycourier::Internal::Type::request_parameters
+
+      class TenantRemoveSingleParams < Trycourier::Internal::Type::BaseModel
+        extend Trycourier::Internal::Type::RequestParameters::Converter
+        include Trycourier::Internal::Type::RequestParameters
+
+        attr_accessor user_id: String
+
+        def initialize: (
+          user_id: String,
+          ?request_options: Trycourier::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          user_id: String,
+          request_options: Trycourier::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/trycourier/models/users/token_add_multiple_params.rbs

@@ -0,0 +1,17 @@
+module Trycourier
+  module Models
+    module Users
+      type token_add_multiple_params =
+        {  } & Trycourier::Internal::Type::request_parameters
+
+      class TokenAddMultipleParams < Trycourier::Internal::Type::BaseModel
+        extend Trycourier::Internal::Type::RequestParameters::Converter
+        include Trycourier::Internal::Type::RequestParameters
+
+        def initialize: (?request_options: Trycourier::request_opts) -> void
+
+        def to_hash: -> { request_options: Trycourier::RequestOptions }
+      end
+    end
+  end
+end

data/sig/trycourier/models/users/token_add_single_params.rbs

@@ -0,0 +1,27 @@
+module Trycourier
+  module Models
+    module Users
+      type token_add_single_params =
+        { user_id: String } & Trycourier::Internal::Type::request_parameters
+
+      class TokenAddSingleParams < Trycourier::Models::UserToken
+        extend Trycourier::Internal::Type::RequestParameters::Converter
+        include Trycourier::Internal::Type::RequestParameters
+
+        def user_id: -> String
+
+        def user_id=: (String _) -> String
+
+        def initialize: (
+          user_id: String,
+          ?request_options: Trycourier::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          user_id: String,
+          request_options: Trycourier::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/trycourier/models/users/token_delete_params.rbs

@@ -0,0 +1,25 @@
+module Trycourier
+  module Models
+    module Users
+      type token_delete_params =
+        { user_id: String } & Trycourier::Internal::Type::request_parameters
+
+      class TokenDeleteParams < Trycourier::Internal::Type::BaseModel
+        extend Trycourier::Internal::Type::RequestParameters::Converter
+        include Trycourier::Internal::Type::RequestParameters
+
+        attr_accessor user_id: String
+
+        def initialize: (
+          user_id: String,
+          ?request_options: Trycourier::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          user_id: String,
+          request_options: Trycourier::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/trycourier/models/users/token_list_params.rbs

@@ -0,0 +1,17 @@
+module Trycourier
+  module Models
+    module Users
+      type token_list_params =
+        {  } & Trycourier::Internal::Type::request_parameters
+
+      class TokenListParams < Trycourier::Internal::Type::BaseModel
+        extend Trycourier::Internal::Type::RequestParameters::Converter
+        include Trycourier::Internal::Type::RequestParameters
+
+        def initialize: (?request_options: Trycourier::request_opts) -> void
+
+        def to_hash: -> { request_options: Trycourier::RequestOptions }
+      end
+    end
+  end
+end

data/sig/trycourier/models/users/token_list_response.rbs

@@ -0,0 +1,9 @@
+module Trycourier
+  module Models
+    module Users
+      type token_list_response = ::Array[Trycourier::UserToken]
+
+      TokenListResponse: Trycourier::Internal::Type::Converter
+    end
+  end
+end

data/sig/trycourier/models/users/token_retrieve_params.rbs

@@ -0,0 +1,25 @@
+module Trycourier
+  module Models
+    module Users
+      type token_retrieve_params =
+        { user_id: String } & Trycourier::Internal::Type::request_parameters
+
+      class TokenRetrieveParams < Trycourier::Internal::Type::BaseModel
+        extend Trycourier::Internal::Type::RequestParameters::Converter
+        include Trycourier::Internal::Type::RequestParameters
+
+        attr_accessor user_id: String
+
+        def initialize: (
+          user_id: String,
+          ?request_options: Trycourier::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          user_id: String,
+          request_options: Trycourier::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/trycourier/models/users/token_retrieve_response.rbs

@@ -0,0 +1,46 @@
+module Trycourier
+  module Models
+    module Users
+      type token_retrieve_response =
+        {
+          status: Trycourier::Models::Users::TokenRetrieveResponse::status?,
+          status_reason: String?
+        }
+
+      class TokenRetrieveResponse < Trycourier::Models::UserToken
+        def status: -> Trycourier::Models::Users::TokenRetrieveResponse::status?
+
+        def status=: (
+          Trycourier::Models::Users::TokenRetrieveResponse::status? _
+        ) -> Trycourier::Models::Users::TokenRetrieveResponse::status?
+
+        def status_reason: -> String?
+
+        def status_reason=: (String? _) -> String?
+
+        def initialize: (
+          ?status: Trycourier::Models::Users::TokenRetrieveResponse::status?,
+          ?status_reason: String?
+        ) -> void
+
+        def to_hash: -> {
+          status: Trycourier::Models::Users::TokenRetrieveResponse::status?,
+          status_reason: String?
+        }
+
+        type status = :active | :unknown | :failed | :revoked
+
+        module Status
+          extend Trycourier::Internal::Type::Enum
+
+          ACTIVE: :active
+          UNKNOWN: :unknown
+          FAILED: :failed
+          REVOKED: :revoked
+
+          def self?.values: -> ::Array[Trycourier::Models::Users::TokenRetrieveResponse::status]
+        end
+      end
+    end
+  end
+end