trycourier 3.1.4 → 3.4.0.pre.alpha1

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module Users
+      # @see Trycourier::Resources::Users::Tenants#remove_all
+      class TenantRemoveAllParams < 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
+end

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

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

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module Users
+      # @see Trycourier::Resources::Users::Tokens#add_multiple
+      class TokenAddMultipleParams < 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
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module Users
+      # @see Trycourier::Resources::Users::Tokens#add_single
+      class TokenAddSingleParams < Trycourier::Models::UserToken
+        extend Trycourier::Internal::Type::RequestParameters::Converter
+        include Trycourier::Internal::Type::RequestParameters
+
+        # @!attribute user_id
+        #
+        #   @return [String]
+        required :user_id, String
+
+        # @!method initialize(user_id:, request_options: {})
+        #   @param user_id [String]
+        #   @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module Users
+      # @see Trycourier::Resources::Users::Tokens#list
+      class TokenListParams < 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
+end

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module Users
+      # @type [Trycourier::Internal::Type::Converter]
+      TokenListResponse = Trycourier::Internal::Type::ArrayOf[-> { Trycourier::UserToken }]
+    end
+  end
+end

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

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

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module Users
+      # @see Trycourier::Resources::Users::Tokens#retrieve
+      class TokenRetrieveResponse < Trycourier::Models::UserToken
+        # @!attribute status
+        #
+        #   @return [Symbol, Trycourier::Models::Users::TokenRetrieveResponse::Status, nil]
+        optional :status, enum: -> { Trycourier::Models::Users::TokenRetrieveResponse::Status }, nil?: true
+
+        # @!attribute status_reason
+        #   The reason for the token status.
+        #
+        #   @return [String, nil]
+        optional :status_reason, String, nil?: true
+
+        # @!method initialize(status: nil, status_reason: nil)
+        #   @param status [Symbol, Trycourier::Models::Users::TokenRetrieveResponse::Status, nil]
+        #
+        #   @param status_reason [String, nil] The reason for the token status.
+
+        module Status
+          extend Trycourier::Internal::Type::Enum
+
+          ACTIVE = :active
+          UNKNOWN = :unknown
+          FAILED = :failed
+          REVOKED = :revoked
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module Users
+      # @see Trycourier::Resources::Users::Tokens#update
+      class TokenUpdateParams < 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 patch
+        #
+        #   @return [Array<Trycourier::Models::Users::TokenUpdateParams::Patch>]
+        required :patch, -> { Trycourier::Internal::Type::ArrayOf[Trycourier::Users::TokenUpdateParams::Patch] }
+
+        # @!method initialize(user_id:, patch:, request_options: {})
+        #   @param user_id [String]
+        #   @param patch [Array<Trycourier::Models::Users::TokenUpdateParams::Patch>]
+        #   @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}]
+
+        class Patch < Trycourier::Internal::Type::BaseModel
+          # @!attribute op
+          #   The operation to perform.
+          #
+          #   @return [String]
+          required :op, String
+
+          # @!attribute path
+          #   The JSON path specifying the part of the profile to operate on.
+          #
+          #   @return [String]
+          required :path, String
+
+          # @!attribute value
+          #   The value for the operation.
+          #
+          #   @return [String, nil]
+          optional :value, String, nil?: true
+
+          # @!method initialize(op:, path:, value: nil)
+          #   @param op [String] The operation to perform.
+          #
+          #   @param path [String] The JSON path specifying the part of the profile to operate on.
+          #
+          #   @param value [String, nil] The value for the operation.
+        end
+      end
+    end
+  end
+end

data/lib/trycourier/models/utm.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class Utm < Trycourier::Internal::Type::BaseModel
+      # @!attribute campaign
+      #
+      #   @return [String, nil]
+      optional :campaign, String, nil?: true
+
+      # @!attribute content
+      #
+      #   @return [String, nil]
+      optional :content, String, nil?: true
+
+      # @!attribute medium
+      #
+      #   @return [String, nil]
+      optional :medium, String, nil?: true
+
+      # @!attribute source
+      #
+      #   @return [String, nil]
+      optional :source, String, nil?: true
+
+      # @!attribute term
+      #
+      #   @return [String, nil]
+      optional :term, String, nil?: true
+
+      # @!method initialize(campaign: nil, content: nil, medium: nil, source: nil, term: nil)
+      #   @param campaign [String, nil]
+      #   @param content [String, nil]
+      #   @param medium [String, nil]
+      #   @param source [String, nil]
+      #   @param term [String, nil]
+    end
+  end
+end

