knockapi 0.6.1 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.ignore +2 -0
- data/CHANGELOG.md +20 -0
- data/README.md +157 -94
- data/SECURITY.md +27 -0
- data/lib/knockapi/client.rb +122 -0
- data/lib/knockapi/errors.rb +192 -0
- data/lib/knockapi/file_part.rb +55 -0
- data/lib/knockapi/internal/entries_cursor.rb +101 -0
- data/lib/knockapi/internal/items_cursor.rb +101 -0
- data/lib/knockapi/internal/ms_teams_pagination.rb +86 -0
- data/lib/knockapi/internal/slack_channels_cursor.rb +86 -0
- data/lib/knockapi/internal/transport/base_client.rb +483 -0
- data/lib/knockapi/internal/transport/pooled_net_requester.rb +193 -0
- data/lib/knockapi/internal/type/array_of.rb +154 -0
- data/lib/knockapi/internal/type/base_model.rb +445 -0
- data/lib/knockapi/internal/type/base_page.rb +55 -0
- data/lib/knockapi/internal/type/boolean.rb +63 -0
- data/lib/knockapi/internal/type/converter.rb +274 -0
- data/lib/knockapi/internal/type/enum.rb +107 -0
- data/lib/knockapi/internal/type/file_input.rb +96 -0
- data/lib/knockapi/internal/type/hash_of.rb +174 -0
- data/lib/knockapi/internal/type/request_parameters.rb +48 -0
- data/lib/knockapi/internal/type/union.rb +225 -0
- data/lib/knockapi/internal/type/unknown.rb +67 -0
- data/lib/knockapi/internal/util.rb +790 -0
- data/lib/knockapi/internal.rb +11 -0
- data/lib/knockapi/models/activity.rb +70 -0
- data/lib/knockapi/models/audience_add_members_params.rb +55 -0
- data/lib/knockapi/models/audience_list_members_params.rb +14 -0
- data/lib/knockapi/models/audience_list_members_response.rb +27 -0
- data/lib/knockapi/models/audience_member.rb +56 -0
- data/lib/knockapi/models/audience_remove_members_params.rb +55 -0
- data/lib/knockapi/models/bulk_operation.rb +166 -0
- data/lib/knockapi/models/bulk_operation_get_params.rb +14 -0
- data/lib/knockapi/models/channels/bulk_update_message_status_params.rb +167 -0
- data/lib/knockapi/models/condition.rb +63 -0
- data/lib/knockapi/models/identify_user_request.rb +98 -0
- data/lib/knockapi/models/inline_identify_user_request.rb +49 -0
- data/lib/knockapi/models/inline_object_request.rb +54 -0
- data/lib/knockapi/models/inline_tenant_request.rb +19 -0
- data/lib/knockapi/models/integrations/census_custom_destination_params.rb +48 -0
- data/lib/knockapi/models/integrations/census_custom_destination_response.rb +27 -0
- data/lib/knockapi/models/integrations/hightouch_embedded_destination_params.rb +48 -0
- data/lib/knockapi/models/integrations/hightouch_embedded_destination_response.rb +27 -0
- data/lib/knockapi/models/message.rb +268 -0
- data/lib/knockapi/models/message_archive_params.rb +14 -0
- data/lib/knockapi/models/message_delivery_log.rb +202 -0
- data/lib/knockapi/models/message_event.rb +91 -0
- data/lib/knockapi/models/message_get_content_params.rb +14 -0
- data/lib/knockapi/models/message_get_content_response.rb +496 -0
- data/lib/knockapi/models/message_get_params.rb +14 -0
- data/lib/knockapi/models/message_list_activities_params.rb +46 -0
- data/lib/knockapi/models/message_list_delivery_logs_params.rb +38 -0
- data/lib/knockapi/models/message_list_events_params.rb +38 -0
- data/lib/knockapi/models/message_list_params.rb +200 -0
- data/lib/knockapi/models/message_mark_as_interacted_params.rb +22 -0
- data/lib/knockapi/models/message_mark_as_read_params.rb +14 -0
- data/lib/knockapi/models/message_mark_as_seen_params.rb +14 -0
- data/lib/knockapi/models/message_mark_as_unread_params.rb +14 -0
- data/lib/knockapi/models/message_mark_as_unseen_params.rb +14 -0
- data/lib/knockapi/models/message_unarchive_params.rb +14 -0
- data/lib/knockapi/models/messages/activity_list_params.rb +48 -0
- data/lib/knockapi/models/messages/batch_archive_params.rb +24 -0
- data/lib/knockapi/models/messages/batch_archive_response.rb +10 -0
- data/lib/knockapi/models/messages/batch_get_content_params.rb +24 -0
- data/lib/knockapi/models/messages/batch_get_content_response.rb +504 -0
- data/lib/knockapi/models/messages/batch_mark_as_interacted_params.rb +32 -0
- data/lib/knockapi/models/messages/batch_mark_as_interacted_response.rb +10 -0
- data/lib/knockapi/models/messages/batch_mark_as_read_params.rb +24 -0
- data/lib/knockapi/models/messages/batch_mark_as_read_response.rb +10 -0
- data/lib/knockapi/models/messages/batch_mark_as_seen_params.rb +24 -0
- data/lib/knockapi/models/messages/batch_mark_as_seen_response.rb +10 -0
- data/lib/knockapi/models/messages/batch_mark_as_unread_params.rb +24 -0
- data/lib/knockapi/models/messages/batch_mark_as_unread_response.rb +10 -0
- data/lib/knockapi/models/messages/batch_mark_as_unseen_params.rb +24 -0
- data/lib/knockapi/models/messages/batch_mark_as_unseen_response.rb +10 -0
- data/lib/knockapi/models/messages/batch_unarchive_params.rb +24 -0
- data/lib/knockapi/models/messages/batch_unarchive_response.rb +10 -0
- data/lib/knockapi/models/object.rb +51 -0
- data/lib/knockapi/models/object_add_subscriptions_params.rb +35 -0
- data/lib/knockapi/models/object_add_subscriptions_response.rb +9 -0
- data/lib/knockapi/models/object_delete_params.rb +14 -0
- data/lib/knockapi/models/object_delete_subscriptions_params.rb +28 -0
- data/lib/knockapi/models/object_delete_subscriptions_response.rb +9 -0
- data/lib/knockapi/models/object_get_channel_data_params.rb +14 -0
- data/lib/knockapi/models/object_get_params.rb +14 -0
- data/lib/knockapi/models/object_get_preferences_params.rb +14 -0
- data/lib/knockapi/models/object_list_messages_params.rb +200 -0
- data/lib/knockapi/models/object_list_params.rb +56 -0
- data/lib/knockapi/models/object_list_preferences_params.rb +14 -0
- data/lib/knockapi/models/object_list_preferences_response.rb +9 -0
- data/lib/knockapi/models/object_list_schedules_params.rb +54 -0
- data/lib/knockapi/models/object_list_subscriptions_params.rb +122 -0
- data/lib/knockapi/models/object_set_channel_data_params.rb +14 -0
- data/lib/knockapi/models/object_set_params.rb +57 -0
- data/lib/knockapi/models/object_set_preferences_params.rb +14 -0
- data/lib/knockapi/models/object_unset_channel_data_params.rb +14 -0
- data/lib/knockapi/models/objects/bulk_add_subscriptions_params.rb +52 -0
- data/lib/knockapi/models/objects/bulk_delete_params.rb +24 -0
- data/lib/knockapi/models/objects/bulk_set_params.rb +24 -0
- data/lib/knockapi/models/page_info.rb +42 -0
- data/lib/knockapi/models/providers/ms_team_check_auth_params.rb +24 -0
- data/lib/knockapi/models/providers/ms_team_check_auth_response.rb +43 -0
- data/lib/knockapi/models/providers/ms_team_list_channels_params.rb +66 -0
- data/lib/knockapi/models/providers/ms_team_list_channels_response.rb +74 -0
- data/lib/knockapi/models/providers/ms_team_list_teams_params.rb +78 -0
- data/lib/knockapi/models/providers/ms_team_list_teams_response.rb +35 -0
- data/lib/knockapi/models/providers/ms_team_revoke_access_params.rb +24 -0
- data/lib/knockapi/models/providers/ms_team_revoke_access_response.rb +21 -0
- data/lib/knockapi/models/providers/slack_check_auth_params.rb +24 -0
- data/lib/knockapi/models/providers/slack_check_auth_response.rb +43 -0
- data/lib/knockapi/models/providers/slack_list_channels_params.rb +83 -0
- data/lib/knockapi/models/providers/slack_list_channels_response.rb +53 -0
- data/lib/knockapi/models/providers/slack_revoke_access_params.rb +24 -0
- data/lib/knockapi/models/providers/slack_revoke_access_response.rb +21 -0
- data/lib/knockapi/models/recipient.rb +19 -0
- data/lib/knockapi/models/recipient_reference.rb +41 -0
- data/lib/knockapi/models/recipient_request.rb +24 -0
- data/lib/knockapi/models/recipients/channel_data.rb +88 -0
- data/lib/knockapi/models/recipients/channel_data_request.rb +45 -0
- data/lib/knockapi/models/recipients/discord_channel_data.rb +77 -0
- data/lib/knockapi/models/recipients/inline_channel_data_request.rb +11 -0
- data/lib/knockapi/models/recipients/inline_preference_set_request.rb +11 -0
- data/lib/knockapi/models/recipients/ms_teams_channel_data.rb +108 -0
- data/lib/knockapi/models/recipients/one_signal_channel_data.rb +20 -0
- data/lib/knockapi/models/recipients/preference_set.rb +126 -0
- data/lib/knockapi/models/recipients/preference_set_channel_type_setting.rb +21 -0
- data/lib/knockapi/models/recipients/preference_set_channel_types.rb +150 -0
- data/lib/knockapi/models/recipients/preference_set_request.rb +117 -0
- data/lib/knockapi/models/recipients/push_channel_data.rb +20 -0
- data/lib/knockapi/models/recipients/slack_channel_data.rb +99 -0
- data/lib/knockapi/models/recipients/subscription.rb +60 -0
- data/lib/knockapi/models/schedule.rb +113 -0
- data/lib/knockapi/models/schedule_create_params.rb +75 -0
- data/lib/knockapi/models/schedule_create_response.rb +8 -0
- data/lib/knockapi/models/schedule_delete_params.rb +22 -0
- data/lib/knockapi/models/schedule_delete_response.rb +8 -0
- data/lib/knockapi/models/schedule_list_params.rb +62 -0
- data/lib/knockapi/models/schedule_repeat_rule.rb +99 -0
- data/lib/knockapi/models/schedule_update_params.rb +75 -0
- data/lib/knockapi/models/schedule_update_response.rb +8 -0
- data/lib/knockapi/models/schedules/bulk_create_params.rb +103 -0
- data/lib/knockapi/models/tenant.rb +115 -0
- data/lib/knockapi/models/tenant_delete_params.rb +14 -0
- data/lib/knockapi/models/tenant_get_params.rb +14 -0
- data/lib/knockapi/models/tenant_list_params.rb +54 -0
- data/lib/knockapi/models/tenant_request.rb +114 -0
- data/lib/knockapi/models/tenant_set_params.rb +108 -0
- data/lib/knockapi/models/tenants/bulk_delete_params.rb +24 -0
- data/lib/knockapi/models/tenants/bulk_set_params.rb +24 -0
- data/lib/knockapi/models/user.rb +94 -0
- data/lib/knockapi/models/user_delete_params.rb +14 -0
- data/lib/knockapi/models/user_get_channel_data_params.rb +14 -0
- data/lib/knockapi/models/user_get_params.rb +14 -0
- data/lib/knockapi/models/user_get_preferences_params.rb +22 -0
- data/lib/knockapi/models/user_list_messages_params.rb +200 -0
- data/lib/knockapi/models/user_list_params.rb +56 -0
- data/lib/knockapi/models/user_list_preferences_params.rb +14 -0
- data/lib/knockapi/models/user_list_preferences_response.rb +9 -0
- data/lib/knockapi/models/user_list_schedules_params.rb +54 -0
- data/lib/knockapi/models/user_list_subscriptions_params.rb +64 -0
- data/lib/knockapi/models/user_merge_params.rb +22 -0
- data/lib/knockapi/models/user_set_channel_data_params.rb +14 -0
- data/lib/knockapi/models/user_set_preferences_params.rb +14 -0
- data/lib/knockapi/models/user_unset_channel_data_params.rb +14 -0
- data/lib/knockapi/models/user_update_params.rb +14 -0
- data/lib/knockapi/models/users/bulk_delete_params.rb +24 -0
- data/lib/knockapi/models/users/bulk_identify_params.rb +24 -0
- data/lib/knockapi/models/users/bulk_set_preferences_params.rb +32 -0
- data/lib/knockapi/models/users/feed_get_settings_params.rb +16 -0
- data/lib/knockapi/models/users/feed_get_settings_response.rb +35 -0
- data/lib/knockapi/models/users/feed_list_items_params.rb +122 -0
- data/lib/knockapi/models/users/feed_list_items_response.rb +333 -0
- data/lib/knockapi/models/users/guide_get_channel_params.rb +40 -0
- data/lib/knockapi/models/users/guide_get_channel_response.rb +79 -0
- data/lib/knockapi/models/users/guide_mark_message_as_archived_params.rb +88 -0
- data/lib/knockapi/models/users/guide_mark_message_as_archived_response.rb +21 -0
- data/lib/knockapi/models/users/guide_mark_message_as_interacted_params.rb +88 -0
- data/lib/knockapi/models/users/guide_mark_message_as_interacted_response.rb +21 -0
- data/lib/knockapi/models/users/guide_mark_message_as_seen_params.rb +88 -0
- data/lib/knockapi/models/users/guide_mark_message_as_seen_response.rb +21 -0
- data/lib/knockapi/models/workflow_cancel_params.rb +42 -0
- data/lib/knockapi/models/workflow_trigger_params.rb +67 -0
- data/lib/knockapi/models/workflow_trigger_response.rb +24 -0
- data/lib/knockapi/request_options.rb +73 -0
- data/lib/knockapi/resources/audiences.rb +82 -0
- data/lib/knockapi/resources/bulk_operations.rb +34 -0
- data/lib/knockapi/resources/channels/bulk.rb +67 -0
- data/lib/knockapi/resources/channels.rb +18 -0
- data/lib/knockapi/resources/integrations/census.rb +44 -0
- data/lib/knockapi/resources/integrations/hightouch.rb +44 -0
- data/lib/knockapi/resources/integrations.rb +22 -0
- data/lib/knockapi/resources/messages/activities.rb +47 -0
- data/lib/knockapi/resources/messages/batch.rb +208 -0
- data/lib/knockapi/resources/messages.rb +365 -0
- data/lib/knockapi/resources/objects/bulk.rb +92 -0
- data/lib/knockapi/resources/objects.rb +508 -0
- data/lib/knockapi/resources/providers/ms_teams.rb +122 -0
- data/lib/knockapi/resources/providers/slack.rb +91 -0
- data/lib/knockapi/resources/providers.rb +22 -0
- data/lib/knockapi/resources/recipients/channel_data.rb +16 -0
- data/lib/knockapi/resources/recipients/preferences.rb +16 -0
- data/lib/knockapi/resources/recipients/subscriptions.rb +16 -0
- data/lib/knockapi/resources/recipients.rb +26 -0
- data/lib/knockapi/resources/schedules/bulk.rb +40 -0
- data/lib/knockapi/resources/schedules.rb +159 -0
- data/lib/knockapi/resources/shared.rb +14 -0
- data/lib/knockapi/resources/tenants/bulk.rb +60 -0
- data/lib/knockapi/resources/tenants.rb +118 -0
- data/lib/knockapi/resources/users/bulk.rb +89 -0
- data/lib/knockapi/resources/users/feeds.rb +84 -0
- data/lib/knockapi/resources/users/guides.rb +175 -0
- data/lib/knockapi/resources/users.rb +448 -0
- data/lib/knockapi/resources/workflows.rb +89 -0
- data/lib/knockapi/version.rb +5 -0
- data/lib/knockapi.rb +239 -0
- data/manifest.yaml +15 -0
- data/rbi/knockapi/client.rbi +84 -0
- data/rbi/knockapi/errors.rbi +143 -0
- data/rbi/knockapi/file_part.rbi +34 -0
- data/rbi/knockapi/internal/entries_cursor.rbi +35 -0
- data/rbi/knockapi/internal/items_cursor.rbi +35 -0
- data/rbi/knockapi/internal/ms_teams_pagination.rbi +21 -0
- data/rbi/knockapi/internal/slack_channels_cursor.rbi +21 -0
- data/rbi/knockapi/internal/transport/base_client.rbi +213 -0
- data/rbi/knockapi/internal/transport/pooled_net_requester.rbi +60 -0
- data/rbi/knockapi/internal/type/array_of.rbi +88 -0
- data/rbi/knockapi/internal/type/base_model.rbi +219 -0
- data/rbi/knockapi/internal/type/base_page.rbi +38 -0
- data/rbi/knockapi/internal/type/boolean.rbi +48 -0
- data/rbi/knockapi/internal/type/converter.rbi +120 -0
- data/rbi/knockapi/internal/type/enum.rbi +64 -0
- data/rbi/knockapi/internal/type/file_input.rbi +50 -0
- data/rbi/knockapi/internal/type/hash_of.rbi +88 -0
- data/rbi/knockapi/internal/type/request_parameters.rbi +21 -0
- data/rbi/knockapi/internal/type/union.rbi +75 -0
- data/rbi/knockapi/internal/type/unknown.rbi +40 -0
- data/rbi/knockapi/internal/util.rbi +299 -0
- data/rbi/knockapi/internal.rbi +11 -0
- data/rbi/knockapi/models/activity.rbi +101 -0
- data/rbi/knockapi/models/audience_add_members_params.rbi +88 -0
- data/rbi/knockapi/models/audience_list_members_params.rbi +19 -0
- data/rbi/knockapi/models/audience_list_members_response.rbi +38 -0
- data/rbi/knockapi/models/audience_member.rbi +65 -0
- data/rbi/knockapi/models/audience_remove_members_params.rbi +90 -0
- data/rbi/knockapi/models/bulk_operation.rbi +194 -0
- data/rbi/knockapi/models/bulk_operation_get_params.rbi +19 -0
- data/rbi/knockapi/models/channels/bulk_update_message_status_params.rbi +287 -0
- data/rbi/knockapi/models/condition.rbi +77 -0
- data/rbi/knockapi/models/identify_user_request.rbi +110 -0
- data/rbi/knockapi/models/inline_identify_user_request.rbi +63 -0
- data/rbi/knockapi/models/inline_object_request.rbi +68 -0
- data/rbi/knockapi/models/inline_tenant_request.rbi +13 -0
- data/rbi/knockapi/models/integrations/census_custom_destination_params.rbi +66 -0
- data/rbi/knockapi/models/integrations/census_custom_destination_response.rbi +33 -0
- data/rbi/knockapi/models/integrations/hightouch_embedded_destination_params.rbi +66 -0
- data/rbi/knockapi/models/integrations/hightouch_embedded_destination_response.rbi +33 -0
- data/rbi/knockapi/models/message.rbi +322 -0
- data/rbi/knockapi/models/message_archive_params.rbi +19 -0
- data/rbi/knockapi/models/message_delivery_log.rbi +260 -0
- data/rbi/knockapi/models/message_event.rbi +103 -0
- data/rbi/knockapi/models/message_get_content_params.rbi +19 -0
- data/rbi/knockapi/models/message_get_content_response.rbi +738 -0
- data/rbi/knockapi/models/message_get_params.rbi +19 -0
- data/rbi/knockapi/models/message_list_activities_params.rbi +73 -0
- data/rbi/knockapi/models/message_list_delivery_logs_params.rbi +60 -0
- data/rbi/knockapi/models/message_list_events_params.rbi +60 -0
- data/rbi/knockapi/models/message_list_params.rbi +271 -0
- data/rbi/knockapi/models/message_mark_as_interacted_params.rbi +34 -0
- data/rbi/knockapi/models/message_mark_as_read_params.rbi +19 -0
- data/rbi/knockapi/models/message_mark_as_seen_params.rbi +19 -0
- data/rbi/knockapi/models/message_mark_as_unread_params.rbi +19 -0
- data/rbi/knockapi/models/message_mark_as_unseen_params.rbi +19 -0
- data/rbi/knockapi/models/message_unarchive_params.rbi +19 -0
- data/rbi/knockapi/models/messages/activity_list_params.rbi +75 -0
- data/rbi/knockapi/models/messages/batch_archive_params.rbi +31 -0
- data/rbi/knockapi/models/messages/batch_archive_response.rbi +10 -0
- data/rbi/knockapi/models/messages/batch_get_content_params.rbi +31 -0
- data/rbi/knockapi/models/messages/batch_get_content_response.rbi +748 -0
- data/rbi/knockapi/models/messages/batch_mark_as_interacted_params.rbi +47 -0
- data/rbi/knockapi/models/messages/batch_mark_as_interacted_response.rbi +10 -0
- data/rbi/knockapi/models/messages/batch_mark_as_read_params.rbi +31 -0
- data/rbi/knockapi/models/messages/batch_mark_as_read_response.rbi +10 -0
- data/rbi/knockapi/models/messages/batch_mark_as_seen_params.rbi +31 -0
- data/rbi/knockapi/models/messages/batch_mark_as_seen_response.rbi +10 -0
- data/rbi/knockapi/models/messages/batch_mark_as_unread_params.rbi +31 -0
- data/rbi/knockapi/models/messages/batch_mark_as_unread_response.rbi +10 -0
- data/rbi/knockapi/models/messages/batch_mark_as_unseen_params.rbi +31 -0
- data/rbi/knockapi/models/messages/batch_mark_as_unseen_response.rbi +10 -0
- data/rbi/knockapi/models/messages/batch_unarchive_params.rbi +31 -0
- data/rbi/knockapi/models/messages/batch_unarchive_response.rbi +10 -0
- data/rbi/knockapi/models/object.rbi +58 -0
- data/rbi/knockapi/models/object_add_subscriptions_params.rbi +58 -0
- data/rbi/knockapi/models/object_add_subscriptions_response.rbi +11 -0
- data/rbi/knockapi/models/object_delete_params.rbi +19 -0
- data/rbi/knockapi/models/object_delete_subscriptions_params.rbi +39 -0
- data/rbi/knockapi/models/object_delete_subscriptions_response.rbi +11 -0
- data/rbi/knockapi/models/object_get_channel_data_params.rbi +19 -0
- data/rbi/knockapi/models/object_get_params.rbi +19 -0
- data/rbi/knockapi/models/object_get_preferences_params.rbi +19 -0
- data/rbi/knockapi/models/object_list_messages_params.rbi +281 -0
- data/rbi/knockapi/models/object_list_params.rbi +85 -0
- data/rbi/knockapi/models/object_list_preferences_params.rbi +19 -0
- data/rbi/knockapi/models/object_list_preferences_response.rbi +11 -0
- data/rbi/knockapi/models/object_list_schedules_params.rbi +84 -0
- data/rbi/knockapi/models/object_list_subscriptions_params.rbi +175 -0
- data/rbi/knockapi/models/object_set_channel_data_params.rbi +19 -0
- data/rbi/knockapi/models/object_set_params.rbi +85 -0
- data/rbi/knockapi/models/object_set_preferences_params.rbi +19 -0
- data/rbi/knockapi/models/object_unset_channel_data_params.rbi +19 -0
- data/rbi/knockapi/models/objects/bulk_add_subscriptions_params.rbi +86 -0
- data/rbi/knockapi/models/objects/bulk_delete_params.rbi +31 -0
- data/rbi/knockapi/models/objects/bulk_set_params.rbi +36 -0
- data/rbi/knockapi/models/page_info.rbi +49 -0
- data/rbi/knockapi/models/providers/ms_team_check_auth_params.rbi +31 -0
- data/rbi/knockapi/models/providers/ms_team_check_auth_response.rbi +56 -0
- data/rbi/knockapi/models/providers/ms_team_list_channels_params.rbi +91 -0
- data/rbi/knockapi/models/providers/ms_team_list_channels_response.rbi +113 -0
- data/rbi/knockapi/models/providers/ms_team_list_teams_params.rbi +107 -0
- data/rbi/knockapi/models/providers/ms_team_list_teams_response.rbi +35 -0
- data/rbi/knockapi/models/providers/ms_team_revoke_access_params.rbi +31 -0
- data/rbi/knockapi/models/providers/ms_team_revoke_access_response.rbi +25 -0
- data/rbi/knockapi/models/providers/slack_check_auth_params.rbi +31 -0
- data/rbi/knockapi/models/providers/slack_check_auth_response.rbi +56 -0
- data/rbi/knockapi/models/providers/slack_list_channels_params.rbi +130 -0
- data/rbi/knockapi/models/providers/slack_list_channels_response.rbi +58 -0
- data/rbi/knockapi/models/providers/slack_revoke_access_params.rbi +31 -0
- data/rbi/knockapi/models/providers/slack_revoke_access_response.rbi +25 -0
- data/rbi/knockapi/models/recipient.rbi +13 -0
- data/rbi/knockapi/models/recipient_reference.rbi +41 -0
- data/rbi/knockapi/models/recipient_request.rbi +18 -0
- data/rbi/knockapi/models/recipients/channel_data.rbi +125 -0
- data/rbi/knockapi/models/recipients/channel_data_request.rbi +70 -0
- data/rbi/knockapi/models/recipients/discord_channel_data.rbi +143 -0
- data/rbi/knockapi/models/recipients/inline_channel_data_request.rbi +13 -0
- data/rbi/knockapi/models/recipients/inline_preference_set_request.rbi +13 -0
- data/rbi/knockapi/models/recipients/ms_teams_channel_data.rbi +186 -0
- data/rbi/knockapi/models/recipients/one_signal_channel_data.rbi +22 -0
- data/rbi/knockapi/models/recipients/preference_set.rbi +243 -0
- data/rbi/knockapi/models/recipients/preference_set_channel_type_setting.rbi +26 -0
- data/rbi/knockapi/models/recipients/preference_set_channel_types.rbi +218 -0
- data/rbi/knockapi/models/recipients/preference_set_request.rbi +234 -0
- data/rbi/knockapi/models/recipients/push_channel_data.rbi +22 -0
- data/rbi/knockapi/models/recipients/slack_channel_data.rbi +154 -0
- data/rbi/knockapi/models/recipients/subscription.rbi +77 -0
- data/rbi/knockapi/models/schedule.rbi +127 -0
- data/rbi/knockapi/models/schedule_create_params.rbi +98 -0
- data/rbi/knockapi/models/schedule_create_response.rbi +8 -0
- data/rbi/knockapi/models/schedule_delete_params.rbi +29 -0
- data/rbi/knockapi/models/schedule_delete_response.rbi +8 -0
- data/rbi/knockapi/models/schedule_list_params.rbi +92 -0
- data/rbi/knockapi/models/schedule_repeat_rule.rbi +118 -0
- data/rbi/knockapi/models/schedule_update_params.rbi +92 -0
- data/rbi/knockapi/models/schedule_update_response.rbi +8 -0
- data/rbi/knockapi/models/schedules/bulk_create_params.rbi +172 -0
- data/rbi/knockapi/models/tenant.rbi +162 -0
- data/rbi/knockapi/models/tenant_delete_params.rbi +19 -0
- data/rbi/knockapi/models/tenant_get_params.rbi +19 -0
- data/rbi/knockapi/models/tenant_list_params.rbi +84 -0
- data/rbi/knockapi/models/tenant_request.rbi +168 -0
- data/rbi/knockapi/models/tenant_set_params.rbi +166 -0
- data/rbi/knockapi/models/tenants/bulk_delete_params.rbi +31 -0
- data/rbi/knockapi/models/tenants/bulk_set_params.rbi +36 -0
- data/rbi/knockapi/models/user.rbi +106 -0
- data/rbi/knockapi/models/user_delete_params.rbi +19 -0
- data/rbi/knockapi/models/user_get_channel_data_params.rbi +19 -0
- data/rbi/knockapi/models/user_get_params.rbi +19 -0
- data/rbi/knockapi/models/user_get_preferences_params.rbi +29 -0
- data/rbi/knockapi/models/user_list_messages_params.rbi +277 -0
- data/rbi/knockapi/models/user_list_params.rbi +85 -0
- data/rbi/knockapi/models/user_list_preferences_params.rbi +19 -0
- data/rbi/knockapi/models/user_list_preferences_response.rbi +11 -0
- data/rbi/knockapi/models/user_list_schedules_params.rbi +84 -0
- data/rbi/knockapi/models/user_list_subscriptions_params.rbi +96 -0
- data/rbi/knockapi/models/user_merge_params.rbi +29 -0
- data/rbi/knockapi/models/user_set_channel_data_params.rbi +19 -0
- data/rbi/knockapi/models/user_set_preferences_params.rbi +19 -0
- data/rbi/knockapi/models/user_unset_channel_data_params.rbi +19 -0
- data/rbi/knockapi/models/user_update_params.rbi +19 -0
- data/rbi/knockapi/models/users/bulk_delete_params.rbi +31 -0
- data/rbi/knockapi/models/users/bulk_identify_params.rbi +36 -0
- data/rbi/knockapi/models/users/bulk_set_preferences_params.rbi +55 -0
- data/rbi/knockapi/models/users/feed_get_settings_params.rbi +21 -0
- data/rbi/knockapi/models/users/feed_get_settings_response.rbi +50 -0
- data/rbi/knockapi/models/users/feed_list_items_params.rbi +173 -0
- data/rbi/knockapi/models/users/feed_list_items_response.rbi +443 -0
- data/rbi/knockapi/models/users/guide_get_channel_params.rbi +63 -0
- data/rbi/knockapi/models/users/guide_get_channel_response.rbi +124 -0
- data/rbi/knockapi/models/users/guide_mark_message_as_archived_params.rbi +115 -0
- data/rbi/knockapi/models/users/guide_mark_message_as_archived_response.rbi +22 -0
- data/rbi/knockapi/models/users/guide_mark_message_as_interacted_params.rbi +115 -0
- data/rbi/knockapi/models/users/guide_mark_message_as_interacted_response.rbi +22 -0
- data/rbi/knockapi/models/users/guide_mark_message_as_seen_params.rbi +115 -0
- data/rbi/knockapi/models/users/guide_mark_message_as_seen_response.rbi +22 -0
- data/rbi/knockapi/models/workflow_cancel_params.rbi +57 -0
- data/rbi/knockapi/models/workflow_trigger_params.rbi +109 -0
- data/rbi/knockapi/models/workflow_trigger_response.rbi +22 -0
- data/rbi/knockapi/request_options.rbi +48 -0
- data/rbi/knockapi/resources/audiences.rbi +53 -0
- data/rbi/knockapi/resources/bulk_operations.rbi +18 -0
- data/rbi/knockapi/resources/channels/bulk.rbi +64 -0
- data/rbi/knockapi/resources/channels.rbi +14 -0
- data/rbi/knockapi/resources/integrations/census.rbi +35 -0
- data/rbi/knockapi/resources/integrations/hightouch.rbi +35 -0
- data/rbi/knockapi/resources/integrations.rbi +17 -0
- data/rbi/knockapi/resources/messages/activities.rbi +38 -0
- data/rbi/knockapi/resources/messages/batch.rbi +113 -0
- data/rbi/knockapi/resources/messages.rbi +231 -0
- data/rbi/knockapi/resources/objects/bulk.rbi +61 -0
- data/rbi/knockapi/resources/objects.rbi +434 -0
- data/rbi/knockapi/resources/providers/ms_teams.rbi +79 -0
- data/rbi/knockapi/resources/providers/slack.rbi +55 -0
- data/rbi/knockapi/resources/providers.rbi +17 -0
- data/rbi/knockapi/resources/recipients/channel_data.rbi +13 -0
- data/rbi/knockapi/resources/recipients/preferences.rbi +13 -0
- data/rbi/knockapi/resources/recipients/subscriptions.rbi +13 -0
- data/rbi/knockapi/resources/recipients.rbi +20 -0
- data/rbi/knockapi/resources/schedules/bulk.rbi +28 -0
- data/rbi/knockapi/resources/schedules.rbi +135 -0
- data/rbi/knockapi/resources/shared.rbi +11 -0
- data/rbi/knockapi/resources/tenants/bulk.rbi +36 -0
- data/rbi/knockapi/resources/tenants.rbi +80 -0
- data/rbi/knockapi/resources/users/bulk.rbi +57 -0
- data/rbi/knockapi/resources/users/feeds.rbi +72 -0
- data/rbi/knockapi/resources/users/guides.rbi +170 -0
- data/rbi/knockapi/resources/users.rbi +357 -0
- data/rbi/knockapi/resources/workflows.rbi +92 -0
- data/rbi/knockapi/version.rbi +5 -0
- data/sig/knockapi/client.rbs +50 -0
- data/sig/knockapi/errors.rbs +101 -0
- data/sig/knockapi/file_part.rbs +21 -0
- data/sig/knockapi/internal/entries_cursor.rbs +24 -0
- data/sig/knockapi/internal/items_cursor.rbs +24 -0
- data/sig/knockapi/internal/ms_teams_pagination.rbs +13 -0
- data/sig/knockapi/internal/slack_channels_cursor.rbs +13 -0
- data/sig/knockapi/internal/transport/base_client.rbs +116 -0
- data/sig/knockapi/internal/transport/pooled_net_requester.rbs +41 -0
- data/sig/knockapi/internal/type/array_of.rbs +45 -0
- data/sig/knockapi/internal/type/base_model.rbs +94 -0
- data/sig/knockapi/internal/type/base_page.rbs +24 -0
- data/sig/knockapi/internal/type/boolean.rbs +23 -0
- data/sig/knockapi/internal/type/converter.rbs +54 -0
- data/sig/knockapi/internal/type/enum.rbs +29 -0
- data/sig/knockapi/internal/type/file_input.rbs +23 -0
- data/sig/knockapi/internal/type/hash_of.rbs +45 -0
- data/sig/knockapi/internal/type/request_parameters.rbs +15 -0
- data/sig/knockapi/internal/type/union.rbs +49 -0
- data/sig/knockapi/internal/type/unknown.rbs +23 -0
- data/sig/knockapi/internal/util.rbs +158 -0
- data/sig/knockapi/internal.rbs +5 -0
- data/sig/knockapi/models/activity.rbs +54 -0
- data/sig/knockapi/models/audience_add_members_params.rbs +52 -0
- data/sig/knockapi/models/audience_list_members_params.rbs +15 -0
- data/sig/knockapi/models/audience_list_members_response.rbs +22 -0
- data/sig/knockapi/models/audience_member.rbs +34 -0
- data/sig/knockapi/models/audience_remove_members_params.rbs +54 -0
- data/sig/knockapi/models/bulk_operation.rbs +107 -0
- data/sig/knockapi/models/bulk_operation_get_params.rbs +15 -0
- data/sig/knockapi/models/channels/bulk_update_message_status_params.rbs +176 -0
- data/sig/knockapi/models/condition.rbs +71 -0
- data/sig/knockapi/models/identify_user_request.rbs +50 -0
- data/sig/knockapi/models/inline_identify_user_request.rbs +30 -0
- data/sig/knockapi/models/inline_object_request.rbs +34 -0
- data/sig/knockapi/models/inline_tenant_request.rbs +11 -0
- data/sig/knockapi/models/integrations/census_custom_destination_params.rbs +39 -0
- data/sig/knockapi/models/integrations/census_custom_destination_response.rbs +22 -0
- data/sig/knockapi/models/integrations/hightouch_embedded_destination_params.rbs +39 -0
- data/sig/knockapi/models/integrations/hightouch_embedded_destination_response.rbs +22 -0
- data/sig/knockapi/models/message.rbs +193 -0
- data/sig/knockapi/models/message_archive_params.rbs +15 -0
- data/sig/knockapi/models/message_delivery_log.rbs +152 -0
- data/sig/knockapi/models/message_event.rbs +77 -0
- data/sig/knockapi/models/message_get_content_params.rbs +15 -0
- data/sig/knockapi/models/message_get_content_response.rbs +338 -0
- data/sig/knockapi/models/message_get_params.rbs +15 -0
- data/sig/knockapi/models/message_list_activities_params.rbs +43 -0
- data/sig/knockapi/models/message_list_delivery_logs_params.rbs +33 -0
- data/sig/knockapi/models/message_list_events_params.rbs +33 -0
- data/sig/knockapi/models/message_list_params.rbs +176 -0
- data/sig/knockapi/models/message_mark_as_interacted_params.rbs +23 -0
- data/sig/knockapi/models/message_mark_as_read_params.rbs +15 -0
- data/sig/knockapi/models/message_mark_as_seen_params.rbs +15 -0
- data/sig/knockapi/models/message_mark_as_unread_params.rbs +15 -0
- data/sig/knockapi/models/message_mark_as_unseen_params.rbs +15 -0
- data/sig/knockapi/models/message_unarchive_params.rbs +15 -0
- data/sig/knockapi/models/messages/activity_list_params.rbs +45 -0
- data/sig/knockapi/models/messages/batch_archive_params.rbs +23 -0
- data/sig/knockapi/models/messages/batch_archive_response.rbs +9 -0
- data/sig/knockapi/models/messages/batch_get_content_params.rbs +23 -0
- data/sig/knockapi/models/messages/batch_get_content_response.rbs +349 -0
- data/sig/knockapi/models/messages/batch_mark_as_interacted_params.rbs +26 -0
- data/sig/knockapi/models/messages/batch_mark_as_interacted_response.rbs +10 -0
- data/sig/knockapi/models/messages/batch_mark_as_read_params.rbs +23 -0
- data/sig/knockapi/models/messages/batch_mark_as_read_response.rbs +9 -0
- data/sig/knockapi/models/messages/batch_mark_as_seen_params.rbs +23 -0
- data/sig/knockapi/models/messages/batch_mark_as_seen_response.rbs +9 -0
- data/sig/knockapi/models/messages/batch_mark_as_unread_params.rbs +23 -0
- data/sig/knockapi/models/messages/batch_mark_as_unread_response.rbs +9 -0
- data/sig/knockapi/models/messages/batch_mark_as_unseen_params.rbs +23 -0
- data/sig/knockapi/models/messages/batch_mark_as_unseen_response.rbs +9 -0
- data/sig/knockapi/models/messages/batch_unarchive_params.rbs +23 -0
- data/sig/knockapi/models/messages/batch_unarchive_response.rbs +9 -0
- data/sig/knockapi/models/object.rbs +34 -0
- data/sig/knockapi/models/object_add_subscriptions_params.rbs +27 -0
- data/sig/knockapi/models/object_add_subscriptions_response.rbs +8 -0
- data/sig/knockapi/models/object_delete_params.rbs +15 -0
- data/sig/knockapi/models/object_delete_subscriptions_params.rbs +21 -0
- data/sig/knockapi/models/object_delete_subscriptions_response.rbs +8 -0
- data/sig/knockapi/models/object_get_channel_data_params.rbs +15 -0
- data/sig/knockapi/models/object_get_params.rbs +14 -0
- data/sig/knockapi/models/object_get_preferences_params.rbs +15 -0
- data/sig/knockapi/models/object_list_messages_params.rbs +176 -0
- data/sig/knockapi/models/object_list_params.rbs +55 -0
- data/sig/knockapi/models/object_list_preferences_params.rbs +15 -0
- data/sig/knockapi/models/object_list_preferences_response.rbs +8 -0
- data/sig/knockapi/models/object_list_schedules_params.rbs +49 -0
- data/sig/knockapi/models/object_list_subscriptions_params.rbs +106 -0
- data/sig/knockapi/models/object_set_channel_data_params.rbs +15 -0
- data/sig/knockapi/models/object_set_params.rbs +43 -0
- data/sig/knockapi/models/object_set_preferences_params.rbs +15 -0
- data/sig/knockapi/models/object_unset_channel_data_params.rbs +15 -0
- data/sig/knockapi/models/objects/bulk_add_subscriptions_params.rbs +44 -0
- data/sig/knockapi/models/objects/bulk_delete_params.rbs +23 -0
- data/sig/knockapi/models/objects/bulk_set_params.rbs +23 -0
- data/sig/knockapi/models/page_info.rbs +25 -0
- data/sig/knockapi/models/providers/ms_team_check_auth_params.rbs +23 -0
- data/sig/knockapi/models/providers/ms_team_check_auth_response.rbs +32 -0
- data/sig/knockapi/models/providers/ms_team_list_channels_params.rbs +53 -0
- data/sig/knockapi/models/providers/ms_team_list_channels_response.rbs +61 -0
- data/sig/knockapi/models/providers/ms_team_list_teams_params.rbs +63 -0
- data/sig/knockapi/models/providers/ms_team_list_teams_response.rbs +24 -0
- data/sig/knockapi/models/providers/ms_team_revoke_access_params.rbs +23 -0
- data/sig/knockapi/models/providers/ms_team_revoke_access_response.rbs +17 -0
- data/sig/knockapi/models/providers/slack_check_auth_params.rbs +23 -0
- data/sig/knockapi/models/providers/slack_check_auth_response.rbs +32 -0
- data/sig/knockapi/models/providers/slack_list_channels_params.rbs +74 -0
- data/sig/knockapi/models/providers/slack_list_channels_response.rbs +36 -0
- data/sig/knockapi/models/providers/slack_revoke_access_params.rbs +23 -0
- data/sig/knockapi/models/providers/slack_revoke_access_response.rbs +17 -0
- data/sig/knockapi/models/recipient.rbs +11 -0
- data/sig/knockapi/models/recipient_reference.rbs +28 -0
- data/sig/knockapi/models/recipient_request.rbs +14 -0
- data/sig/knockapi/models/recipients/channel_data.rbs +74 -0
- data/sig/knockapi/models/recipients/channel_data_request.rbs +31 -0
- data/sig/knockapi/models/recipients/discord_channel_data.rbs +65 -0
- data/sig/knockapi/models/recipients/inline_channel_data_request.rbs +10 -0
- data/sig/knockapi/models/recipients/inline_preference_set_request.rbs +10 -0
- data/sig/knockapi/models/recipients/ms_teams_channel_data.rbs +86 -0
- data/sig/knockapi/models/recipients/one_signal_channel_data.rbs +15 -0
- data/sig/knockapi/models/recipients/preference_set.rbs +90 -0
- data/sig/knockapi/models/recipients/preference_set_channel_type_setting.rbs +18 -0
- data/sig/knockapi/models/recipients/preference_set_channel_types.rbs +118 -0
- data/sig/knockapi/models/recipients/preference_set_request.rbs +86 -0
- data/sig/knockapi/models/recipients/push_channel_data.rbs +15 -0
- data/sig/knockapi/models/recipients/slack_channel_data.rbs +73 -0
- data/sig/knockapi/models/recipients/subscription.rbs +40 -0
- data/sig/knockapi/models/schedule.rbs +64 -0
- data/sig/knockapi/models/schedule_create_params.rbs +47 -0
- data/sig/knockapi/models/schedule_create_response.rbs +7 -0
- data/sig/knockapi/models/schedule_delete_params.rbs +21 -0
- data/sig/knockapi/models/schedule_delete_response.rbs +7 -0
- data/sig/knockapi/models/schedule_list_params.rbs +53 -0
- data/sig/knockapi/models/schedule_repeat_rule.rbs +73 -0
- data/sig/knockapi/models/schedule_update_params.rbs +51 -0
- data/sig/knockapi/models/schedule_update_response.rbs +7 -0
- data/sig/knockapi/models/schedules/bulk_create_params.rbs +76 -0
- data/sig/knockapi/models/tenant.rbs +76 -0
- data/sig/knockapi/models/tenant_delete_params.rbs +15 -0
- data/sig/knockapi/models/tenant_get_params.rbs +14 -0
- data/sig/knockapi/models/tenant_list_params.rbs +49 -0
- data/sig/knockapi/models/tenant_request.rbs +84 -0
- data/sig/knockapi/models/tenant_set_params.rbs +85 -0
- data/sig/knockapi/models/tenants/bulk_delete_params.rbs +23 -0
- data/sig/knockapi/models/tenants/bulk_set_params.rbs +23 -0
- data/sig/knockapi/models/user.rbs +50 -0
- data/sig/knockapi/models/user_delete_params.rbs +15 -0
- data/sig/knockapi/models/user_get_channel_data_params.rbs +15 -0
- data/sig/knockapi/models/user_get_params.rbs +14 -0
- data/sig/knockapi/models/user_get_preferences_params.rbs +22 -0
- data/sig/knockapi/models/user_list_messages_params.rbs +176 -0
- data/sig/knockapi/models/user_list_params.rbs +55 -0
- data/sig/knockapi/models/user_list_preferences_params.rbs +15 -0
- data/sig/knockapi/models/user_list_preferences_response.rbs +8 -0
- data/sig/knockapi/models/user_list_schedules_params.rbs +49 -0
- data/sig/knockapi/models/user_list_subscriptions_params.rbs +61 -0
- data/sig/knockapi/models/user_merge_params.rbs +20 -0
- data/sig/knockapi/models/user_set_channel_data_params.rbs +15 -0
- data/sig/knockapi/models/user_set_preferences_params.rbs +15 -0
- data/sig/knockapi/models/user_unset_channel_data_params.rbs +15 -0
- data/sig/knockapi/models/user_update_params.rbs +15 -0
- data/sig/knockapi/models/users/bulk_delete_params.rbs +23 -0
- data/sig/knockapi/models/users/bulk_identify_params.rbs +23 -0
- data/sig/knockapi/models/users/bulk_set_preferences_params.rbs +29 -0
- data/sig/knockapi/models/users/feed_get_settings_params.rbs +17 -0
- data/sig/knockapi/models/users/feed_get_settings_response.rbs +28 -0
- data/sig/knockapi/models/users/feed_list_items_params.rbs +111 -0
- data/sig/knockapi/models/users/feed_list_items_response.rbs +214 -0
- data/sig/knockapi/models/users/guide_get_channel_params.rbs +35 -0
- data/sig/knockapi/models/users/guide_get_channel_response.rbs +71 -0
- data/sig/knockapi/models/users/guide_mark_message_as_archived_params.rbs +65 -0
- data/sig/knockapi/models/users/guide_mark_message_as_archived_response.rbs +15 -0
- data/sig/knockapi/models/users/guide_mark_message_as_interacted_params.rbs +65 -0
- data/sig/knockapi/models/users/guide_mark_message_as_interacted_response.rbs +15 -0
- data/sig/knockapi/models/users/guide_mark_message_as_seen_params.rbs +65 -0
- data/sig/knockapi/models/users/guide_mark_message_as_seen_response.rbs +15 -0
- data/sig/knockapi/models/workflow_cancel_params.rbs +27 -0
- data/sig/knockapi/models/workflow_trigger_params.rbs +39 -0
- data/sig/knockapi/models/workflow_trigger_response.rbs +13 -0
- data/sig/knockapi/request_options.rbs +34 -0
- data/sig/knockapi/resources/audiences.rbs +24 -0
- data/sig/knockapi/resources/bulk_operations.rbs +12 -0
- data/sig/knockapi/resources/channels/bulk.rbs +25 -0
- data/sig/knockapi/resources/channels.rbs +9 -0
- data/sig/knockapi/resources/integrations/census.rbs +17 -0
- data/sig/knockapi/resources/integrations/hightouch.rbs +17 -0
- data/sig/knockapi/resources/integrations.rbs +11 -0
- data/sig/knockapi/resources/messages/activities.rbs +18 -0
- data/sig/knockapi/resources/messages/batch.rbs +50 -0
- data/sig/knockapi/resources/messages.rbs +100 -0
- data/sig/knockapi/resources/objects/bulk.rbs +27 -0
- data/sig/knockapi/resources/objects.rbs +144 -0
- data/sig/knockapi/resources/providers/ms_teams.rbs +36 -0
- data/sig/knockapi/resources/providers/slack.rbs +28 -0
- data/sig/knockapi/resources/providers.rbs +11 -0
- data/sig/knockapi/resources/recipients/channel_data.rbs +9 -0
- data/sig/knockapi/resources/recipients/preferences.rbs +9 -0
- data/sig/knockapi/resources/recipients/subscriptions.rbs +9 -0
- data/sig/knockapi/resources/recipients.rbs +13 -0
- data/sig/knockapi/resources/schedules/bulk.rbs +14 -0
- data/sig/knockapi/resources/schedules.rbs +46 -0
- data/sig/knockapi/resources/shared.rbs +7 -0
- data/sig/knockapi/resources/tenants/bulk.rbs +19 -0
- data/sig/knockapi/resources/tenants.rbs +36 -0
- data/sig/knockapi/resources/users/bulk.rbs +25 -0
- data/sig/knockapi/resources/users/feeds.rbs +31 -0
- data/sig/knockapi/resources/users/guides.rbs +63 -0
- data/sig/knockapi/resources/users.rbs +130 -0
- data/sig/knockapi/resources/workflows.rbs +24 -0
- data/sig/knockapi/version.rbs +3 -0
- metadata +657 -77
- data/.github/workflows/publish.yml +0 -17
- data/.github/workflows/ruby.yml +0 -47
- data/.gitignore +0 -49
- data/.rubocop.yml +0 -8
- data/.ruby-version +0 -1
- data/.tool-versions +0 -1
- data/CONTRIBUTING.md +0 -31
- data/Gemfile +0 -9
- data/Gemfile.lock +0 -63
- data/LICENSE +0 -21
- data/bin/console +0 -8
- data/bin/publish +0 -5
- data/knockapi.gemspec +0 -30
- data/lib/knock/bulk_operations.rb +0 -27
- data/lib/knock/client.rb +0 -149
- data/lib/knock/configuration.rb +0 -18
- data/lib/knock/errors.rb +0 -57
- data/lib/knock/messages.rb +0 -93
- data/lib/knock/objects.rb +0 -442
- data/lib/knock/preferences.rb +0 -114
- data/lib/knock/tenants.rb +0 -72
- data/lib/knock/users.rb +0 -420
- data/lib/knock/version.rb +0 -5
- data/lib/knock/workflows.rb +0 -152
- data/lib/knock.rb +0 -71
- data/spec/configuration_spec.rb +0 -63
- data/spec/tenants_spec.rb +0 -66
@@ -0,0 +1,90 @@
|
|
1
|
+
# typed: strong
|
2
|
+
|
3
|
+
module Knockapi
|
4
|
+
module Models
|
5
|
+
class AudienceRemoveMembersParams < Knockapi::Internal::Type::BaseModel
|
6
|
+
extend Knockapi::Internal::Type::RequestParameters::Converter
|
7
|
+
include Knockapi::Internal::Type::RequestParameters
|
8
|
+
|
9
|
+
# A list of audience members to remove.
|
10
|
+
sig { returns(T::Array[Knockapi::Models::AudienceRemoveMembersParams::Member]) }
|
11
|
+
attr_accessor :members
|
12
|
+
|
13
|
+
sig do
|
14
|
+
params(
|
15
|
+
members: T::Array[T.any(Knockapi::Models::AudienceRemoveMembersParams::Member, Knockapi::Internal::AnyHash)],
|
16
|
+
request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
|
17
|
+
)
|
18
|
+
.returns(T.attached_class)
|
19
|
+
end
|
20
|
+
def self.new(
|
21
|
+
# A list of audience members to remove.
|
22
|
+
members:,
|
23
|
+
request_options: {}
|
24
|
+
); end
|
25
|
+
sig do
|
26
|
+
override
|
27
|
+
.returns(
|
28
|
+
{
|
29
|
+
members: T::Array[Knockapi::Models::AudienceRemoveMembersParams::Member],
|
30
|
+
request_options: Knockapi::RequestOptions
|
31
|
+
}
|
32
|
+
)
|
33
|
+
end
|
34
|
+
def to_hash; end
|
35
|
+
|
36
|
+
class Member < Knockapi::Internal::Type::BaseModel
|
37
|
+
sig { returns(Knockapi::Models::AudienceRemoveMembersParams::Member::User) }
|
38
|
+
attr_reader :user
|
39
|
+
|
40
|
+
sig do
|
41
|
+
params(
|
42
|
+
user: T.any(Knockapi::Models::AudienceRemoveMembersParams::Member::User, Knockapi::Internal::AnyHash)
|
43
|
+
)
|
44
|
+
.void
|
45
|
+
end
|
46
|
+
attr_writer :user
|
47
|
+
|
48
|
+
# The unique identifier for the tenant.
|
49
|
+
sig { returns(T.nilable(String)) }
|
50
|
+
attr_accessor :tenant
|
51
|
+
|
52
|
+
# An audience member.
|
53
|
+
sig do
|
54
|
+
params(
|
55
|
+
user: T.any(Knockapi::Models::AudienceRemoveMembersParams::Member::User, Knockapi::Internal::AnyHash),
|
56
|
+
tenant: T.nilable(String)
|
57
|
+
)
|
58
|
+
.returns(T.attached_class)
|
59
|
+
end
|
60
|
+
def self.new(
|
61
|
+
user:,
|
62
|
+
# The unique identifier for the tenant.
|
63
|
+
tenant: nil
|
64
|
+
); end
|
65
|
+
sig do
|
66
|
+
override
|
67
|
+
.returns({user: Knockapi::Models::AudienceRemoveMembersParams::Member::User, tenant: T.nilable(String)})
|
68
|
+
end
|
69
|
+
def to_hash; end
|
70
|
+
|
71
|
+
class User < Knockapi::Internal::Type::BaseModel
|
72
|
+
# The ID for the user that you set when identifying them in Knock.
|
73
|
+
sig { returns(T.nilable(String)) }
|
74
|
+
attr_reader :id
|
75
|
+
|
76
|
+
sig { params(id: String).void }
|
77
|
+
attr_writer :id
|
78
|
+
|
79
|
+
sig { params(id: String).returns(T.attached_class) }
|
80
|
+
def self.new(
|
81
|
+
# The ID for the user that you set when identifying them in Knock.
|
82
|
+
id: nil
|
83
|
+
); end
|
84
|
+
sig { override.returns({id: String}) }
|
85
|
+
def to_hash; end
|
86
|
+
end
|
87
|
+
end
|
88
|
+
end
|
89
|
+
end
|
90
|
+
end
|
@@ -0,0 +1,194 @@
|
|
1
|
+
# typed: strong
|
2
|
+
|
3
|
+
module Knockapi
|
4
|
+
module Models
|
5
|
+
class BulkOperation < Knockapi::Internal::Type::BaseModel
|
6
|
+
# Unique identifier for the bulk operation.
|
7
|
+
sig { returns(String) }
|
8
|
+
attr_accessor :id
|
9
|
+
|
10
|
+
# The typename of the schema.
|
11
|
+
sig { returns(String) }
|
12
|
+
attr_accessor :_typename
|
13
|
+
|
14
|
+
# The estimated total number of rows to process.
|
15
|
+
sig { returns(Integer) }
|
16
|
+
attr_accessor :estimated_total_rows
|
17
|
+
|
18
|
+
# Timestamp when the resource was created.
|
19
|
+
sig { returns(Time) }
|
20
|
+
attr_accessor :inserted_at
|
21
|
+
|
22
|
+
# The name of the bulk operation.
|
23
|
+
sig { returns(String) }
|
24
|
+
attr_accessor :name
|
25
|
+
|
26
|
+
# The number of rows processed so far.
|
27
|
+
sig { returns(Integer) }
|
28
|
+
attr_accessor :processed_rows
|
29
|
+
|
30
|
+
# The status of the bulk operation.
|
31
|
+
sig { returns(Knockapi::Models::BulkOperation::Status::TaggedSymbol) }
|
32
|
+
attr_accessor :status
|
33
|
+
|
34
|
+
# The number of successful operations.
|
35
|
+
sig { returns(Integer) }
|
36
|
+
attr_accessor :success_count
|
37
|
+
|
38
|
+
# The timestamp when the resource was last updated.
|
39
|
+
sig { returns(Time) }
|
40
|
+
attr_accessor :updated_at
|
41
|
+
|
42
|
+
# Timestamp when the bulk operation was completed.
|
43
|
+
sig { returns(T.nilable(Time)) }
|
44
|
+
attr_accessor :completed_at
|
45
|
+
|
46
|
+
# The number of failed operations.
|
47
|
+
sig { returns(T.nilable(Integer)) }
|
48
|
+
attr_reader :error_count
|
49
|
+
|
50
|
+
sig { params(error_count: Integer).void }
|
51
|
+
attr_writer :error_count
|
52
|
+
|
53
|
+
# A list of items that failed to be processed.
|
54
|
+
sig { returns(T.nilable(T::Array[Knockapi::Models::BulkOperation::ErrorItem])) }
|
55
|
+
attr_reader :error_items
|
56
|
+
|
57
|
+
sig do
|
58
|
+
params(
|
59
|
+
error_items: T::Array[T.any(Knockapi::Models::BulkOperation::ErrorItem, Knockapi::Internal::AnyHash)]
|
60
|
+
)
|
61
|
+
.void
|
62
|
+
end
|
63
|
+
attr_writer :error_items
|
64
|
+
|
65
|
+
# Timestamp when the bulk operation failed.
|
66
|
+
sig { returns(T.nilable(Time)) }
|
67
|
+
attr_accessor :failed_at
|
68
|
+
|
69
|
+
# The URI to the bulk operation's progress.
|
70
|
+
sig { returns(T.nilable(String)) }
|
71
|
+
attr_reader :progress_path
|
72
|
+
|
73
|
+
sig { params(progress_path: String).void }
|
74
|
+
attr_writer :progress_path
|
75
|
+
|
76
|
+
# Timestamp when the bulk operation was started.
|
77
|
+
sig { returns(T.nilable(Time)) }
|
78
|
+
attr_accessor :started_at
|
79
|
+
|
80
|
+
# A bulk operation entity.
|
81
|
+
sig do
|
82
|
+
params(
|
83
|
+
id: String,
|
84
|
+
_typename: String,
|
85
|
+
estimated_total_rows: Integer,
|
86
|
+
inserted_at: Time,
|
87
|
+
name: String,
|
88
|
+
processed_rows: Integer,
|
89
|
+
status: Knockapi::Models::BulkOperation::Status::OrSymbol,
|
90
|
+
success_count: Integer,
|
91
|
+
updated_at: Time,
|
92
|
+
completed_at: T.nilable(Time),
|
93
|
+
error_count: Integer,
|
94
|
+
error_items: T::Array[T.any(Knockapi::Models::BulkOperation::ErrorItem, Knockapi::Internal::AnyHash)],
|
95
|
+
failed_at: T.nilable(Time),
|
96
|
+
progress_path: String,
|
97
|
+
started_at: T.nilable(Time)
|
98
|
+
)
|
99
|
+
.returns(T.attached_class)
|
100
|
+
end
|
101
|
+
def self.new(
|
102
|
+
# Unique identifier for the bulk operation.
|
103
|
+
id:,
|
104
|
+
# The typename of the schema.
|
105
|
+
_typename:,
|
106
|
+
# The estimated total number of rows to process.
|
107
|
+
estimated_total_rows:,
|
108
|
+
# Timestamp when the resource was created.
|
109
|
+
inserted_at:,
|
110
|
+
# The name of the bulk operation.
|
111
|
+
name:,
|
112
|
+
# The number of rows processed so far.
|
113
|
+
processed_rows:,
|
114
|
+
# The status of the bulk operation.
|
115
|
+
status:,
|
116
|
+
# The number of successful operations.
|
117
|
+
success_count:,
|
118
|
+
# The timestamp when the resource was last updated.
|
119
|
+
updated_at:,
|
120
|
+
# Timestamp when the bulk operation was completed.
|
121
|
+
completed_at: nil,
|
122
|
+
# The number of failed operations.
|
123
|
+
error_count: nil,
|
124
|
+
# A list of items that failed to be processed.
|
125
|
+
error_items: nil,
|
126
|
+
# Timestamp when the bulk operation failed.
|
127
|
+
failed_at: nil,
|
128
|
+
# The URI to the bulk operation's progress.
|
129
|
+
progress_path: nil,
|
130
|
+
# Timestamp when the bulk operation was started.
|
131
|
+
started_at: nil
|
132
|
+
); end
|
133
|
+
sig do
|
134
|
+
override
|
135
|
+
.returns(
|
136
|
+
{
|
137
|
+
id: String,
|
138
|
+
_typename: String,
|
139
|
+
estimated_total_rows: Integer,
|
140
|
+
inserted_at: Time,
|
141
|
+
name: String,
|
142
|
+
processed_rows: Integer,
|
143
|
+
status: Knockapi::Models::BulkOperation::Status::TaggedSymbol,
|
144
|
+
success_count: Integer,
|
145
|
+
updated_at: Time,
|
146
|
+
completed_at: T.nilable(Time),
|
147
|
+
error_count: Integer,
|
148
|
+
error_items: T::Array[Knockapi::Models::BulkOperation::ErrorItem],
|
149
|
+
failed_at: T.nilable(Time),
|
150
|
+
progress_path: String,
|
151
|
+
started_at: T.nilable(Time)
|
152
|
+
}
|
153
|
+
)
|
154
|
+
end
|
155
|
+
def to_hash; end
|
156
|
+
|
157
|
+
# The status of the bulk operation.
|
158
|
+
module Status
|
159
|
+
extend Knockapi::Internal::Type::Enum
|
160
|
+
|
161
|
+
TaggedSymbol = T.type_alias { T.all(Symbol, Knockapi::Models::BulkOperation::Status) }
|
162
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
163
|
+
|
164
|
+
QUEUED = T.let(:queued, Knockapi::Models::BulkOperation::Status::TaggedSymbol)
|
165
|
+
PROCESSING = T.let(:processing, Knockapi::Models::BulkOperation::Status::TaggedSymbol)
|
166
|
+
COMPLETED = T.let(:completed, Knockapi::Models::BulkOperation::Status::TaggedSymbol)
|
167
|
+
FAILED = T.let(:failed, Knockapi::Models::BulkOperation::Status::TaggedSymbol)
|
168
|
+
|
169
|
+
sig { override.returns(T::Array[Knockapi::Models::BulkOperation::Status::TaggedSymbol]) }
|
170
|
+
def self.values; end
|
171
|
+
end
|
172
|
+
|
173
|
+
class ErrorItem < Knockapi::Internal::Type::BaseModel
|
174
|
+
# Unique identifier for the object.
|
175
|
+
sig { returns(String) }
|
176
|
+
attr_accessor :id
|
177
|
+
|
178
|
+
# The collection this object belongs to.
|
179
|
+
sig { returns(T.nilable(String)) }
|
180
|
+
attr_accessor :collection
|
181
|
+
|
182
|
+
sig { params(id: String, collection: T.nilable(String)).returns(T.attached_class) }
|
183
|
+
def self.new(
|
184
|
+
# Unique identifier for the object.
|
185
|
+
id:,
|
186
|
+
# The collection this object belongs to.
|
187
|
+
collection: nil
|
188
|
+
); end
|
189
|
+
sig { override.returns({id: String, collection: T.nilable(String)}) }
|
190
|
+
def to_hash; end
|
191
|
+
end
|
192
|
+
end
|
193
|
+
end
|
194
|
+
end
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# typed: strong
|
2
|
+
|
3
|
+
module Knockapi
|
4
|
+
module Models
|
5
|
+
class BulkOperationGetParams < Knockapi::Internal::Type::BaseModel
|
6
|
+
extend Knockapi::Internal::Type::RequestParameters::Converter
|
7
|
+
include Knockapi::Internal::Type::RequestParameters
|
8
|
+
|
9
|
+
sig do
|
10
|
+
params(request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash))
|
11
|
+
.returns(T.attached_class)
|
12
|
+
end
|
13
|
+
def self.new(request_options: {}); end
|
14
|
+
|
15
|
+
sig { override.returns({request_options: Knockapi::RequestOptions}) }
|
16
|
+
def to_hash; end
|
17
|
+
end
|
18
|
+
end
|
19
|
+
end
|
@@ -0,0 +1,287 @@
|
|
1
|
+
# typed: strong
|
2
|
+
|
3
|
+
module Knockapi
|
4
|
+
module Models
|
5
|
+
module Channels
|
6
|
+
class BulkUpdateMessageStatusParams < Knockapi::Internal::Type::BaseModel
|
7
|
+
extend Knockapi::Internal::Type::RequestParameters::Converter
|
8
|
+
include Knockapi::Internal::Type::RequestParameters
|
9
|
+
|
10
|
+
# Limits the results to messages with the given archived status.
|
11
|
+
sig { returns(T.nilable(Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Archived::OrSymbol)) }
|
12
|
+
attr_reader :archived
|
13
|
+
|
14
|
+
sig { params(archived: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Archived::OrSymbol).void }
|
15
|
+
attr_writer :archived
|
16
|
+
|
17
|
+
# Limits the results to messages with the given delivery status.
|
18
|
+
sig { returns(T.nilable(Knockapi::Models::Channels::BulkUpdateMessageStatusParams::DeliveryStatus::OrSymbol)) }
|
19
|
+
attr_reader :delivery_status
|
20
|
+
|
21
|
+
sig do
|
22
|
+
params(
|
23
|
+
delivery_status: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::DeliveryStatus::OrSymbol
|
24
|
+
)
|
25
|
+
.void
|
26
|
+
end
|
27
|
+
attr_writer :delivery_status
|
28
|
+
|
29
|
+
# Limits the results to messages with the given engagement status.
|
30
|
+
sig { returns(T.nilable(Knockapi::Models::Channels::BulkUpdateMessageStatusParams::EngagementStatus::OrSymbol)) }
|
31
|
+
attr_reader :engagement_status
|
32
|
+
|
33
|
+
sig do
|
34
|
+
params(
|
35
|
+
engagement_status: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::EngagementStatus::OrSymbol
|
36
|
+
)
|
37
|
+
.void
|
38
|
+
end
|
39
|
+
attr_writer :engagement_status
|
40
|
+
|
41
|
+
# Limits the results to messages that have a tenant or not.
|
42
|
+
sig { returns(T.nilable(T::Boolean)) }
|
43
|
+
attr_reader :has_tenant
|
44
|
+
|
45
|
+
sig { params(has_tenant: T::Boolean).void }
|
46
|
+
attr_writer :has_tenant
|
47
|
+
|
48
|
+
# Limits the results to messages inserted after the given date.
|
49
|
+
sig { returns(T.nilable(Time)) }
|
50
|
+
attr_reader :newer_than
|
51
|
+
|
52
|
+
sig { params(newer_than: Time).void }
|
53
|
+
attr_writer :newer_than
|
54
|
+
|
55
|
+
# Limits the results to messages inserted before the given date.
|
56
|
+
sig { returns(T.nilable(Time)) }
|
57
|
+
attr_reader :older_than
|
58
|
+
|
59
|
+
sig { params(older_than: Time).void }
|
60
|
+
attr_writer :older_than
|
61
|
+
|
62
|
+
# Limits the results to messages with the given recipient IDs.
|
63
|
+
sig { returns(T.nilable(T::Array[String])) }
|
64
|
+
attr_reader :recipient_ids
|
65
|
+
|
66
|
+
sig { params(recipient_ids: T::Array[String]).void }
|
67
|
+
attr_writer :recipient_ids
|
68
|
+
|
69
|
+
# Limits the results to messages with the given tenant IDs.
|
70
|
+
sig { returns(T.nilable(T::Array[String])) }
|
71
|
+
attr_reader :tenants
|
72
|
+
|
73
|
+
sig { params(tenants: T::Array[String]).void }
|
74
|
+
attr_writer :tenants
|
75
|
+
|
76
|
+
# Limits the results to only messages that were generated with the given data. See
|
77
|
+
# [trigger data filtering](/api-reference/overview/trigger-data-filtering) for
|
78
|
+
# more information.
|
79
|
+
sig { returns(T.nilable(String)) }
|
80
|
+
attr_reader :trigger_data
|
81
|
+
|
82
|
+
sig { params(trigger_data: String).void }
|
83
|
+
attr_writer :trigger_data
|
84
|
+
|
85
|
+
# Limits the results to messages with the given workflow keys.
|
86
|
+
sig { returns(T.nilable(T::Array[String])) }
|
87
|
+
attr_reader :workflows
|
88
|
+
|
89
|
+
sig { params(workflows: T::Array[String]).void }
|
90
|
+
attr_writer :workflows
|
91
|
+
|
92
|
+
sig do
|
93
|
+
params(
|
94
|
+
archived: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Archived::OrSymbol,
|
95
|
+
delivery_status: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::DeliveryStatus::OrSymbol,
|
96
|
+
engagement_status: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::EngagementStatus::OrSymbol,
|
97
|
+
has_tenant: T::Boolean,
|
98
|
+
newer_than: Time,
|
99
|
+
older_than: Time,
|
100
|
+
recipient_ids: T::Array[String],
|
101
|
+
tenants: T::Array[String],
|
102
|
+
trigger_data: String,
|
103
|
+
workflows: T::Array[String],
|
104
|
+
request_options: T.any(Knockapi::RequestOptions, Knockapi::Internal::AnyHash)
|
105
|
+
)
|
106
|
+
.returns(T.attached_class)
|
107
|
+
end
|
108
|
+
def self.new(
|
109
|
+
# Limits the results to messages with the given archived status.
|
110
|
+
archived: nil,
|
111
|
+
# Limits the results to messages with the given delivery status.
|
112
|
+
delivery_status: nil,
|
113
|
+
# Limits the results to messages with the given engagement status.
|
114
|
+
engagement_status: nil,
|
115
|
+
# Limits the results to messages that have a tenant or not.
|
116
|
+
has_tenant: nil,
|
117
|
+
# Limits the results to messages inserted after the given date.
|
118
|
+
newer_than: nil,
|
119
|
+
# Limits the results to messages inserted before the given date.
|
120
|
+
older_than: nil,
|
121
|
+
# Limits the results to messages with the given recipient IDs.
|
122
|
+
recipient_ids: nil,
|
123
|
+
# Limits the results to messages with the given tenant IDs.
|
124
|
+
tenants: nil,
|
125
|
+
# Limits the results to only messages that were generated with the given data. See
|
126
|
+
# [trigger data filtering](/api-reference/overview/trigger-data-filtering) for
|
127
|
+
# more information.
|
128
|
+
trigger_data: nil,
|
129
|
+
# Limits the results to messages with the given workflow keys.
|
130
|
+
workflows: nil,
|
131
|
+
request_options: {}
|
132
|
+
); end
|
133
|
+
sig do
|
134
|
+
override
|
135
|
+
.returns(
|
136
|
+
{
|
137
|
+
archived: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Archived::OrSymbol,
|
138
|
+
delivery_status: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::DeliveryStatus::OrSymbol,
|
139
|
+
engagement_status: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::EngagementStatus::OrSymbol,
|
140
|
+
has_tenant: T::Boolean,
|
141
|
+
newer_than: Time,
|
142
|
+
older_than: Time,
|
143
|
+
recipient_ids: T::Array[String],
|
144
|
+
tenants: T::Array[String],
|
145
|
+
trigger_data: String,
|
146
|
+
workflows: T::Array[String],
|
147
|
+
request_options: Knockapi::RequestOptions
|
148
|
+
}
|
149
|
+
)
|
150
|
+
end
|
151
|
+
def to_hash; end
|
152
|
+
|
153
|
+
module Action
|
154
|
+
extend Knockapi::Internal::Type::Enum
|
155
|
+
|
156
|
+
TaggedSymbol =
|
157
|
+
T.type_alias { T.all(Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Action) }
|
158
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
159
|
+
|
160
|
+
SEEN = T.let(:seen, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Action::TaggedSymbol)
|
161
|
+
UNSEEN = T.let(:unseen, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Action::TaggedSymbol)
|
162
|
+
READ = T.let(:read, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Action::TaggedSymbol)
|
163
|
+
UNREAD = T.let(:unread, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Action::TaggedSymbol)
|
164
|
+
ARCHIVED =
|
165
|
+
T.let(:archived, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Action::TaggedSymbol)
|
166
|
+
UNARCHIVED =
|
167
|
+
T.let(:unarchived, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Action::TaggedSymbol)
|
168
|
+
INTERACTED =
|
169
|
+
T.let(:interacted, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Action::TaggedSymbol)
|
170
|
+
ARCHIVE =
|
171
|
+
T.let(:archive, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Action::TaggedSymbol)
|
172
|
+
UNARCHIVE =
|
173
|
+
T.let(:unarchive, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Action::TaggedSymbol)
|
174
|
+
DELETE = T.let(:delete, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Action::TaggedSymbol)
|
175
|
+
|
176
|
+
sig do
|
177
|
+
override.returns(T::Array[Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Action::TaggedSymbol])
|
178
|
+
end
|
179
|
+
def self.values; end
|
180
|
+
end
|
181
|
+
|
182
|
+
# Limits the results to messages with the given archived status.
|
183
|
+
module Archived
|
184
|
+
extend Knockapi::Internal::Type::Enum
|
185
|
+
|
186
|
+
TaggedSymbol =
|
187
|
+
T.type_alias { T.all(Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Archived) }
|
188
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
189
|
+
|
190
|
+
EXCLUDE =
|
191
|
+
T.let(:exclude, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Archived::TaggedSymbol)
|
192
|
+
INCLUDE =
|
193
|
+
T.let(:include, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Archived::TaggedSymbol)
|
194
|
+
ONLY = T.let(:only, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Archived::TaggedSymbol)
|
195
|
+
|
196
|
+
sig do
|
197
|
+
override
|
198
|
+
.returns(T::Array[Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Archived::TaggedSymbol])
|
199
|
+
end
|
200
|
+
def self.values; end
|
201
|
+
end
|
202
|
+
|
203
|
+
# Limits the results to messages with the given delivery status.
|
204
|
+
module DeliveryStatus
|
205
|
+
extend Knockapi::Internal::Type::Enum
|
206
|
+
|
207
|
+
TaggedSymbol =
|
208
|
+
T.type_alias { T.all(Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::DeliveryStatus) }
|
209
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
210
|
+
|
211
|
+
QUEUED =
|
212
|
+
T.let(:queued, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::DeliveryStatus::TaggedSymbol)
|
213
|
+
SENT =
|
214
|
+
T.let(:sent, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::DeliveryStatus::TaggedSymbol)
|
215
|
+
DELIVERED =
|
216
|
+
T.let(:delivered, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::DeliveryStatus::TaggedSymbol)
|
217
|
+
DELIVERY_ATTEMPTED =
|
218
|
+
T.let(
|
219
|
+
:delivery_attempted,
|
220
|
+
Knockapi::Models::Channels::BulkUpdateMessageStatusParams::DeliveryStatus::TaggedSymbol
|
221
|
+
)
|
222
|
+
UNDELIVERED =
|
223
|
+
T.let(
|
224
|
+
:undelivered,
|
225
|
+
Knockapi::Models::Channels::BulkUpdateMessageStatusParams::DeliveryStatus::TaggedSymbol
|
226
|
+
)
|
227
|
+
NOT_SENT =
|
228
|
+
T.let(:not_sent, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::DeliveryStatus::TaggedSymbol)
|
229
|
+
BOUNCED =
|
230
|
+
T.let(:bounced, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::DeliveryStatus::TaggedSymbol)
|
231
|
+
|
232
|
+
sig do
|
233
|
+
override
|
234
|
+
.returns(T::Array[Knockapi::Models::Channels::BulkUpdateMessageStatusParams::DeliveryStatus::TaggedSymbol])
|
235
|
+
end
|
236
|
+
def self.values; end
|
237
|
+
end
|
238
|
+
|
239
|
+
# Limits the results to messages with the given engagement status.
|
240
|
+
module EngagementStatus
|
241
|
+
extend Knockapi::Internal::Type::Enum
|
242
|
+
|
243
|
+
TaggedSymbol =
|
244
|
+
T.type_alias { T.all(Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::EngagementStatus) }
|
245
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
246
|
+
|
247
|
+
SEEN =
|
248
|
+
T.let(:seen, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::EngagementStatus::TaggedSymbol)
|
249
|
+
UNSEEN =
|
250
|
+
T.let(:unseen, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::EngagementStatus::TaggedSymbol)
|
251
|
+
READ =
|
252
|
+
T.let(:read, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::EngagementStatus::TaggedSymbol)
|
253
|
+
UNREAD =
|
254
|
+
T.let(:unread, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::EngagementStatus::TaggedSymbol)
|
255
|
+
ARCHIVED =
|
256
|
+
T.let(
|
257
|
+
:archived,
|
258
|
+
Knockapi::Models::Channels::BulkUpdateMessageStatusParams::EngagementStatus::TaggedSymbol
|
259
|
+
)
|
260
|
+
UNARCHIVED =
|
261
|
+
T.let(
|
262
|
+
:unarchived,
|
263
|
+
Knockapi::Models::Channels::BulkUpdateMessageStatusParams::EngagementStatus::TaggedSymbol
|
264
|
+
)
|
265
|
+
LINK_CLICKED =
|
266
|
+
T.let(
|
267
|
+
:link_clicked,
|
268
|
+
Knockapi::Models::Channels::BulkUpdateMessageStatusParams::EngagementStatus::TaggedSymbol
|
269
|
+
)
|
270
|
+
INTERACTED =
|
271
|
+
T.let(
|
272
|
+
:interacted,
|
273
|
+
Knockapi::Models::Channels::BulkUpdateMessageStatusParams::EngagementStatus::TaggedSymbol
|
274
|
+
)
|
275
|
+
|
276
|
+
sig do
|
277
|
+
override
|
278
|
+
.returns(
|
279
|
+
T::Array[Knockapi::Models::Channels::BulkUpdateMessageStatusParams::EngagementStatus::TaggedSymbol]
|
280
|
+
)
|
281
|
+
end
|
282
|
+
def self.values; end
|
283
|
+
end
|
284
|
+
end
|
285
|
+
end
|
286
|
+
end
|
287
|
+
end
|
@@ -0,0 +1,77 @@
|
|
1
|
+
# typed: strong
|
2
|
+
|
3
|
+
module Knockapi
|
4
|
+
module Models
|
5
|
+
class Condition < Knockapi::Internal::Type::BaseModel
|
6
|
+
# The argument value to compare against in the condition.
|
7
|
+
sig { returns(T.nilable(String)) }
|
8
|
+
attr_accessor :argument
|
9
|
+
|
10
|
+
# The operator to use in the condition evaluation.
|
11
|
+
sig { returns(Knockapi::Models::Condition::Operator::OrSymbol) }
|
12
|
+
attr_accessor :operator
|
13
|
+
|
14
|
+
# The variable to be evaluated in the condition.
|
15
|
+
sig { returns(String) }
|
16
|
+
attr_accessor :variable
|
17
|
+
|
18
|
+
# A condition to be evaluated.
|
19
|
+
sig do
|
20
|
+
params(
|
21
|
+
argument: T.nilable(String),
|
22
|
+
operator: Knockapi::Models::Condition::Operator::OrSymbol,
|
23
|
+
variable: String
|
24
|
+
)
|
25
|
+
.returns(T.attached_class)
|
26
|
+
end
|
27
|
+
def self.new(
|
28
|
+
# The argument value to compare against in the condition.
|
29
|
+
argument:,
|
30
|
+
# The operator to use in the condition evaluation.
|
31
|
+
operator:,
|
32
|
+
# The variable to be evaluated in the condition.
|
33
|
+
variable:
|
34
|
+
); end
|
35
|
+
sig do
|
36
|
+
override
|
37
|
+
.returns(
|
38
|
+
{argument: T.nilable(String), operator: Knockapi::Models::Condition::Operator::OrSymbol, variable: String}
|
39
|
+
)
|
40
|
+
end
|
41
|
+
def to_hash; end
|
42
|
+
|
43
|
+
# The operator to use in the condition evaluation.
|
44
|
+
module Operator
|
45
|
+
extend Knockapi::Internal::Type::Enum
|
46
|
+
|
47
|
+
TaggedSymbol = T.type_alias { T.all(Symbol, Knockapi::Models::Condition::Operator) }
|
48
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
49
|
+
|
50
|
+
EQUAL_TO = T.let(:equal_to, Knockapi::Models::Condition::Operator::TaggedSymbol)
|
51
|
+
NOT_EQUAL_TO = T.let(:not_equal_to, Knockapi::Models::Condition::Operator::TaggedSymbol)
|
52
|
+
GREATER_THAN = T.let(:greater_than, Knockapi::Models::Condition::Operator::TaggedSymbol)
|
53
|
+
LESS_THAN = T.let(:less_than, Knockapi::Models::Condition::Operator::TaggedSymbol)
|
54
|
+
GREATER_THAN_OR_EQUAL_TO =
|
55
|
+
T.let(:greater_than_or_equal_to, Knockapi::Models::Condition::Operator::TaggedSymbol)
|
56
|
+
LESS_THAN_OR_EQUAL_TO =
|
57
|
+
T.let(:less_than_or_equal_to, Knockapi::Models::Condition::Operator::TaggedSymbol)
|
58
|
+
CONTAINS = T.let(:contains, Knockapi::Models::Condition::Operator::TaggedSymbol)
|
59
|
+
NOT_CONTAINS = T.let(:not_contains, Knockapi::Models::Condition::Operator::TaggedSymbol)
|
60
|
+
EMPTY = T.let(:empty, Knockapi::Models::Condition::Operator::TaggedSymbol)
|
61
|
+
NOT_EMPTY = T.let(:not_empty, Knockapi::Models::Condition::Operator::TaggedSymbol)
|
62
|
+
CONTAINS_ALL = T.let(:contains_all, Knockapi::Models::Condition::Operator::TaggedSymbol)
|
63
|
+
IS_TIMESTAMP = T.let(:is_timestamp, Knockapi::Models::Condition::Operator::TaggedSymbol)
|
64
|
+
IS_NOT_TIMESTAMP = T.let(:is_not_timestamp, Knockapi::Models::Condition::Operator::TaggedSymbol)
|
65
|
+
IS_TIMESTAMP_AFTER = T.let(:is_timestamp_after, Knockapi::Models::Condition::Operator::TaggedSymbol)
|
66
|
+
IS_TIMESTAMP_BEFORE = T.let(:is_timestamp_before, Knockapi::Models::Condition::Operator::TaggedSymbol)
|
67
|
+
IS_TIMESTAMP_BETWEEN = T.let(:is_timestamp_between, Knockapi::Models::Condition::Operator::TaggedSymbol)
|
68
|
+
IS_AUDIENCE_MEMBER = T.let(:is_audience_member, Knockapi::Models::Condition::Operator::TaggedSymbol)
|
69
|
+
IS_NOT_AUDIENCE_MEMBER =
|
70
|
+
T.let(:is_not_audience_member, Knockapi::Models::Condition::Operator::TaggedSymbol)
|
71
|
+
|
72
|
+
sig { override.returns(T::Array[Knockapi::Models::Condition::Operator::TaggedSymbol]) }
|
73
|
+
def self.values; end
|
74
|
+
end
|
75
|
+
end
|
76
|
+
end
|
77
|
+
end
|