knockapi 0.6.0 → 1.0.0

data/lib/knockapi/models/condition.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    class Condition < Knockapi::Internal::Type::BaseModel
+      # @!attribute argument
+      #   The argument value to compare against in the condition.
+      #
+      #   @return [String, nil]
+      required :argument, String, nil?: true
+
+      # @!attribute operator
+      #   The operator to use in the condition evaluation.
+      #
+      #   @return [Symbol, Knockapi::Models::Condition::Operator]
+      required :operator, enum: -> { Knockapi::Models::Condition::Operator }
+
+      # @!attribute variable
+      #   The variable to be evaluated in the condition.
+      #
+      #   @return [String]
+      required :variable, String
+
+      # @!method initialize(argument:, operator:, variable:)
+      #   A condition to be evaluated.
+      #
+      #   @param argument [String, nil] The argument value to compare against in the condition.
+      #
+      #   @param operator [Symbol, Knockapi::Models::Condition::Operator] The operator to use in the condition evaluation.
+      #
+      #   @param variable [String] The variable to be evaluated in the condition.
+
+      # The operator to use in the condition evaluation.
+      #
+      # @see Knockapi::Models::Condition#operator
+      module Operator
+        extend Knockapi::Internal::Type::Enum
+
+        EQUAL_TO = :equal_to
+        NOT_EQUAL_TO = :not_equal_to
+        GREATER_THAN = :greater_than
+        LESS_THAN = :less_than
+        GREATER_THAN_OR_EQUAL_TO = :greater_than_or_equal_to
+        LESS_THAN_OR_EQUAL_TO = :less_than_or_equal_to
+        CONTAINS = :contains
+        NOT_CONTAINS = :not_contains
+        EMPTY = :empty
+        NOT_EMPTY = :not_empty
+        CONTAINS_ALL = :contains_all
+        IS_TIMESTAMP = :is_timestamp
+        IS_NOT_TIMESTAMP = :is_not_timestamp
+        IS_TIMESTAMP_AFTER = :is_timestamp_after
+        IS_TIMESTAMP_BEFORE = :is_timestamp_before
+        IS_TIMESTAMP_BETWEEN = :is_timestamp_between
+        IS_AUDIENCE_MEMBER = :is_audience_member
+        IS_NOT_AUDIENCE_MEMBER = :is_not_audience_member
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/knockapi/models/identify_user_request.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    class IdentifyUserRequest < Knockapi::Internal::Type::BaseModel
+      # @!attribute avatar
+      #   URL to the user's avatar image.
+      #
+      #   @return [String, nil]
+      optional :avatar, String, nil?: true
+
+      # @!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 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 locale
+      #   The locale of the user. Used for [message localization](/concepts/translations).
+      #
+      #   @return [String, nil]
+      optional :locale, 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 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 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(avatar: nil, channel_data: nil, created_at: nil, email: nil, locale: nil, name: nil, phone_number: nil, preferences: nil, timezone: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Knockapi::Models::IdentifyUserRequest} for more details.
+      #
+      #   A set of parameters to identify a user with. Does not include the user ID, as
+      #   that's specified elsewhere in the request. You can supply any additional
+      #   properties you'd like to upsert for the user.
+      #
+      #   @param avatar [String, nil] URL to the user's avatar image.
+      #
+      #   @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::ChannelDataRequest}, nil] A request to set channel data for a type of channel inline.
+      #
+      #   @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 locale [String, nil] The locale of the user. Used for [message localization](/concepts/translations).
+      #   ...
+      #
+      #   @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 preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
+      #
+      #   @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/inline_identify_user_request.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    class InlineIdentifyUserRequest < 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 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 created_at
+      #   The creation date of the user from your system.
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time, 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
+
+      # @!method initialize(id:, channel_data: nil, created_at: nil, preferences: nil)
+      #   A set of parameters to inline-identify a user with. Inline identifying the user
+      #   will ensure that the user is available before the request is executed in Knock.
+      #   It will perform an upsert for the user you're supplying, replacing any
+      #   properties specified.
+      #
+      #   @param id [String] The ID for the user that you set when identifying them in Knock.
+      #
+      #   @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::ChannelDataRequest}, nil] A request to set channel data for a type of channel inline.
+      #
+      #   @param created_at [Time, nil] The creation date of the user from your system.
+      #
+      #   @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
+    end
+  end
+end

