trycourier 4.4.0 → 4.6.0

data/lib/trycourier/models/single_filter_config.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class SingleFilterConfig < Trycourier::Internal::Type::BaseModel
+      # @!attribute operator
+      #   The operator to use for filtering
+      #
+      #   @return [Symbol, Trycourier::Models::SingleFilterConfig::Operator]
+      required :operator, enum: -> { Trycourier::SingleFilterConfig::Operator }
+
+      # @!attribute path
+      #   The attribe name from profile whose value will be operated against the filter
+      #   value
+      #
+      #   @return [String]
+      required :path, String
+
+      # @!attribute value
+      #   The value to use for filtering
+      #
+      #   @return [String]
+      required :value, String
+
+      # @!method initialize(operator:, path:, value:)
+      #   Some parameter documentations has been truncated, see
+      #   {Trycourier::Models::SingleFilterConfig} for more details.
+      #
+      #   @param operator [Symbol, Trycourier::Models::SingleFilterConfig::Operator] The operator to use for filtering
+      #
+      #   @param path [String] The attribe name from profile whose value will be operated against the filter va
+      #
+      #   @param value [String] The value to use for filtering
+
+      # The operator to use for filtering
+      #
+      # @see Trycourier::Models::SingleFilterConfig#operator
+      module Operator
+        extend Trycourier::Internal::Type::Enum
+
+        ENDS_WITH = :ENDS_WITH
+        EQ = :EQ
+        EXISTS = :EXISTS
+        GT = :GT
+        GTE = :GTE
+        INCLUDES = :INCLUDES
+        IS_AFTER = :IS_AFTER
+        IS_BEFORE = :IS_BEFORE
+        LT = :LT
+        LTE = :LTE
+        NEQ = :NEQ
+        OMIT = :OMIT
+        STARTS_WITH = :STARTS_WITH
+        AND = :AND
+        OR = :OR
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/trycourier/models/slack.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module Slack
+      extend Trycourier::Internal::Type::Union
+
+      variant -> { Trycourier::SendToSlackChannel }
+
+      variant -> { Trycourier::SendToSlackEmail }
+
+      variant -> { Trycourier::SendToSlackUserID }
+
+      # @!method self.variants
+      #   @return [Array(Trycourier::Models::SendToSlackChannel, Trycourier::Models::SendToSlackEmail, Trycourier::Models::SendToSlackUserID)]
+    end
+  end
+end

data/lib/trycourier/models/slack_base_properties.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class SlackBaseProperties < Trycourier::Internal::Type::BaseModel
+      # @!attribute access_token
+      #
+      #   @return [String]
+      required :access_token, String
+
+      # @!method initialize(access_token:)
+      #   @param access_token [String]
+    end
+  end
+end

data/lib/trycourier/models/slack_recipient.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class SlackRecipient < Trycourier::Internal::Type::BaseModel
+      # @!attribute slack
+      #
+      #   @return [Trycourier::Models::SendToSlackChannel, Trycourier::Models::SendToSlackEmail, Trycourier::Models::SendToSlackUserID]
+      required :slack, union: -> { Trycourier::Slack }
+
+      # @!method initialize(slack:)
+      #   Send via Slack (channel, email, or user_id)
+      #
+      #   @param slack [Trycourier::Models::SendToSlackChannel, Trycourier::Models::SendToSlackEmail, Trycourier::Models::SendToSlackUserID]
+    end
+  end
+end

data/lib/trycourier/models/token.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class Token < Trycourier::Internal::Type::BaseModel
+      # @!attribute token
+      #
+      #   @return [String]
+      required :token, String
+
+      # @!method initialize(token:)
+      #   @param token [String]
+    end
+  end
+end

data/lib/trycourier/models/user_profile.rb

