trycourier 3.1.3 → 3.4.0.pre.alpha0

data/lib/trycourier/models/tenant_association.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class TenantAssociation < Trycourier::Internal::Type::BaseModel
+      # @!attribute tenant_id
+      #   Tenant ID for the association between tenant and user
+      #
+      #   @return [String]
+      required :tenant_id, String
+
+      # @!attribute profile
+      #   Additional metadata to be applied to a user profile when used in a tenant
+      #   context
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :profile, Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::Unknown], nil?: true
+
+      # @!attribute type
+      #
+      #   @return [Symbol, Trycourier::Models::TenantAssociation::Type, nil]
+      optional :type, enum: -> { Trycourier::TenantAssociation::Type }, nil?: true
+
+      # @!attribute user_id
+      #   User ID for the association between tenant and user
+      #
+      #   @return [String, nil]
+      optional :user_id, String, nil?: true
+
+      # @!method initialize(tenant_id:, profile: nil, type: nil, user_id: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Trycourier::Models::TenantAssociation} for more details.
+      #
+      #   @param tenant_id [String] Tenant ID for the association between tenant and user
+      #
+      #   @param profile [Hash{Symbol=>Object}, nil] Additional metadata to be applied to a user profile when used in a tenant contex
+      #
+      #   @param type [Symbol, Trycourier::Models::TenantAssociation::Type, nil]
+      #
+      #   @param user_id [String, nil] User ID for the association between tenant and user
+
+      # @see Trycourier::Models::TenantAssociation#type
+      module Type
+        extend Trycourier::Internal::Type::Enum
+
+        USER = :user
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/trycourier/models/tenant_delete_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    # @see Trycourier::Resources::Tenants#delete
+    class TenantDeleteParams < Trycourier::Internal::Type::BaseModel
+      extend Trycourier::Internal::Type::RequestParameters::Converter
+      include Trycourier::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/trycourier/models/tenant_list_params.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    # @see Trycourier::Resources::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 tenants to return (defaults to 20, maximum value of 100)
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer, nil?: true
+
+      # @!attribute parent_tenant_id
+      #   Filter the list of tenants by parent_id
+      #
+      #   @return [String, nil]
+      optional :parent_tenant_id, String, nil?: true
+
+      # @!method initialize(cursor: nil, limit: nil, parent_tenant_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Trycourier::Models::TenantListParams} for more details.
+      #
+      #   @param cursor [String, nil] Continue the pagination with the next cursor
+      #
+      #   @param limit [Integer, nil] The number of tenants to return
+      #
+      #   @param parent_tenant_id [String, nil] Filter the list of tenants by parent_id
+      #
+      #   @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/trycourier/models/tenant_list_response.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    # @see Trycourier::Resources::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 items
+      #   An array of Tenants
+      #
+      #   @return [Array<Trycourier::Models::Tenant>]
+      required :items, -> { Trycourier::Internal::Type::ArrayOf[Trycourier::Tenant] }
+
+      # @!attribute type
+      #   Always set to "list". Represents the type of this object.
+      #
+      #   @return [Symbol, Trycourier::Models::TenantListResponse::Type]
+      required :type, enum: -> { Trycourier::Models::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 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:, items:, type:, url:, cursor: nil, next_url: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Trycourier::Models::TenantListResponse} for more details.
+      #
+      #   @param has_more [Boolean] Set to true when there are more pages that can be retrieved.
+      #
+      #   @param items [Array<Trycourier::Models::Tenant>] An array of Tenants
+      #
+      #   @param type [Symbol, Trycourier::Models::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 only when has_more is set to true
+      #
+      #   @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::TenantListResponse#type
+      module Type
+        extend Trycourier::Internal::Type::Enum
+
+        LIST = :list
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/trycourier/models/tenant_list_users_params.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    # @see Trycourier::Resources::Tenants#list_users
+    class TenantListUsersParams < 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::TenantListUsersParams} 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

