trycourier 4.6.2 → 4.6.3

data/lib/courier/internal.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Courier
+  module Internal
+    extend Courier::Internal::Util::SorbetRuntimeSupport
+
+    OMIT =
+      Object.new.tap do
+        _1.define_singleton_method(:inspect) { "#<#{Courier::Internal}::OMIT>" }
+      end
+        .freeze
+
+    define_sorbet_constant!(:AnyHash) do
+      T.type_alias { T::Hash[Symbol, T.anything] }
+    end
+    define_sorbet_constant!(:FileInput) do
+      T.type_alias { T.any(Pathname, StringIO, IO, String, Courier::FilePart) }
+    end
+  end
+end

data/lib/courier/models/airship_profile.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class AirshipProfile < Courier::Internal::Type::BaseModel
+      # @!attribute audience
+      #
+      #   @return [Courier::Models::AirshipProfileAudience]
+      required :audience, -> { Courier::AirshipProfileAudience }
+
+      # @!attribute device_types
+      #
+      #   @return [Array<String>]
+      required :device_types, Courier::Internal::Type::ArrayOf[String]
+
+      # @!method initialize(audience:, device_types:)
+      #   @param audience [Courier::Models::AirshipProfileAudience]
+      #   @param device_types [Array<String>]
+    end
+  end
+end

data/lib/courier/models/airship_profile_audience.rb

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

data/lib/courier/models/alignment.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    module Alignment
+      extend Courier::Internal::Type::Enum
+
+      CENTER = :center
+      LEFT = :left
+      RIGHT = :right
+      FULL = :full
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/courier/models/audience.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Audiences#retrieve
+    class Audience < Courier::Internal::Type::BaseModel
+      # @!attribute id
+      #   A unique identifier representing the audience_id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #
+      #   @return [String]
+      required :created_at, String
+
+      # @!attribute description
+      #   A description of the audience
+      #
+      #   @return [String]
+      required :description, String
+
+      # @!attribute name
+      #   The name of the audience
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute updated_at
+      #
+      #   @return [String]
+      required :updated_at, String
+
+      # @!attribute filter
+      #   Filter configuration for audience membership containing an array of filter rules
+      #
+      #   @return [Courier::Models::AudienceFilterConfig, nil]
+      optional :filter, -> { Courier::AudienceFilterConfig }, nil?: true
+
+      # @!attribute operator
+      #   The logical operator (AND/OR) for the top-level filter
+      #
+      #   @return [Symbol, Courier::Models::Audience::Operator, nil]
+      optional :operator, enum: -> { Courier::Audience::Operator }
+
+      # @!method initialize(id:, created_at:, description:, name:, updated_at:, filter: nil, operator: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::Audience} for more details.
+      #
+      #   @param id [String] A unique identifier representing the audience_id
+      #
+      #   @param created_at [String]
+      #
+      #   @param description [String] A description of the audience
+      #
+      #   @param name [String] The name of the audience
+      #
+      #   @param updated_at [String]
+      #
+      #   @param filter [Courier::Models::AudienceFilterConfig, nil] Filter configuration for audience membership containing an array of filter rules
+      #
+      #   @param operator [Symbol, Courier::Models::Audience::Operator] The logical operator (AND/OR) for the top-level filter
+
+      # The logical operator (AND/OR) for the top-level filter
+      #
+      # @see Courier::Models::Audience#operator
+      module Operator
+        extend Courier::Internal::Type::Enum
+
+        AND = :AND
+        OR = :OR
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/audience_delete_params.rb

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