@@ -0,0 +1,274 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class UserProfile < Trycourier::Internal::Type::BaseModel
+      # @!attribute address
+      #
+      #   @return [Trycourier::Models::UserProfile::Address, nil]
+      optional :address, -> { Trycourier::UserProfile::Address }, nil?: true
+
+      # @!attribute airship
+      #
+      #   @return [Trycourier::Models::AirshipProfile, nil]
+      optional :airship, -> { Trycourier::AirshipProfile }, nil?: true
+
+      # @!attribute apn
+      #
+      #   @return [String, nil]
+      optional :apn, String, nil?: true
+
+      # @!attribute birthdate
+      #
+      #   @return [String, nil]
+      optional :birthdate, String, nil?: true
+
+      # @!attribute custom
+      #   A free form object. Due to a limitation of the API Explorer, you can only enter
+      #   string key/values below, but this API accepts more complex object structures.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :custom, Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::Unknown], nil?: true
+
+      # @!attribute discord
+      #
+      #   @return [Trycourier::Models::SendToChannel, Trycourier::Models::SendDirectMessage, nil]
+      optional :discord, union: -> { Trycourier::Discord }, nil?: true
+
+      # @!attribute email
+      #
+      #   @return [String, nil]
+      optional :email, String, nil?: true
+
+      # @!attribute email_verified
+      #
+      #   @return [Boolean, nil]
+      optional :email_verified, Trycourier::Internal::Type::Boolean, nil?: true
+
+      # @!attribute expo
+      #
+      #   @return [Trycourier::Models::Token, Trycourier::Models::MultipleTokens, nil]
+      optional :expo, union: -> { Trycourier::Expo }, nil?: true
+
+      # @!attribute facebook_psid
+      #
+      #   @return [String, nil]
+      optional :facebook_psid, String, api_name: :facebookPSID, nil?: true
+
+      # @!attribute family_name
+      #
+      #   @return [String, nil]
+      optional :family_name, String, nil?: true
+
+      # @!attribute firebase_token
+      #
+      #   @return [String, Array<String>, nil]
+      optional :firebase_token,
+               union: -> { Trycourier::UserProfileFirebaseToken },
+               api_name: :firebaseToken,
+               nil?: true
+
+      # @!attribute gender
+      #
+      #   @return [String, nil]
+      optional :gender, String, nil?: true
+
+      # @!attribute given_name
+      #
+      #   @return [String, nil]
+      optional :given_name, String, nil?: true
+
+      # @!attribute intercom
+      #
+      #   @return [Trycourier::Models::Intercom, nil]
+      optional :intercom, -> { Trycourier::Intercom }, nil?: true
+
+      # @!attribute locale
+      #
+      #   @return [String, nil]
+      optional :locale, String, nil?: true
+
+      # @!attribute middle_name
+      #
+      #   @return [String, nil]
+      optional :middle_name, String, nil?: true
+
+      # @!attribute ms_teams
+      #
+      #   @return [Trycourier::Models::SendToMsTeamsUserID, Trycourier::Models::SendToMsTeamsEmail, Trycourier::Models::SendToMsTeamsChannelID, Trycourier::Models::SendToMsTeamsConversationID, Trycourier::Models::SendToMsTeamsChannelName, nil]
+      optional :ms_teams, union: -> { Trycourier::MsTeams }, nil?: true
+
+      # @!attribute name
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!attribute nickname
+      #
+      #   @return [String, nil]
+      optional :nickname, String, nil?: true
+
+      # @!attribute phone_number
+      #
+      #   @return [String, nil]
+      optional :phone_number, String, nil?: true
+
+      # @!attribute phone_number_verified
+      #
+      #   @return [Boolean, nil]
+      optional :phone_number_verified, Trycourier::Internal::Type::Boolean, nil?: true
+
+      # @!attribute picture
+      #
+      #   @return [String, nil]
+      optional :picture, String, nil?: true
+
+      # @!attribute preferred_name
+      #
+      #   @return [String, nil]
+      optional :preferred_name, String, nil?: true
+
+      # @!attribute profile
+      #
+      #   @return [String, nil]
+      optional :profile, String, nil?: true
+
+      # @!attribute slack
+      #
+      #   @return [Trycourier::Models::SendToSlackChannel, Trycourier::Models::SendToSlackEmail, Trycourier::Models::SendToSlackUserID, nil]
+      optional :slack, union: -> { Trycourier::Slack }, nil?: true
+
+      # @!attribute sub
+      #
+      #   @return [String, nil]
+      optional :sub, String, nil?: true
+
+      # @!attribute target_arn
+      #
+      #   @return [String, nil]
+      optional :target_arn, String, nil?: true
+
+      # @!attribute updated_at
+      #
+      #   @return [String, nil]
+      optional :updated_at, String, nil?: true
+
+      # @!attribute website
+      #
+      #   @return [String, nil]
+      optional :website, String, nil?: true
+
+      # @!attribute zoneinfo
+      #
+      #   @return [String, nil]
+      optional :zoneinfo, String, nil?: true
+
+      # @!method initialize(address: nil, airship: nil, apn: nil, birthdate: nil, custom: nil, discord: nil, email: nil, email_verified: nil, expo: nil, facebook_psid: nil, family_name: nil, firebase_token: nil, gender: nil, given_name: nil, intercom: nil, locale: nil, middle_name: nil, ms_teams: nil, name: nil, nickname: nil, phone_number: nil, phone_number_verified: nil, picture: nil, preferred_name: nil, profile: nil, slack: nil, sub: nil, target_arn: nil, updated_at: nil, website: nil, zoneinfo: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Trycourier::Models::UserProfile} for more details.
+      #
+      #   @param address [Trycourier::Models::UserProfile::Address, nil]
+      #
+      #   @param airship [Trycourier::Models::AirshipProfile, nil]
+      #
+      #   @param apn [String, nil]
+      #
+      #   @param birthdate [String, nil]
+      #
+      #   @param custom [Hash{Symbol=>Object}, nil] A free form object. Due to a limitation of the API Explorer, you can only enter
+      #
+      #   @param discord [Trycourier::Models::SendToChannel, Trycourier::Models::SendDirectMessage, nil]
+      #
+      #   @param email [String, nil]
+      #
+      #   @param email_verified [Boolean, nil]
+      #
+      #   @param expo [Trycourier::Models::Token, Trycourier::Models::MultipleTokens, nil]
+      #
+      #   @param facebook_psid [String, nil]
+      #
+      #   @param family_name [String, nil]
+      #
+      #   @param firebase_token [String, Array<String>, nil]
+      #
+      #   @param gender [String, nil]
+      #
+      #   @param given_name [String, nil]
+      #
+      #   @param intercom [Trycourier::Models::Intercom, nil]
+      #
+      #   @param locale [String, nil]
+      #
+      #   @param middle_name [String, nil]
+      #
+      #   @param ms_teams [Trycourier::Models::SendToMsTeamsUserID, Trycourier::Models::SendToMsTeamsEmail, Trycourier::Models::SendToMsTeamsChannelID, Trycourier::Models::SendToMsTeamsConversationID, Trycourier::Models::SendToMsTeamsChannelName, nil]
+      #
+      #   @param name [String, nil]
+      #
+      #   @param nickname [String, nil]
+      #
+      #   @param phone_number [String, nil]
+      #
+      #   @param phone_number_verified [Boolean, nil]
+      #
+      #   @param picture [String, nil]
+      #
+      #   @param preferred_name [String, nil]
+      #
+      #   @param profile [String, nil]
+      #
+      #   @param slack [Trycourier::Models::SendToSlackChannel, Trycourier::Models::SendToSlackEmail, Trycourier::Models::SendToSlackUserID, nil]
+      #
+      #   @param sub [String, nil]
+      #
+      #   @param target_arn [String, nil]
+      #
+      #   @param updated_at [String, nil]
+      #
+      #   @param website [String, nil]
+      #
+      #   @param zoneinfo [String, nil]
+
+      # @see Trycourier::Models::UserProfile#address
+      class Address < Trycourier::Internal::Type::BaseModel
+        # @!attribute country
+        #
+        #   @return [String]
+        required :country, String
+
+        # @!attribute formatted
+        #
+        #   @return [String]
+        required :formatted, String
+
+        # @!attribute locality
+        #
+        #   @return [String]
+        required :locality, String
+
+        # @!attribute postal_code
+        #
+        #   @return [String]
+        required :postal_code, String
+
+        # @!attribute region
+        #
+        #   @return [String]
+        required :region, String
+
+        # @!attribute street_address
+        #
+        #   @return [String]
+        required :street_address, String
+
+        # @!method initialize(country:, formatted:, locality:, postal_code:, region:, street_address:)
+        #   @param country [String]
+        #   @param formatted [String]
+        #   @param locality [String]
+        #   @param postal_code [String]
+        #   @param region [String]
+        #   @param street_address [String]
+      end
+    end
+  end
+end