data/lib/trycourier/models/tenant_list_users_response.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    # @see Trycourier::Resources::Tenants#list_users
+    class TenantListUsersResponse < 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::TenantListUsersResponse::Type]
+      required :type, enum: -> { Trycourier::Models::TenantListUsersResponse::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::TenantListUsersResponse} for more details.
+      #
+      #   @param has_more [Boolean] Set to true when there are more pages that can be retrieved.
+      #
+      #   @param type [Symbol, Trycourier::Models::TenantListUsersResponse::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::TenantListUsersResponse#type
+      module Type
+        extend Trycourier::Internal::Type::Enum
+
+        LIST = :list
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/trycourier/models/tenant_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    # @see Trycourier::Resources::Tenants#retrieve
+    class TenantRetrieveParams < Trycourier::Internal::Type::BaseModel
+      extend Trycourier::Internal::Type::RequestParameters::Converter
+      include Trycourier::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/trycourier/models/tenant_update_params.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    # @see Trycourier::Resources::Tenants#update
+    class TenantUpdateParams < Trycourier::Internal::Type::BaseModel
+      extend Trycourier::Internal::Type::RequestParameters::Converter
+      include Trycourier::Internal::Type::RequestParameters
+
+      # @!attribute name
+      #   Name of the tenant.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute brand_id
+      #   Brand to be used for the account when one is not specified by the send call.
+      #
+      #   @return [String, nil]
+      optional :brand_id, String, nil?: true
+
+      # @!attribute default_preferences
+      #   Defines the preferences used for the tenant when the user hasn't specified their
+      #   own.
+      #
+      #   @return [Trycourier::Models::DefaultPreferences, nil]
+      optional :default_preferences, -> { Trycourier::DefaultPreferences }, nil?: true
+
+      # @!attribute parent_tenant_id
+      #   Tenant's parent id (if any).
+      #
+      #   @return [String, nil]
+      optional :parent_tenant_id, String, nil?: true
+
+      # @!attribute properties
+      #   Arbitrary properties accessible to a template.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :properties,
+               Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::Unknown],
+               nil?: true
+
+      # @!attribute user_profile
+      #   A user profile object merged with user profile on send.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :user_profile,
+               Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::Unknown],
+               nil?: true
+
+      # @!method initialize(name:, brand_id: nil, default_preferences: nil, parent_tenant_id: nil, properties: nil, user_profile: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Trycourier::Models::TenantUpdateParams} for more details.
+      #
+      #   @param name [String] Name of the tenant.
+      #
+      #   @param brand_id [String, nil] Brand to be used for the account when one is not specified by the send call.
+      #
+      #   @param default_preferences [Trycourier::Models::DefaultPreferences, nil] Defines the preferences used for the tenant when the user hasn't specified their
+      #
+      #   @param parent_tenant_id [String, nil] Tenant's parent id (if any).
+      #
+      #   @param properties [Hash{Symbol=>Object}, nil] Arbitrary properties accessible to a template.
+      #
+      #   @param user_profile [Hash{Symbol=>Object}, nil] A user profile object merged with user profile on send.
+      #
+      #   @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/trycourier/models/tenants/default_preferences/item_delete_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module Tenants
+      module DefaultPreferences
+        # @see Trycourier::Resources::Tenants::DefaultPreferences::Items#delete
+        class ItemDeleteParams < Trycourier::Internal::Type::BaseModel
+          extend Trycourier::Internal::Type::RequestParameters::Converter
+          include Trycourier::Internal::Type::RequestParameters
+
+          # @!attribute tenant_id
+          #
+          #   @return [String]
+          required :tenant_id, String
+
+          # @!method initialize(tenant_id:, request_options: {})
+          #   @param tenant_id [String]
+          #   @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/trycourier/models/tenants/default_preferences/item_update_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module Tenants
+      module DefaultPreferences
+        # @see Trycourier::Resources::Tenants::DefaultPreferences::Items#update
+        class ItemUpdateParams < Trycourier::Models::SubscriptionTopicNew
+          extend Trycourier::Internal::Type::RequestParameters::Converter
+          include Trycourier::Internal::Type::RequestParameters
+
+          # @!attribute tenant_id
+          #
+          #   @return [String]
+          required :tenant_id, String
+
+          # @!method initialize(tenant_id:, request_options: {})
+          #   @param tenant_id [String]
+          #   @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module Tenants
+      # @see Trycourier::Resources::Tenants::Templates#list
+      class TemplateListParams < 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 templates 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: {})
+        #   @param cursor [String, nil] Continue the pagination with the next cursor
+        #
+        #   @param limit [Integer, nil] The number of templates to return (defaults to 20, maximum value of 100)
+        #
+        #   @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/trycourier/models/tenants/template_list_response.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module Tenants
+      # @see Trycourier::Resources::Tenants::Templates#list
+      class TemplateListResponse < 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::Tenants::TemplateListResponse::Type]
+        required :type, enum: -> { Trycourier::Models::Tenants::TemplateListResponse::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::Tenants::TemplateListResponse::Item>, nil]
+        optional :items,
+                 -> { Trycourier::Internal::Type::ArrayOf[Trycourier::Models::Tenants::TemplateListResponse::Item] },
+                 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::Tenants::TemplateListResponse} for more details.
+        #
+        #   @param has_more [Boolean] Set to true when there are more pages that can be retrieved.
+        #
+        #   @param type [Symbol, Trycourier::Models::Tenants::TemplateListResponse::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::Tenants::TemplateListResponse::Item>, 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::Tenants::TemplateListResponse#type
+        module Type
+          extend Trycourier::Internal::Type::Enum
+
+          LIST = :list
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        class Item < Trycourier::Models::BaseTemplateTenantAssociation
+          # @!attribute data
+          #   The template's data containing it's routing configs
+          #
+          #   @return [Trycourier::Models::Tenants::TemplateListResponse::Item::Data]
+          required :data, -> { Trycourier::Models::Tenants::TemplateListResponse::Item::Data }
+
+          # @!method initialize(data:)
+          #   @param data [Trycourier::Models::Tenants::TemplateListResponse::Item::Data] The template's data containing it's routing configs
+
+          class Data < Trycourier::Internal::Type::BaseModel
+            # @!attribute routing
+            #
+            #   @return [Trycourier::Models::MessageRouting]
+            required :routing, -> { Trycourier::MessageRouting }
+
+            # @!method initialize(routing:)
+            #   The template's data containing it's routing configs
+            #
+            #   @param routing [Trycourier::Models::MessageRouting]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module Tenants
+      # @see Trycourier::Resources::Tenants::Templates#retrieve
+      class TemplateRetrieveParams < Trycourier::Internal::Type::BaseModel
+        extend Trycourier::Internal::Type::RequestParameters::Converter
+        include Trycourier::Internal::Type::RequestParameters
+
+        # @!attribute tenant_id
+        #
+        #   @return [String]
+        required :tenant_id, String
+
+        # @!method initialize(tenant_id:, request_options: {})
+        #   @param tenant_id [String]
+        #   @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/trycourier/models/text_style.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module TextStyle
+      extend Trycourier::Internal::Type::Enum
+
+      TEXT = :text
+      H1 = :h1
+      H2 = :h2
+      SUBTEXT = :subtext
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/trycourier/models/topic_preference.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class TopicPreference < Trycourier::Internal::Type::BaseModel
+      # @!attribute default_status
+      #
+      #   @return [Symbol, Trycourier::Models::PreferenceStatus]
+      required :default_status, enum: -> { Trycourier::PreferenceStatus }
+
+      # @!attribute status
+      #
+      #   @return [Symbol, Trycourier::Models::PreferenceStatus]
+      required :status, enum: -> { Trycourier::PreferenceStatus }
+
+      # @!attribute topic_id
+      #
+      #   @return [String]
+      required :topic_id, String
+
+      # @!attribute topic_name
+      #
+      #   @return [String]
+      required :topic_name, String
+
+      # @!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(default_status:, status:, topic_id:, topic_name:, custom_routing: nil, has_custom_routing: nil)
+      #   @param default_status [Symbol, Trycourier::Models::PreferenceStatus]
+      #
+      #   @param status [Symbol, Trycourier::Models::PreferenceStatus]
+      #
+      #   @param topic_id [String]
+      #
+      #   @param topic_name [String]
+      #
+      #   @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

data/lib/trycourier/models/translation_retrieve_params.rb

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