data/lib/courier/models/audience_filter.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class AudienceFilter < Courier::Internal::Type::BaseModel
+      # @!attribute operator
+      #   Send to users only if they are member of the account
+      #
+      #   @return [Symbol, Courier::Models::AudienceFilter::Operator]
+      required :operator, enum: -> { Courier::AudienceFilter::Operator }
+
+      # @!attribute path
+      #
+      #   @return [Symbol, Courier::Models::AudienceFilter::Path]
+      required :path, enum: -> { Courier::AudienceFilter::Path }
+
+      # @!attribute value
+      #
+      #   @return [String]
+      required :value, String
+
+      # @!method initialize(operator:, path:, value:)
+      #   @param operator [Symbol, Courier::Models::AudienceFilter::Operator] Send to users only if they are member of the account
+      #
+      #   @param path [Symbol, Courier::Models::AudienceFilter::Path]
+      #
+      #   @param value [String]
+
+      # Send to users only if they are member of the account
+      #
+      # @see Courier::Models::AudienceFilter#operator
+      module Operator
+        extend Courier::Internal::Type::Enum
+
+        MEMBER_OF = :MEMBER_OF
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Courier::Models::AudienceFilter#path
+      module Path
+        extend Courier::Internal::Type::Enum
+
+        ACCOUNT_ID = :account_id
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/audience_filter_config.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class AudienceFilterConfig < Courier::Internal::Type::BaseModel
+      # @!attribute filters
+      #   Array of filter rules (single conditions or nested groups)
+      #
+      #   @return [Array<Courier::Models::FilterConfig>]
+      required :filters, -> { Courier::Internal::Type::ArrayOf[Courier::FilterConfig] }
+
+      # @!method initialize(filters:)
+      #   Filter configuration for audience membership containing an array of filter rules
+      #
+      #   @param filters [Array<Courier::Models::FilterConfig>] Array of filter rules (single conditions or nested groups)
+    end
+  end
+end

data/lib/courier/models/audience_list_members_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Audiences#list_members
+    class AudienceListMembersParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute cursor
+      #   A unique identifier that allows for fetching the next set of members
+      #
+      #   @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 members
+      #
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/audience_list_members_response.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Audiences#list_members
+    class AudienceListMembersResponse < Courier::Internal::Type::BaseModel
+      # @!attribute items
+      #
+      #   @return [Array<Courier::Models::AudienceListMembersResponse::Item>]
+      required :items,
+               -> { Courier::Internal::Type::ArrayOf[Courier::Models::AudienceListMembersResponse::Item] }
+
+      # @!attribute paging
+      #
+      #   @return [Courier::Models::Paging]
+      required :paging, -> { Courier::Paging }
+
+      # @!method initialize(items:, paging:)
+      #   @param items [Array<Courier::Models::AudienceListMembersResponse::Item>]
+      #   @param paging [Courier::Models::Paging]
+
+      class Item < Courier::Internal::Type::BaseModel
+        # @!attribute added_at
+        #
+        #   @return [String]
+        required :added_at, String
+
+        # @!attribute audience_id
+        #
+        #   @return [String]
+        required :audience_id, String
+
+        # @!attribute audience_version
+        #
+        #   @return [Integer]
+        required :audience_version, Integer
+
+        # @!attribute member_id
+        #
+        #   @return [String]
+        required :member_id, String
+
+        # @!attribute reason
+        #
+        #   @return [String]
+        required :reason, String
+
+        # @!method initialize(added_at:, audience_id:, audience_version:, member_id:, reason:)
+        #   @param added_at [String]
+        #   @param audience_id [String]
+        #   @param audience_version [Integer]
+        #   @param member_id [String]
+        #   @param reason [String]
+      end
+    end
+  end
+end

data/lib/courier/models/audience_list_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Audiences#list
+    class AudienceListParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute cursor
+      #   A unique identifier that allows for fetching the next set of audiences
+      #
+      #   @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 audiences
+      #
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/audience_list_response.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Audiences#list
+    class AudienceListResponse < Courier::Internal::Type::BaseModel
+      # @!attribute items
+      #
+      #   @return [Array<Courier::Models::Audience>]
+      required :items, -> { Courier::Internal::Type::ArrayOf[Courier::Audience] }
+
+      # @!attribute paging
+      #
+      #   @return [Courier::Models::Paging]
+      required :paging, -> { Courier::Paging }
+
+      # @!method initialize(items:, paging:)
+      #   @param items [Array<Courier::Models::Audience>]
+      #   @param paging [Courier::Models::Paging]
+    end
+  end
+end

