knockapi 0.6.1 → 1.0.0

data/lib/knockapi/models/tenant.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Tenants#list
+    class Tenant < Knockapi::Internal::Type::BaseModel
+      # @!attribute id
+      #   The unique identifier for the tenant.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute _typename
+      #   The typename of the schema.
+      #
+      #   @return [String]
+      required :_typename, String, api_name: :__typename
+
+      # @!attribute name
+      #   An optional name for the tenant.
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!attribute settings
+      #   The settings for the tenant. Includes branding and preference set.
+      #
+      #   @return [Knockapi::Models::Tenant::Settings, nil]
+      optional :settings, -> { Knockapi::Models::Tenant::Settings }, nil?: true
+
+      # @!method initialize(id:, _typename:, name: nil, settings: nil)
+      #   A tenant entity.
+      #
+      #   @param id [String] The unique identifier for the tenant.
+      #
+      #   @param _typename [String] The typename of the schema.
+      #
+      #   @param name [String, nil] An optional name for the tenant.
+      #
+      #   @param settings [Knockapi::Models::Tenant::Settings, nil] The settings for the tenant. Includes branding and preference set.
+
+      # @see Knockapi::Models::Tenant#settings
+      class Settings < Knockapi::Internal::Type::BaseModel
+        # @!attribute branding
+        #   The branding for the tenant.
+        #
+        #   @return [Knockapi::Models::Tenant::Settings::Branding, nil]
+        optional :branding, -> { Knockapi::Models::Tenant::Settings::Branding }, nil?: true
+
+        # @!attribute preference_set
+        #   A preference set represents a specific set of notification preferences for a
+        #   recipient. A recipient can have multiple preference sets.
+        #
+        #   @return [Knockapi::Models::Recipients::PreferenceSet, nil]
+        optional :preference_set, -> { Knockapi::Models::Recipients::PreferenceSet }, nil?: true
+
+        # @!method initialize(branding: nil, preference_set: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Knockapi::Models::Tenant::Settings} for more details.
+        #
+        #   The settings for the tenant. Includes branding and preference set.
+        #
+        #   @param branding [Knockapi::Models::Tenant::Settings::Branding, nil] The branding for the tenant.
+        #
+        #   @param preference_set [Knockapi::Models::Recipients::PreferenceSet, nil] A preference set represents a specific set of notification preferences for a rec
+        #   ...
+
+        # @see Knockapi::Models::Tenant::Settings#branding
+        class Branding < Knockapi::Internal::Type::BaseModel
+          # @!attribute icon_url
+          #   The icon URL for the tenant. Must point to a valid image with an image MIME
+          #   type.
+          #
+          #   @return [String, nil]
+          optional :icon_url, String, nil?: true
+
+          # @!attribute logo_url
+          #   The logo URL for the tenant. Must point to a valid image with an image MIME
+          #   type.
+          #
+          #   @return [String, nil]
+          optional :logo_url, String, nil?: true
+
+          # @!attribute primary_color
+          #   The primary color for the tenant, provided as a hex value.
+          #
+          #   @return [String, nil]
+          optional :primary_color, String, nil?: true
+
+          # @!attribute primary_color_contrast
+          #   The primary color contrast for the tenant, provided as a hex value.
+          #
+          #   @return [String, nil]
+          optional :primary_color_contrast, String, nil?: true
+
+          # @!method initialize(icon_url: nil, logo_url: nil, primary_color: nil, primary_color_contrast: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Knockapi::Models::Tenant::Settings::Branding} for more details.
+          #
+          #   The branding for the tenant.
+          #
+          #   @param icon_url [String, nil] The icon URL for the tenant. Must point to a valid image with an image MIME type
+          #   ...
+          #
+          #   @param logo_url [String, nil] The logo URL for the tenant. Must point to a valid image with an image MIME type
+          #   ...
+          #
+          #   @param primary_color [String, nil] The primary color for the tenant, provided as a hex value.
+          #
+          #   @param primary_color_contrast [String, nil] The primary color contrast for the tenant, provided as a hex value.
+        end
+      end
+    end
+  end
+end

data/lib/knockapi/models/tenant_delete_params.rb

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

data/lib/knockapi/models/tenant_get_params.rb

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