data/lib/trycourier/models/widget_background.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class WidgetBackground < Trycourier::Internal::Type::BaseModel
+      # @!attribute bottom_color
+      #
+      #   @return [String, nil]
+      optional :bottom_color, String, api_name: :bottomColor, nil?: true
+
+      # @!attribute top_color
+      #
+      #   @return [String, nil]
+      optional :top_color, String, api_name: :topColor, nil?: true
+
+      # @!method initialize(bottom_color: nil, top_color: nil)
+      #   @param bottom_color [String, nil]
+      #   @param top_color [String, nil]
+    end
+  end
+end

data/lib/trycourier/models.rb

@@ -0,0 +1,267 @@
+# frozen_string_literal: true
+
+module Trycourier
+  [Trycourier::Internal::Type::BaseModel, *Trycourier::Internal::Type::BaseModel.subclasses].each do |cls|
+    cls.define_sorbet_constant!(:OrHash) { T.type_alias { T.any(cls, Trycourier::Internal::AnyHash) } }
+  end
+
+  Trycourier::Internal::Util.walk_namespaces(Trycourier::Models).each do |mod|
+    case mod
+    in Trycourier::Internal::Type::Enum | Trycourier::Internal::Type::Union
+      mod.constants.each do |name|
+        case mod.const_get(name)
+        in true | false
+          mod.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T::Boolean } }
+          mod.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } }
+        in Integer
+          mod.define_sorbet_constant!(:TaggedInteger) { T.type_alias { Integer } }
+          mod.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } }
+        in Float
+          mod.define_sorbet_constant!(:TaggedFloat) { T.type_alias { Float } }
+          mod.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } }
+        in Symbol
+          mod.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { Symbol } }
+          mod.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } }
+        else
+        end
+      end
+    else
+    end
+  end
+
+  Trycourier::Internal::Util.walk_namespaces(Trycourier::Models)
+                            .lazy
+                            .grep(Trycourier::Internal::Type::Union)
+                            .each do |mod|
+    const = :Variants
+    next if mod.sorbet_constant_defined?(const)
+
+    mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
+  end
+
+  Alignment = Trycourier::Models::Alignment
+
+  Audience = Trycourier::Models::Audience
+
+  AudienceDeleteParams = Trycourier::Models::AudienceDeleteParams
+
+  AudienceListMembersParams = Trycourier::Models::AudienceListMembersParams
+
+  AudienceListParams = Trycourier::Models::AudienceListParams
+
+  AudienceRetrieveParams = Trycourier::Models::AudienceRetrieveParams
+
+  AudienceUpdateParams = Trycourier::Models::AudienceUpdateParams
+
+  AuditEvent = Trycourier::Models::AuditEvent
+
+  AuditEventListParams = Trycourier::Models::AuditEventListParams
+
+  AuditEventRetrieveParams = Trycourier::Models::AuditEventRetrieveParams
+
+  AuthIssueTokenParams = Trycourier::Models::AuthIssueTokenParams
+
+  AutomationInvokeResponse = Trycourier::Models::AutomationInvokeResponse
+
+  Automations = Trycourier::Models::Automations
+
+  BaseCheck = Trycourier::Models::BaseCheck
+
+  BaseTemplateTenantAssociation = Trycourier::Models::BaseTemplateTenantAssociation
+
+  Brand = Trycourier::Models::Brand
+
+  BrandColors = Trycourier::Models::BrandColors
+
+  BrandCreateParams = Trycourier::Models::BrandCreateParams
+
+  BrandDeleteParams = Trycourier::Models::BrandDeleteParams
+
+  BrandListParams = Trycourier::Models::BrandListParams
+
+  BrandRetrieveParams = Trycourier::Models::BrandRetrieveParams
+
+  BrandSettings = Trycourier::Models::BrandSettings
+
+  BrandSettingsEmail = Trycourier::Models::BrandSettingsEmail
+
+  BrandSettingsInApp = Trycourier::Models::BrandSettingsInApp
+
+  BrandSnippet = Trycourier::Models::BrandSnippet
+
+  BrandSnippets = Trycourier::Models::BrandSnippets
+
+  BrandTemplate = Trycourier::Models::BrandTemplate
+
+  BrandUpdateParams = Trycourier::Models::BrandUpdateParams
+
+  BulkAddUsersParams = Trycourier::Models::BulkAddUsersParams
+
+  BulkCreateJobParams = Trycourier::Models::BulkCreateJobParams
+
+  BulkListUsersParams = Trycourier::Models::BulkListUsersParams
+
+  BulkRetrieveJobParams = Trycourier::Models::BulkRetrieveJobParams
+
+  BulkRunJobParams = Trycourier::Models::BulkRunJobParams
+
+  ChannelClassification = Trycourier::Models::ChannelClassification
+
+  ChannelPreference = Trycourier::Models::ChannelPreference
+
+  Check = Trycourier::Models::Check
+
+  DefaultPreferences = Trycourier::Models::DefaultPreferences
+
+  ElementalActionNodeWithType = Trycourier::Models::ElementalActionNodeWithType
+
+  ElementalBaseNode = Trycourier::Models::ElementalBaseNode
+
+  ElementalChannelNode = Trycourier::Models::ElementalChannelNode
+
+  ElementalChannelNodeWithType = Trycourier::Models::ElementalChannelNodeWithType
+
+  ElementalContent = Trycourier::Models::ElementalContent
+
+  ElementalContentSugar = Trycourier::Models::ElementalContentSugar
+
+  ElementalDividerNodeWithType = Trycourier::Models::ElementalDividerNodeWithType
+
+  ElementalImageNodeWithType = Trycourier::Models::ElementalImageNodeWithType
+
+  ElementalMetaNodeWithType = Trycourier::Models::ElementalMetaNodeWithType
+
+  ElementalNode = Trycourier::Models::ElementalNode
+
+  ElementalQuoteNodeWithType = Trycourier::Models::ElementalQuoteNodeWithType
+
+  ElementalTextNodeWithType = Trycourier::Models::ElementalTextNodeWithType
+
+  EmailFooter = Trycourier::Models::EmailFooter
+
+  EmailHead = Trycourier::Models::EmailHead
+
+  EmailHeader = Trycourier::Models::EmailHeader
+
+  Filter = Trycourier::Models::Filter
+
+  FilterConfig = Trycourier::Models::FilterConfig
+
+  Icons = Trycourier::Models::Icons
+
+  InboundBulkMessage = Trycourier::Models::InboundBulkMessage
+
+  InboundBulkMessageUser = Trycourier::Models::InboundBulkMessageUser
+
+  InboundTrackEventParams = Trycourier::Models::InboundTrackEventParams
+
+  ListDeleteParams = Trycourier::Models::ListDeleteParams
+
+  ListListParams = Trycourier::Models::ListListParams
+
+  ListRestoreParams = Trycourier::Models::ListRestoreParams
+
+  ListRetrieveParams = Trycourier::Models::ListRetrieveParams
+
+  Lists = Trycourier::Models::Lists
+
+  ListUpdateParams = Trycourier::Models::ListUpdateParams
+
+  Logo = Trycourier::Models::Logo
+
+  MessageCancelParams = Trycourier::Models::MessageCancelParams
+
+  MessageContentParams = Trycourier::Models::MessageContentParams
+
+  MessageContext = Trycourier::Models::MessageContext
+
+  MessageDetails = Trycourier::Models::MessageDetails
+
+  MessageHistoryParams = Trycourier::Models::MessageHistoryParams
+
+  MessageListParams = Trycourier::Models::MessageListParams
+
+  MessageRetrieveParams = Trycourier::Models::MessageRetrieveParams
+
+  MessageRouting = Trycourier::Models::MessageRouting
+
+  MessageRoutingChannel = Trycourier::Models::MessageRoutingChannel
+
+  NotificationGetContent = Trycourier::Models::NotificationGetContent
+
+  NotificationListParams = Trycourier::Models::NotificationListParams
+
+  NotificationPreferenceDetails = Trycourier::Models::NotificationPreferenceDetails
+
+  NotificationRetrieveContentParams = Trycourier::Models::NotificationRetrieveContentParams
+
+  Notifications = Trycourier::Models::Notifications
+
+  Paging = Trycourier::Models::Paging
+
+  Preference = Trycourier::Models::Preference
+
+  PreferenceStatus = Trycourier::Models::PreferenceStatus
+
+  ProfileCreateParams = Trycourier::Models::ProfileCreateParams
+
+  ProfileDeleteParams = Trycourier::Models::ProfileDeleteParams
+
+  ProfileReplaceParams = Trycourier::Models::ProfileReplaceParams
+
+  ProfileRetrieveParams = Trycourier::Models::ProfileRetrieveParams
+
+  Profiles = Trycourier::Models::Profiles
+
+  ProfileUpdateParams = Trycourier::Models::ProfileUpdateParams
+
+  PutSubscriptionsRecipient = Trycourier::Models::PutSubscriptionsRecipient
+
+  Recipient = Trycourier::Models::Recipient
+
+  RecipientPreferences = Trycourier::Models::RecipientPreferences
+
+  RequestArchiveParams = Trycourier::Models::RequestArchiveParams
+
+  Rule = Trycourier::Models::Rule
+
+  SendMessageParams = Trycourier::Models::SendMessageParams
+
+  SubscriptionList = Trycourier::Models::SubscriptionList
+
+  SubscriptionTopicNew = Trycourier::Models::SubscriptionTopicNew
+
+  Tenant = Trycourier::Models::Tenant
+
+  TenantAssociation = Trycourier::Models::TenantAssociation
+
+  TenantDeleteParams = Trycourier::Models::TenantDeleteParams
+
+  TenantListParams = Trycourier::Models::TenantListParams
+
+  TenantListUsersParams = Trycourier::Models::TenantListUsersParams
+
+  TenantRetrieveParams = Trycourier::Models::TenantRetrieveParams
+
+  Tenants = Trycourier::Models::Tenants
+
+  TenantUpdateParams = Trycourier::Models::TenantUpdateParams
+
+  TextStyle = Trycourier::Models::TextStyle
+
+  TopicPreference = Trycourier::Models::TopicPreference
+
+  TranslationRetrieveParams = Trycourier::Models::TranslationRetrieveParams
+
+  TranslationUpdateParams = Trycourier::Models::TranslationUpdateParams
+
+  UserRecipient = Trycourier::Models::UserRecipient
+
+  Users = Trycourier::Models::Users
+
+  UserToken = Trycourier::Models::UserToken
+
+  Utm = Trycourier::Models::Utm
+
+  WidgetBackground = Trycourier::Models::WidgetBackground
+end