data/lib/courier/models/audience_recipient.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class AudienceRecipient < Courier::Internal::Type::BaseModel
+      # @!attribute audience_id
+      #   A unique identifier associated with an Audience. A message will be sent to each
+      #   user in the audience.
+      #
+      #   @return [String]
+      required :audience_id, String
+
+      # @!attribute data
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :data, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown], nil?: true
+
+      # @!attribute filters
+      #
+      #   @return [Array<Courier::Models::AudienceFilter>, nil]
+      optional :filters, -> { Courier::Internal::Type::ArrayOf[Courier::AudienceFilter] }, nil?: true
+
+      # @!method initialize(audience_id:, data: nil, filters: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::AudienceRecipient} for more details.
+      #
+      #   Send to all users in an audience
+      #
+      #   @param audience_id [String] A unique identifier associated with an Audience. A message will be sent to each
+      #
+      #   @param data [Hash{Symbol=>Object}, nil]
+      #
+      #   @param filters [Array<Courier::Models::AudienceFilter>, nil]
+    end
+  end
+end

data/lib/courier/models/audience_retrieve_params.rb

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

data/lib/courier/models/audience_update_params.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Audiences#update
+    class AudienceUpdateParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute description
+      #   A description of the audience
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute filter
+      #   Filter configuration for audience membership containing an array of filter rules
+      #
+      #   @return [Courier::Models::AudienceFilterConfig, nil]
+      optional :filter, -> { Courier::AudienceFilterConfig }, nil?: true
+
+      # @!attribute name
+      #   The name of the audience
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!attribute operator
+      #   The logical operator (AND/OR) for the top-level filter
+      #
+      #   @return [Symbol, Courier::Models::AudienceUpdateParams::Operator, nil]
+      optional :operator, enum: -> { Courier::AudienceUpdateParams::Operator }, nil?: true
+
+      # @!method initialize(description: nil, filter: nil, name: nil, operator: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::AudienceUpdateParams} for more details.
+      #
+      #   @param description [String, nil] A description of the audience
+      #
+      #   @param filter [Courier::Models::AudienceFilterConfig, nil] Filter configuration for audience membership containing an array of filter rules
+      #
+      #   @param name [String, nil] The name of the audience
+      #
+      #   @param operator [Symbol, Courier::Models::AudienceUpdateParams::Operator, nil] The logical operator (AND/OR) for the top-level filter
+      #
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+
+      # The logical operator (AND/OR) for the top-level filter
+      module Operator
+        extend Courier::Internal::Type::Enum
+
+        AND = :AND
+        OR = :OR
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/audience_update_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Audiences#update
+    class AudienceUpdateResponse < Courier::Internal::Type::BaseModel
+      # @!attribute audience
+      #
+      #   @return [Courier::Models::Audience]
+      required :audience, -> { Courier::Audience }
+
+      # @!method initialize(audience:)
+      #   @param audience [Courier::Models::Audience]
+    end
+  end
+end