data/lib/knockapi/models/tenant_list_params.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Tenants#list
+    class TenantListParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!attribute after
+      #   The cursor to fetch entries after.
+      #
+      #   @return [String, nil]
+      optional :after, String
+
+      # @!attribute before
+      #   The cursor to fetch entries before.
+      #
+      #   @return [String, nil]
+      optional :before, String
+
+      # @!attribute name
+      #   Filter tenants by name.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute page_size
+      #   The number of items per page.
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!attribute tenant_id
+      #   Filter tenants by ID.
+      #
+      #   @return [String, nil]
+      optional :tenant_id, String
+
+      # @!method initialize(after: nil, before: nil, name: nil, page_size: nil, tenant_id: nil, request_options: {})
+      #   @param after [String] The cursor to fetch entries after.
+      #
+      #   @param before [String] The cursor to fetch entries before.
+      #
+      #   @param name [String] Filter tenants by name.
+      #
+      #   @param page_size [Integer] The number of items per page.
+      #
+      #   @param tenant_id [String] Filter tenants by ID.
+      #
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/knockapi/models/tenant_request.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    class TenantRequest < Knockapi::Internal::Type::BaseModel
+      # @!attribute id
+      #   The unique identifier for the tenant.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute channel_data
+      #   A request to set channel data for a type of channel inline.
+      #
+      #   @return [Hash{Symbol=>Knockapi::Models::Recipients::ChannelDataRequest}, nil]
+      optional :channel_data,
+               -> { Knockapi::Internal::Type::HashOf[Knockapi::Models::Recipients::ChannelDataRequest] },
+               nil?: true
+
+      # @!attribute preferences
+      #   Inline set preferences for a recipient, where the key is the preference set id.
+      #
+      #   @return [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil]
+      optional :preferences,
+               -> { Knockapi::Internal::Type::HashOf[Knockapi::Models::Recipients::PreferenceSetRequest] },
+               nil?: true
+
+      # @!attribute settings
+      #   The settings for the tenant. Includes branding and preference set.
+      #
+      #   @return [Knockapi::Models::TenantRequest::Settings, nil]
+      optional :settings, -> { Knockapi::Models::TenantRequest::Settings }
+
+      # @!method initialize(id:, channel_data: nil, preferences: nil, settings: nil)
+      #   A tenant to be set in the system. You can supply any additional properties on
+      #   the tenant object.
+      #
+      #   @param id [String] The unique identifier for the tenant.
+      #
+      #   @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::ChannelDataRequest}, nil] A request to set channel data for a type of channel inline.
+      #
+      #   @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
+      #
+      #   @param settings [Knockapi::Models::TenantRequest::Settings] The settings for the tenant. Includes branding and preference set.
+
+      # @see Knockapi::Models::TenantRequest#settings
+      class Settings < Knockapi::Internal::Type::BaseModel
+        # @!attribute branding
+        #   The branding for the tenant.
+        #
+        #   @return [Knockapi::Models::TenantRequest::Settings::Branding, nil]
+        optional :branding, -> { Knockapi::Models::TenantRequest::Settings::Branding }
+
+        # @!attribute preference_set
+        #   A request to set a preference set for a recipient.
+        #
+        #   @return [Knockapi::Models::Recipients::PreferenceSetRequest, nil]
+        optional :preference_set, -> { Knockapi::Models::Recipients::PreferenceSetRequest }, nil?: true
+
+        # @!method initialize(branding: nil, preference_set: nil)
+        #   The settings for the tenant. Includes branding and preference set.
+        #
+        #   @param branding [Knockapi::Models::TenantRequest::Settings::Branding] The branding for the tenant.
+        #
+        #   @param preference_set [Knockapi::Models::Recipients::PreferenceSetRequest, nil] A request to set a preference set for a recipient.
+
+        # @see Knockapi::Models::TenantRequest::Settings#branding
+        class Branding < Knockapi::Internal::Type::BaseModel
+          # @!attribute icon_url
+          #   The icon URL for the tenant. Must point to a valid image with an image MIME
+          #   type.
+          #
+          #   @return [String, nil]
+          optional :icon_url, String, nil?: true
+
+          # @!attribute logo_url
+          #   The logo URL for the tenant. Must point to a valid image with an image MIME
+          #   type.
+          #
+          #   @return [String, nil]
+          optional :logo_url, String, nil?: true
+
+          # @!attribute primary_color
+          #   The primary color for the tenant, provided as a hex value.
+          #
+          #   @return [String, nil]
+          optional :primary_color, String, nil?: true
+
+          # @!attribute primary_color_contrast
+          #   The primary color contrast for the tenant, provided as a hex value.
+          #
+          #   @return [String, nil]
+          optional :primary_color_contrast, String, nil?: true
+
+          # @!method initialize(icon_url: nil, logo_url: nil, primary_color: nil, primary_color_contrast: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Knockapi::Models::TenantRequest::Settings::Branding} for more details.
+          #
+          #   The branding for the tenant.
+          #
+          #   @param icon_url [String, nil] The icon URL for the tenant. Must point to a valid image with an image MIME type
+          #   ...
+          #
+          #   @param logo_url [String, nil] The logo URL for the tenant. Must point to a valid image with an image MIME type
+          #   ...
+          #
+          #   @param primary_color [String, nil] The primary color for the tenant, provided as a hex value.
+          #
+          #   @param primary_color_contrast [String, nil] The primary color contrast for the tenant, provided as a hex value.
+        end
+      end
+    end
+  end
+end