data/lib/trycourier/models/user_profile_firebase_token.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module UserProfileFirebaseToken
+      extend Trycourier::Internal::Type::Union
+
+      variant String
+
+      variant -> { Trycourier::Models::UserProfileFirebaseToken::StringArray }
+
+      # @!method self.variants
+      #   @return [Array(String, Array<String>)]
+
+      # @type [Trycourier::Internal::Type::Converter]
+      StringArray = Trycourier::Internal::Type::ArrayOf[String]
+    end
+  end
+end

data/lib/trycourier/models/webhook_auth_mode.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module WebhookAuthMode
+      extend Trycourier::Internal::Type::Enum
+
+      NONE = :none
+      BASIC = :basic
+      BEARER = :bearer
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/trycourier/models/webhook_authentication.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class WebhookAuthentication < Trycourier::Internal::Type::BaseModel
+      # @!attribute mode
+      #   The authentication mode to use. Defaults to 'none' if not specified.
+      #
+      #   @return [Symbol, Trycourier::Models::WebhookAuthMode]
+      required :mode, enum: -> { Trycourier::WebhookAuthMode }
+
+      # @!attribute token
+      #   Token for bearer authentication.
+      #
+      #   @return [String, nil]
+      optional :token, String, nil?: true
+
+      # @!attribute password
+      #   Password for basic authentication.
+      #
+      #   @return [String, nil]
+      optional :password, String, nil?: true
+
+      # @!attribute username
+      #   Username for basic authentication.
+      #
+      #   @return [String, nil]
+      optional :username, String, nil?: true
+
+      # @!method initialize(mode:, token: nil, password: nil, username: nil)
+      #   @param mode [Symbol, Trycourier::Models::WebhookAuthMode] The authentication mode to use. Defaults to 'none' if not specified.
+      #
+      #   @param token [String, nil] Token for bearer authentication.
+      #
+      #   @param password [String, nil] Password for basic authentication.
+      #
+      #   @param username [String, nil] Username for basic authentication.
+    end
+  end
+end