data/lib/courier/models/audit_event.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::AuditEvents#retrieve
+    class AuditEvent < Courier::Internal::Type::BaseModel
+      # @!attribute actor
+      #
+      #   @return [Courier::Models::AuditEvent::Actor]
+      required :actor, -> { Courier::AuditEvent::Actor }
+
+      # @!attribute audit_event_id
+      #
+      #   @return [String]
+      required :audit_event_id, String, api_name: :auditEventId
+
+      # @!attribute source
+      #
+      #   @return [String]
+      required :source, String
+
+      # @!attribute target
+      #
+      #   @return [String]
+      required :target, String
+
+      # @!attribute timestamp
+      #
+      #   @return [String]
+      required :timestamp, String
+
+      # @!attribute type
+      #
+      #   @return [String]
+      required :type, String
+
+      # @!method initialize(actor:, audit_event_id:, source:, target:, timestamp:, type:)
+      #   @param actor [Courier::Models::AuditEvent::Actor]
+      #   @param audit_event_id [String]
+      #   @param source [String]
+      #   @param target [String]
+      #   @param timestamp [String]
+      #   @param type [String]
+
+      # @see Courier::Models::AuditEvent#actor
+      class Actor < Courier::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute email
+        #
+        #   @return [String, nil]
+        optional :email, String, nil?: true
+
+        # @!method initialize(id:, email: nil)
+        #   @param id [String]
+        #   @param email [String, nil]
+      end
+    end
+  end
+end

data/lib/courier/models/audit_event_list_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::AuditEvents#list
+    class AuditEventListParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute cursor
+      #   A unique identifier that allows for fetching the next set of audit events.
+      #
+      #   @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 audit events.
+      #
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/audit_event_list_response.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::AuditEvents#list
+    class AuditEventListResponse < Courier::Internal::Type::BaseModel
+      # @!attribute paging
+      #
+      #   @return [Courier::Models::Paging]
+      required :paging, -> { Courier::Paging }
+
+      # @!attribute results
+      #
+      #   @return [Array<Courier::Models::AuditEvent>]
+      required :results, -> { Courier::Internal::Type::ArrayOf[Courier::AuditEvent] }
+
+      # @!method initialize(paging:, results:)
+      #   @param paging [Courier::Models::Paging]
+      #   @param results [Array<Courier::Models::AuditEvent>]
+    end
+  end
+end

data/lib/courier/models/audit_event_retrieve_params.rb

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

data/lib/courier/models/auth_issue_token_params.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Auth#issue_token
+    class AuthIssueTokenParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute expires_in
+      #   Duration for token expiration. Accepts various time formats:
+      #
+      #   - "2 hours" - 2 hours from now
+      #   - "1d" - 1 day
+      #   - "3 days" - 3 days
+      #   - "10h" - 10 hours
+      #   - "2.5 hrs" - 2.5 hours
+      #   - "1m" - 1 minute
+      #   - "5s" - 5 seconds
+      #   - "1y" - 1 year
+      #
+      #   @return [String]
+      required :expires_in, String
+
+      # @!attribute scope
+      #   Available scopes:
+      #
+      #   - `user_id:<user-id>` - Defines which user the token will be scoped to. Multiple
+      #     can be listed if needed. Ex `user_id:pigeon user_id:bluebird`.
+      #   - `read:messages` - Read messages.
+      #   - `read:user-tokens` - Read user push tokens.
+      #   - `write:user-tokens` - Write user push tokens.
+      #   - `read:brands[:<brand_id>]` - Read brands, optionally restricted to a specific
+      #     brand_id. Examples `read:brands`, `read:brands:my_brand`.
+      #   - `write:brands[:<brand_id>]` - Write brands, optionally restricted to a
+      #     specific brand_id. Examples `write:brands`, `write:brands:my_brand`.
+      #   - `inbox:read:messages` - Read inbox messages.
+      #   - `inbox:write:events` - Write inbox events, such as mark message as read.
+      #   - `read:preferences` - Read user preferences.
+      #   - `write:preferences` - Write user preferences. Example:
+      #     `user_id:user123 write:user-tokens inbox:read:messages inbox:write:events read:preferences write:preferences read:brands`
+      #
+      #   @return [String]
+      required :scope, String
+
+      # @!method initialize(expires_in:, scope:, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::AuthIssueTokenParams} for more details.
+      #
+      #   @param expires_in [String] Duration for token expiration. Accepts various time formats:
+      #
+      #   @param scope [String] Available scopes:
+      #
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end