data/lib/knockapi/models/tenant_set_params.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Tenants#set
+    class TenantSetParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!attribute channel_data
+      #   A request to set channel data for a type of channel inline.
+      #
+      #   @return [Hash{Symbol=>Knockapi::Models::Recipients::ChannelDataRequest}, nil]
+      optional :channel_data,
+               -> { Knockapi::Internal::Type::HashOf[Knockapi::Models::Recipients::ChannelDataRequest] },
+               nil?: true
+
+      # @!attribute preferences
+      #   Inline set preferences for a recipient, where the key is the preference set id.
+      #
+      #   @return [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil]
+      optional :preferences,
+               -> { Knockapi::Internal::Type::HashOf[Knockapi::Models::Recipients::PreferenceSetRequest] },
+               nil?: true
+
+      # @!attribute settings
+      #   The settings for the tenant. Includes branding and preference set.
+      #
+      #   @return [Knockapi::Models::TenantSetParams::Settings, nil]
+      optional :settings, -> { Knockapi::Models::TenantSetParams::Settings }
+
+      # @!method initialize(channel_data: nil, preferences: nil, settings: nil, request_options: {})
+      #   @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::ChannelDataRequest}, nil] A request to set channel data for a type of channel inline.
+      #
+      #   @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
+      #
+      #   @param settings [Knockapi::Models::TenantSetParams::Settings] The settings for the tenant. Includes branding and preference set.
+      #
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+
+      class Settings < Knockapi::Internal::Type::BaseModel
+        # @!attribute branding
+        #   The branding for the tenant.
+        #
+        #   @return [Knockapi::Models::TenantSetParams::Settings::Branding, nil]
+        optional :branding, -> { Knockapi::Models::TenantSetParams::Settings::Branding }
+
+        # @!attribute preference_set
+        #   A request to set a preference set for a recipient.
+        #
+        #   @return [Knockapi::Models::Recipients::PreferenceSetRequest, nil]
+        optional :preference_set, -> { Knockapi::Models::Recipients::PreferenceSetRequest }, nil?: true
+
+        # @!method initialize(branding: nil, preference_set: nil)
+        #   The settings for the tenant. Includes branding and preference set.
+        #
+        #   @param branding [Knockapi::Models::TenantSetParams::Settings::Branding] The branding for the tenant.
+        #
+        #   @param preference_set [Knockapi::Models::Recipients::PreferenceSetRequest, nil] A request to set a preference set for a recipient.
+
+        # @see Knockapi::Models::TenantSetParams::Settings#branding
+        class Branding < Knockapi::Internal::Type::BaseModel
+          # @!attribute icon_url
+          #   The icon URL for the tenant. Must point to a valid image with an image MIME
+          #   type.
+          #
+          #   @return [String, nil]
+          optional :icon_url, String, nil?: true
+
+          # @!attribute logo_url
+          #   The logo URL for the tenant. Must point to a valid image with an image MIME
+          #   type.
+          #
+          #   @return [String, nil]
+          optional :logo_url, String, nil?: true
+
+          # @!attribute primary_color
+          #   The primary color for the tenant, provided as a hex value.
+          #
+          #   @return [String, nil]
+          optional :primary_color, String, nil?: true
+
+          # @!attribute primary_color_contrast
+          #   The primary color contrast for the tenant, provided as a hex value.
+          #
+          #   @return [String, nil]
+          optional :primary_color_contrast, String, nil?: true
+
+          # @!method initialize(icon_url: nil, logo_url: nil, primary_color: nil, primary_color_contrast: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Knockapi::Models::TenantSetParams::Settings::Branding} for more details.
+          #
+          #   The branding for the tenant.
+          #
+          #   @param icon_url [String, nil] The icon URL for the tenant. Must point to a valid image with an image MIME type
+          #   ...
+          #
+          #   @param logo_url [String, nil] The logo URL for the tenant. Must point to a valid image with an image MIME type
+          #   ...
+          #
+          #   @param primary_color [String, nil] The primary color for the tenant, provided as a hex value.
+          #
+          #   @param primary_color_contrast [String, nil] The primary color contrast for the tenant, provided as a hex value.
+        end
+      end
+    end
+  end
+end