data/lib/trycourier/models/webhook_method.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module WebhookMethod
+      extend Trycourier::Internal::Type::Enum
+
+      POST = :POST
+      PUT = :PUT
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/trycourier/models/webhook_profile.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class WebhookProfile < Trycourier::Internal::Type::BaseModel
+      # @!attribute url
+      #   The URL to send the webhook request to.
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!attribute authentication
+      #   Authentication configuration for the webhook request.
+      #
+      #   @return [Trycourier::Models::WebhookAuthentication, nil]
+      optional :authentication, -> { Trycourier::WebhookAuthentication }, nil?: true
+
+      # @!attribute headers
+      #   Custom headers to include in the webhook request.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :headers, Trycourier::Internal::Type::HashOf[String], nil?: true
+
+      # @!attribute method_
+      #   The HTTP method to use for the webhook request. Defaults to POST if not
+      #   specified.
+      #
+      #   @return [Symbol, Trycourier::Models::WebhookMethod, nil]
+      optional :method_, enum: -> { Trycourier::WebhookMethod }, api_name: :method, nil?: true
+
+      # @!attribute profile
+      #   Specifies what profile information is included in the request payload. Defaults
+      #   to 'limited' if not specified.
+      #
+      #   @return [Symbol, Trycourier::Models::WebhookProfileType, nil]
+      optional :profile, enum: -> { Trycourier::WebhookProfileType }, nil?: true
+
+      # @!method initialize(url:, authentication: nil, headers: nil, method_: nil, profile: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Trycourier::Models::WebhookProfile} for more details.
+      #
+      #   @param url [String] The URL to send the webhook request to.
+      #
+      #   @param authentication [Trycourier::Models::WebhookAuthentication, nil] Authentication configuration for the webhook request.
+      #
+      #   @param headers [Hash{Symbol=>String}, nil] Custom headers to include in the webhook request.
+      #
+      #   @param method_ [Symbol, Trycourier::Models::WebhookMethod, nil] The HTTP method to use for the webhook request. Defaults to POST if not specifie
+      #
+      #   @param profile [Symbol, Trycourier::Models::WebhookProfileType, nil] Specifies what profile information is included in the request payload. Defaults
+    end
+  end
+end

data/lib/trycourier/models/webhook_profile_type.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module WebhookProfileType
+      extend Trycourier::Internal::Type::Enum
+
+      LIMITED = :limited
+      EXPANDED = :expanded
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/trycourier/models/webhook_recipient.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class WebhookRecipient < Trycourier::Internal::Type::BaseModel
+      # @!attribute webhook
+      #
+      #   @return [Trycourier::Models::WebhookProfile]
+      required :webhook, -> { Trycourier::WebhookProfile }
+
+      # @!method initialize(webhook:)
+      #   Send via webhook
+      #
+      #   @param webhook [Trycourier::Models::WebhookProfile]
+    end
+  end
+end