data/lib/trycourier/request_options.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Trycourier
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  # or override those provided at the client level.
+  #
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < Trycourier::Internal::Type::BaseModel
+    # @api private
+    #
+    # @param opts [Trycourier::RequestOptions, Hash{Symbol=>Object}]
+    #
+    # @raise [ArgumentError]
+    def self.validate!(opts)
+      case opts
+      in Trycourier::RequestOptions | Hash
+        opts.to_h.each_key do |k|
+          unless fields.include?(k)
+            raise ArgumentError.new("Request `opts` keys must be one of #{fields.keys}, got #{k.inspect}")
+          end
+        end
+      else
+        raise ArgumentError.new("Request `opts` must be a Hash or RequestOptions, got #{opts.inspect}")
+      end
+    end
+
+    # @!attribute idempotency_key
+    #   Idempotency key to send with request and all associated retries. Will only be
+    #   sent for write requests.
+    #
+    #   @return [String, nil]
+    optional :idempotency_key, String
+
+    # @!attribute extra_query
+    #   Extra query params to send with the request. These are `.merge`’d into any
+    #   `query` given at the client level.
+    #
+    #   @return [Hash{String=>Array<String>, String, nil}, nil]
+    optional :extra_query, Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::ArrayOf[String]]
+
+    # @!attribute extra_headers
+    #   Extra headers to send with the request. These are `.merged`’d into any
+    #   `extra_headers` given at the client level.
+    #
+    #   @return [Hash{String=>String, nil}, nil]
+    optional :extra_headers, Trycourier::Internal::Type::HashOf[String, nil?: true]
+
+    # @!attribute extra_body
+    #   Extra data to send with the request. These are deep merged into any data
+    #   generated as part of the normal request.
+    #
+    #   @return [Object, nil]
+    optional :extra_body, Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::Unknown]
+
+    # @!attribute max_retries
+    #   Maximum number of retries to attempt after a failed initial request.
+    #
+    #   @return [Integer, nil]
+    optional :max_retries, Integer
+
+    # @!attribute timeout
+    #   Request timeout in seconds.
+    #
+    #   @return [Float, nil]
+    optional :timeout, Float
+
+    # @!method initialize(values = {})
+    #   Returns a new instance of RequestOptions.
+    #
+    #   @param values [Hash{Symbol=>Object}]
+
+    define_sorbet_constant!(:OrHash) do
+      T.type_alias { T.any(Trycourier::RequestOptions, Trycourier::Internal::AnyHash) }
+    end
+  end
+end