trycourier 3.1.4 → 3.4.0.pre.alpha0

data/lib/trycourier/models/profile_replace_params.rb

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

data/lib/trycourier/models/profile_replace_response.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    # @see Trycourier::Resources::Profiles#replace
+    class ProfileReplaceResponse < Trycourier::Internal::Type::BaseModel
+      # @!attribute status
+      #
+      #   @return [Symbol, Trycourier::Models::ProfileReplaceResponse::Status]
+      required :status, enum: -> { Trycourier::Models::ProfileReplaceResponse::Status }
+
+      # @!method initialize(status:)
+      #   @param status [Symbol, Trycourier::Models::ProfileReplaceResponse::Status]
+
+      # @see Trycourier::Models::ProfileReplaceResponse#status
+      module Status
+        extend Trycourier::Internal::Type::Enum
+
+        SUCCESS = :SUCCESS
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/trycourier/models/profile_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    # @see Trycourier::Resources::Profiles#retrieve
+    class ProfileRetrieveParams < 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/profile_retrieve_response.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    # @see Trycourier::Resources::Profiles#retrieve
+    class ProfileRetrieveResponse < Trycourier::Internal::Type::BaseModel
+      # @!attribute profile
+      #
+      #   @return [Hash{Symbol=>Object}]
+      required :profile, Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::Unknown]
+
+      # @!attribute preferences
+      #
+      #   @return [Trycourier::Models::RecipientPreferences, nil]
+      optional :preferences, -> { Trycourier::RecipientPreferences }, nil?: true
+
+      # @!method initialize(profile:, preferences: nil)
+      #   @param profile [Hash{Symbol=>Object}]
+      #   @param preferences [Trycourier::Models::RecipientPreferences, nil]
+    end
+  end
+end

data/lib/trycourier/models/profile_update_params.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    # @see Trycourier::Resources::Profiles#update
+    class ProfileUpdateParams < Trycourier::Internal::Type::BaseModel
+      extend Trycourier::Internal::Type::RequestParameters::Converter
+      include Trycourier::Internal::Type::RequestParameters
+
+      # @!attribute patch
+      #   List of patch operations to apply to the profile.
+      #
+      #   @return [Array<Trycourier::Models::ProfileUpdateParams::Patch>]
+      required :patch, -> { Trycourier::Internal::Type::ArrayOf[Trycourier::ProfileUpdateParams::Patch] }
+
+      # @!method initialize(patch:, request_options: {})
+      #   @param patch [Array<Trycourier::Models::ProfileUpdateParams::Patch>] List of patch operations to apply to the profile.
+      #
+      #   @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]
+        required :value, String
+
+        # @!method initialize(op:, path:, value:)
+        #   @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] The value for the operation.
+      end
+    end
+  end
+end

data/lib/trycourier/models/profiles/list_delete_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module Profiles
+      # @see Trycourier::Resources::Profiles::Lists#delete
+      class ListDeleteParams < 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/profiles/list_delete_response.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module Profiles
+      # @see Trycourier::Resources::Profiles::Lists#delete
+      class ListDeleteResponse < Trycourier::Internal::Type::BaseModel
+        # @!attribute status
+        #
+        #   @return [Symbol, Trycourier::Models::Profiles::ListDeleteResponse::Status]
+        required :status, enum: -> { Trycourier::Models::Profiles::ListDeleteResponse::Status }
+
+        # @!method initialize(status:)
+        #   @param status [Symbol, Trycourier::Models::Profiles::ListDeleteResponse::Status]
+
+        # @see Trycourier::Models::Profiles::ListDeleteResponse#status
+        module Status
+          extend Trycourier::Internal::Type::Enum
+
+          SUCCESS = :SUCCESS
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/trycourier/models/profiles/list_retrieve_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module Profiles
+      # @see Trycourier::Resources::Profiles::Lists#retrieve
+      class ListRetrieveParams < Trycourier::Internal::Type::BaseModel
+        extend Trycourier::Internal::Type::RequestParameters::Converter
+        include Trycourier::Internal::Type::RequestParameters
+
+        # @!attribute cursor
+        #   A unique identifier that allows for fetching the next set of message statuses.
+        #
+        #   @return [String, nil]
+        optional :cursor, String, nil?: true
+
+        # @!method initialize(cursor: nil, request_options: {})
+        #   @param cursor [String, nil] A unique identifier that allows for fetching the next set of message statuses.
+        #
+        #   @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/trycourier/models/profiles/list_retrieve_response.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module Profiles
+      # @see Trycourier::Resources::Profiles::Lists#retrieve
+      class ListRetrieveResponse < Trycourier::Internal::Type::BaseModel
+        # @!attribute paging
+        #
+        #   @return [Trycourier::Models::Paging]
+        required :paging, -> { Trycourier::Paging }
+
+        # @!attribute results
+        #   An array of lists
+        #
+        #   @return [Array<Trycourier::Models::Profiles::ListRetrieveResponse::Result>]
+        required :results,
+                 -> { Trycourier::Internal::Type::ArrayOf[Trycourier::Models::Profiles::ListRetrieveResponse::Result] }
+
+        # @!method initialize(paging:, results:)
+        #   @param paging [Trycourier::Models::Paging]
+        #
+        #   @param results [Array<Trycourier::Models::Profiles::ListRetrieveResponse::Result>] An array of lists
+
+        class Result < Trycourier::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute created
+          #   The date/time of when the list was created. Represented as a string in ISO
+          #   format.
+          #
+          #   @return [String]
+          required :created, String
+
+          # @!attribute name
+          #   List name
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute updated
+          #   The date/time of when the list was updated. Represented as a string in ISO
+          #   format.
+          #
+          #   @return [String]
+          required :updated, String
+
+          # @!attribute preferences
+          #
+          #   @return [Trycourier::Models::RecipientPreferences, nil]
+          optional :preferences, -> { Trycourier::RecipientPreferences }, nil?: true
+
+          # @!method initialize(id:, created:, name:, updated:, preferences: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Trycourier::Models::Profiles::ListRetrieveResponse::Result} for more details.
+          #
+          #   @param id [String]
+          #
+          #   @param created [String] The date/time of when the list was created. Represented as a string in ISO forma
+          #
+          #   @param name [String] List name
+          #
+          #   @param updated [String] The date/time of when the list was updated. Represented as a string in ISO forma
+          #
+          #   @param preferences [Trycourier::Models::RecipientPreferences, nil]
+        end
+      end
+    end
+  end
+end