data/lib/knockapi/models/tenants/bulk_delete_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Tenants
+      # @see Knockapi::Resources::Tenants::Bulk#delete
+      class BulkDeleteParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # @!attribute tenant_ids
+        #   The IDs of the tenants to delete.
+        #
+        #   @return [Array<String>]
+        required :tenant_ids, Knockapi::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(tenant_ids:, request_options: {})
+        #   @param tenant_ids [Array<String>] The IDs of the tenants to delete.
+        #
+        #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/knockapi/models/tenants/bulk_set_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Tenants
+      # @see Knockapi::Resources::Tenants::Bulk#set
+      class BulkSetParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # @!attribute tenants
+        #   The tenants to be upserted.
+        #
+        #   @return [Array<String, Knockapi::Models::TenantRequest>]
+        required :tenants, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::Models::InlineTenantRequest] }
+
+        # @!method initialize(tenants:, request_options: {})
+        #   @param tenants [Array<String, Knockapi::Models::TenantRequest>] The tenants to be upserted.
+        #
+        #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/knockapi/models/user.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Users#update
+    class User < Knockapi::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID for the user that you set when identifying them in Knock.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute _typename
+      #   The typename of the schema.
+      #
+      #   @return [String]
+      required :_typename, String, api_name: :__typename
+
+      # @!attribute updated_at
+      #   The timestamp when the resource was last updated.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute avatar
+      #   URL to the user's avatar image.
+      #
+      #   @return [String, nil]
+      optional :avatar, String, nil?: true
+
+      # @!attribute created_at
+      #   The creation date of the user from your system.
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time, nil?: true
+
+      # @!attribute email
+      #   The primary email address for the user.
+      #
+      #   @return [String, nil]
+      optional :email, String, nil?: true
+
+      # @!attribute name
+      #   Display name of the user.
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!attribute phone_number
+      #   The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
+      #   user (required for SMS channels).
+      #
+      #   @return [String, nil]
+      optional :phone_number, String, nil?: true
+
+      # @!attribute timezone
+      #   The timezone of the user. Must be a valid
+      #   [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
+      #   Used for
+      #   [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
+      #
+      #   @return [String, nil]
+      optional :timezone, String, nil?: true
+
+      # @!method initialize(id:, _typename:, updated_at:, avatar: nil, created_at: nil, email: nil, name: nil, phone_number: nil, timezone: nil)
+      #   Some parameter documentations has been truncated, see {Knockapi::Models::User}
+      #   for more details.
+      #
+      #   A [User](/concepts/users) represents an individual in your system who can
+      #   receive notifications through Knock. Users are the most common recipients of
+      #   notifications and are always referenced by your internal identifier.
+      #
+      #   @param id [String] The ID for the user that you set when identifying them in Knock.
+      #
+      #   @param _typename [String] The typename of the schema.
+      #
+      #   @param updated_at [Time] The timestamp when the resource was last updated.
+      #
+      #   @param avatar [String, nil] URL to the user's avatar image.
+      #
+      #   @param created_at [Time, nil] The creation date of the user from your system.
+      #
+      #   @param email [String, nil] The primary email address for the user.
+      #
+      #   @param name [String, nil] Display name of the user.
+      #
+      #   @param phone_number [String, nil] The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
+      #   ...
+      #
+      #   @param timezone [String, nil] The timezone of the user. Must be a valid [tz database time zone string](https:/
+      #   ...
+    end
+  end
+end

data/lib/knockapi/models/user_delete_params.rb

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

data/lib/knockapi/models/user_get_channel_data_params.rb

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

data/lib/knockapi/models/user_get_params.rb

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

data/lib/knockapi/models/user_get_preferences_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Users#get_preferences
+    class UserGetPreferencesParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!attribute tenant
+      #   The unique identifier for the tenant.
+      #
+      #   @return [String, nil]
+      optional :tenant, String
+
+      # @!method initialize(tenant: nil, request_options: {})
+      #   @param tenant [String] The unique identifier for the tenant.
+      #
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end