data/lib/knockapi/models/inline_object_request.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    class InlineObjectRequest < Knockapi::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the object.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute collection
+      #   The collection this object belongs to.
+      #
+      #   @return [String]
+      required :collection, 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 created_at
+      #   Timestamp when the resource was created.
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time, 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
+
+      # @!method initialize(id:, collection:, channel_data: nil, created_at: nil, preferences: nil)
+      #   A custom [Object](/concepts/objects) entity which belongs to a collection.
+      #
+      #   @param id [String] Unique identifier for the object.
+      #
+      #   @param collection [String] The collection this object belongs to.
+      #
+      #   @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::ChannelDataRequest}, nil] A request to set channel data for a type of channel inline.
+      #
+      #   @param created_at [Time, nil] Timestamp when the resource was created.
+      #
+      #   @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
+    end
+  end
+end

data/lib/knockapi/models/inline_tenant_request.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # An request to set a tenant inline.
+    module InlineTenantRequest
+      extend Knockapi::Internal::Type::Union
+
+      # The unique identifier for the tenant.
+      variant String
+
+      # A tenant to be set in the system. You can supply any additional properties on the tenant object.
+      variant -> { Knockapi::Models::TenantRequest }
+
+      # @!method self.variants
+      #   @return [Array(String, Knockapi::Models::TenantRequest)]
+    end
+  end
+end

data/lib/knockapi/models/integrations/census_custom_destination_params.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Integrations
+      # @see Knockapi::Resources::Integrations::Census#custom_destination
+      class CensusCustomDestinationParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #   The unique identifier for the RPC request.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute jsonrpc
+        #   The JSON-RPC version.
+        #
+        #   @return [String]
+        required :jsonrpc, String
+
+        # @!attribute method_
+        #   The method name to execute.
+        #
+        #   @return [String]
+        required :method_, String, api_name: :method
+
+        # @!attribute params
+        #   The parameters for the method.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :params, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]
+
+        # @!method initialize(id:, jsonrpc:, method_:, params: nil, request_options: {})
+        #   @param id [String] The unique identifier for the RPC request.
+        #
+        #   @param jsonrpc [String] The JSON-RPC version.
+        #
+        #   @param method_ [String] The method name to execute.
+        #
+        #   @param params [Hash{Symbol=>Object}] The parameters for the method.
+        #
+        #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/knockapi/models/integrations/census_custom_destination_response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Integrations
+      # @see Knockapi::Resources::Integrations::Census#custom_destination
+      class CensusCustomDestinationResponse < Knockapi::Internal::Type::BaseModel
+        # @!attribute id
+        #   The request ID.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute result
+        #   The result of the RPC call.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :result, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]
+
+        # @!method initialize(id: nil, result: nil)
+        #   @param id [String] The request ID.
+        #
+        #   @param result [Hash{Symbol=>Object}] The result of the RPC call.
+      end
+    end
+  end
+end

data/lib/knockapi/models/integrations/hightouch_embedded_destination_params.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Integrations
+      # @see Knockapi::Resources::Integrations::Hightouch#embedded_destination
+      class HightouchEmbeddedDestinationParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #   The unique identifier for the RPC request.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute jsonrpc
+        #   The JSON-RPC version.
+        #
+        #   @return [String]
+        required :jsonrpc, String
+
+        # @!attribute method_
+        #   The method name to execute.
+        #
+        #   @return [String]
+        required :method_, String, api_name: :method
+
+        # @!attribute params
+        #   The parameters for the method.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :params, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]
+
+        # @!method initialize(id:, jsonrpc:, method_:, params: nil, request_options: {})
+        #   @param id [String] The unique identifier for the RPC request.
+        #
+        #   @param jsonrpc [String] The JSON-RPC version.
+        #
+        #   @param method_ [String] The method name to execute.
+        #
+        #   @param params [Hash{Symbol=>Object}] The parameters for the method.
+        #
+        #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/knockapi/models/integrations/hightouch_embedded_destination_response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Integrations
+      # @see Knockapi::Resources::Integrations::Hightouch#embedded_destination
+      class HightouchEmbeddedDestinationResponse < Knockapi::Internal::Type::BaseModel
+        # @!attribute id
+        #   The request ID.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute result
+        #   The result of the RPC call.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :result, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]
+
+        # @!method initialize(id: nil, result: nil)
+        #   @param id [String] The request ID.
+        #
+        #   @param result [Hash{Symbol=>Object}] The result of the RPC call.
+      end
+    end
+  end
+end