data/lib/trycourier/models/profiles/list_subscribe_params.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module Profiles
+      # @see Trycourier::Resources::Profiles::Lists#subscribe
+      class ListSubscribeParams < Trycourier::Internal::Type::BaseModel
+        extend Trycourier::Internal::Type::RequestParameters::Converter
+        include Trycourier::Internal::Type::RequestParameters
+
+        # @!attribute lists
+        #
+        #   @return [Array<Trycourier::Models::Profiles::ListSubscribeParams::List>]
+        required :lists,
+                 -> { Trycourier::Internal::Type::ArrayOf[Trycourier::Profiles::ListSubscribeParams::List] }
+
+        # @!method initialize(lists:, request_options: {})
+        #   @param lists [Array<Trycourier::Models::Profiles::ListSubscribeParams::List>]
+        #   @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}]
+
+        class List < Trycourier::Internal::Type::BaseModel
+          # @!attribute list_id
+          #
+          #   @return [String]
+          required :list_id, String, api_name: :listId
+
+          # @!attribute preferences
+          #
+          #   @return [Trycourier::Models::RecipientPreferences, nil]
+          optional :preferences, -> { Trycourier::RecipientPreferences }, nil?: true
+
+          # @!method initialize(list_id:, preferences: nil)
+          #   @param list_id [String]
+          #   @param preferences [Trycourier::Models::RecipientPreferences, nil]
+        end
+      end
+    end
+  end
+end

data/lib/trycourier/models/profiles/list_subscribe_response.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    module Profiles
+      # @see Trycourier::Resources::Profiles::Lists#subscribe
+      class ListSubscribeResponse < Trycourier::Internal::Type::BaseModel
+        # @!attribute status
+        #
+        #   @return [Symbol, Trycourier::Models::Profiles::ListSubscribeResponse::Status]
+        required :status, enum: -> { Trycourier::Models::Profiles::ListSubscribeResponse::Status }
+
+        # @!method initialize(status:)
+        #   @param status [Symbol, Trycourier::Models::Profiles::ListSubscribeResponse::Status]
+
+        # @see Trycourier::Models::Profiles::ListSubscribeResponse#status
+        module Status
+          extend Trycourier::Internal::Type::Enum
+
+          SUCCESS = :SUCCESS
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/trycourier/models/put_subscriptions_recipient.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class PutSubscriptionsRecipient < Trycourier::Internal::Type::BaseModel
+      # @!attribute recipient_id
+      #
+      #   @return [String]
+      required :recipient_id, String, api_name: :recipientId
+
+      # @!attribute preferences
+      #
+      #   @return [Trycourier::Models::RecipientPreferences, nil]
+      optional :preferences, -> { Trycourier::RecipientPreferences }, nil?: true
+
+      # @!method initialize(recipient_id:, preferences: nil)
+      #   @param recipient_id [String]
+      #   @param preferences [Trycourier::Models::RecipientPreferences, nil]
+    end
+  end
+end

data/lib/trycourier/models/recipient.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class Recipient < 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::Recipient::Preferences, nil]
+      optional :preferences, -> { Trycourier::Recipient::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::Recipient} 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::Recipient::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::Recipient#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/recipient_preferences.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class RecipientPreferences < Trycourier::Internal::Type::BaseModel
+      # @!attribute categories
+      #
+      #   @return [Hash{Symbol=>Trycourier::Models::NotificationPreferenceDetails}, nil]
+      optional :categories,
+               -> { Trycourier::Internal::Type::HashOf[Trycourier::NotificationPreferenceDetails] },
+               nil?: true
+
+      # @!attribute notifications
+      #
+      #   @return [Hash{Symbol=>Trycourier::Models::NotificationPreferenceDetails}, nil]
+      optional :notifications,
+               -> { Trycourier::Internal::Type::HashOf[Trycourier::NotificationPreferenceDetails] },
+               nil?: true
+
+      # @!method initialize(categories: nil, notifications: nil)
+      #   @param categories [Hash{Symbol=>Trycourier::Models::NotificationPreferenceDetails}, nil]
+      #   @param notifications [Hash{Symbol=>Trycourier::Models::NotificationPreferenceDetails}, nil]
+    end
+  end
+end

data/lib/trycourier/models/request_archive_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    # @see Trycourier::Resources::Requests#archive
+    class RequestArchiveParams < 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/rule.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Models
+    class Rule < Trycourier::Internal::Type::BaseModel
+      # @!attribute until_
+      #
+      #   @return [String]
+      required :until_, String, api_name: :until
+
+      # @!attribute start
+      #
+      #   @return [String, nil]
+      optional :start, String, nil?: true
+
+      # @!method initialize(until_:, start: nil)
+      #   @param until_ [String]
+      #   @param start [String, nil]
+    end
+  end
+end