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,322 @@
|
|
1
|
+
# typed: strong
|
2
|
+
|
3
|
+
module Knockapi
|
4
|
+
module Models
|
5
|
+
class Message < Knockapi::Internal::Type::BaseModel
|
6
|
+
# The unique identifier for the message.
|
7
|
+
sig { returns(T.nilable(String)) }
|
8
|
+
attr_reader :id
|
9
|
+
|
10
|
+
sig { params(id: String).void }
|
11
|
+
attr_writer :id
|
12
|
+
|
13
|
+
# The typename of the schema.
|
14
|
+
sig { returns(T.nilable(String)) }
|
15
|
+
attr_reader :_typename
|
16
|
+
|
17
|
+
sig { params(_typename: String).void }
|
18
|
+
attr_writer :_typename
|
19
|
+
|
20
|
+
# One or more actors that are associated with this message. Note: this is a list
|
21
|
+
# that can contain up to 10 actors if the message is produced from a
|
22
|
+
# [batch](/designing-workflows/batch-function).
|
23
|
+
sig { returns(T.nilable(T::Array[T.any(String, Knockapi::Models::RecipientReference::ObjectReference)])) }
|
24
|
+
attr_reader :actors
|
25
|
+
|
26
|
+
sig do
|
27
|
+
params(
|
28
|
+
actors: T::Array[T.any(String, Knockapi::Models::RecipientReference::ObjectReference, Knockapi::Internal::AnyHash)]
|
29
|
+
)
|
30
|
+
.void
|
31
|
+
end
|
32
|
+
attr_writer :actors
|
33
|
+
|
34
|
+
# Timestamp when the message was archived.
|
35
|
+
sig { returns(T.nilable(Time)) }
|
36
|
+
attr_accessor :archived_at
|
37
|
+
|
38
|
+
# The ID for the channel the message was sent through.
|
39
|
+
sig { returns(T.nilable(String)) }
|
40
|
+
attr_reader :channel_id
|
41
|
+
|
42
|
+
sig { params(channel_id: String).void }
|
43
|
+
attr_writer :channel_id
|
44
|
+
|
45
|
+
# Timestamp when the message was clicked.
|
46
|
+
sig { returns(T.nilable(Time)) }
|
47
|
+
attr_accessor :clicked_at
|
48
|
+
|
49
|
+
# Data associated with the message’s workflow run. Includes the workflow trigger
|
50
|
+
# request’s `data` payload merged with any additional data returned by a
|
51
|
+
# [fetch function](/designing-workflows/fetch-function). For messages produced
|
52
|
+
# after a [batch step](/designing-workflows/batch-function), includes the payload
|
53
|
+
# `data` from the most-recent trigger request (the final `activity` in the batch).
|
54
|
+
sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
55
|
+
attr_accessor :data
|
56
|
+
|
57
|
+
# A list of engagement statuses.
|
58
|
+
sig { returns(T.nilable(T::Array[Knockapi::Models::Message::EngagementStatus::TaggedSymbol])) }
|
59
|
+
attr_reader :engagement_statuses
|
60
|
+
|
61
|
+
sig { params(engagement_statuses: T::Array[Knockapi::Models::Message::EngagementStatus::OrSymbol]).void }
|
62
|
+
attr_writer :engagement_statuses
|
63
|
+
|
64
|
+
# Timestamp when the resource was created.
|
65
|
+
sig { returns(T.nilable(Time)) }
|
66
|
+
attr_reader :inserted_at
|
67
|
+
|
68
|
+
sig { params(inserted_at: Time).void }
|
69
|
+
attr_writer :inserted_at
|
70
|
+
|
71
|
+
# Timestamp when the message was interacted with.
|
72
|
+
sig { returns(T.nilable(Time)) }
|
73
|
+
attr_accessor :interacted_at
|
74
|
+
|
75
|
+
# Timestamp when a link in the message was clicked.
|
76
|
+
sig { returns(T.nilable(Time)) }
|
77
|
+
attr_accessor :link_clicked_at
|
78
|
+
|
79
|
+
# The metadata associated with the message.
|
80
|
+
sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
81
|
+
attr_accessor :metadata
|
82
|
+
|
83
|
+
# Timestamp when the message was read.
|
84
|
+
sig { returns(T.nilable(Time)) }
|
85
|
+
attr_accessor :read_at
|
86
|
+
|
87
|
+
# A reference to a recipient, either a user identifier (string) or an object
|
88
|
+
# reference (ID, collection).
|
89
|
+
sig { returns(T.nilable(T.any(String, Knockapi::Models::RecipientReference::ObjectReference))) }
|
90
|
+
attr_reader :recipient
|
91
|
+
|
92
|
+
sig do
|
93
|
+
params(
|
94
|
+
recipient: T.any(String, Knockapi::Models::RecipientReference::ObjectReference, Knockapi::Internal::AnyHash)
|
95
|
+
)
|
96
|
+
.void
|
97
|
+
end
|
98
|
+
attr_writer :recipient
|
99
|
+
|
100
|
+
# Timestamp when the message was scheduled to be sent.
|
101
|
+
sig { returns(T.nilable(Time)) }
|
102
|
+
attr_accessor :scheduled_at
|
103
|
+
|
104
|
+
# Timestamp when the message was seen.
|
105
|
+
sig { returns(T.nilable(Time)) }
|
106
|
+
attr_accessor :seen_at
|
107
|
+
|
108
|
+
# The workflow that triggered the message.
|
109
|
+
sig { returns(T.nilable(Knockapi::Models::Message::Source)) }
|
110
|
+
attr_reader :source
|
111
|
+
|
112
|
+
sig { params(source: T.any(Knockapi::Models::Message::Source, Knockapi::Internal::AnyHash)).void }
|
113
|
+
attr_writer :source
|
114
|
+
|
115
|
+
# The message delivery status.
|
116
|
+
sig { returns(T.nilable(Knockapi::Models::Message::Status::TaggedSymbol)) }
|
117
|
+
attr_reader :status
|
118
|
+
|
119
|
+
sig { params(status: Knockapi::Models::Message::Status::OrSymbol).void }
|
120
|
+
attr_writer :status
|
121
|
+
|
122
|
+
# The ID of the `tenant` associated with the message. Only present when a `tenant`
|
123
|
+
# is provided on a workflow trigger request.
|
124
|
+
sig { returns(T.nilable(String)) }
|
125
|
+
attr_accessor :tenant
|
126
|
+
|
127
|
+
# The timestamp when the resource was last updated.
|
128
|
+
sig { returns(T.nilable(Time)) }
|
129
|
+
attr_reader :updated_at
|
130
|
+
|
131
|
+
sig { params(updated_at: Time).void }
|
132
|
+
attr_writer :updated_at
|
133
|
+
|
134
|
+
# The key of the workflow that generated the message.
|
135
|
+
sig { returns(T.nilable(String)) }
|
136
|
+
attr_accessor :workflow
|
137
|
+
|
138
|
+
# Represents a single message that was generated by a workflow for a given
|
139
|
+
# channel.
|
140
|
+
sig do
|
141
|
+
params(
|
142
|
+
id: String,
|
143
|
+
_typename: String,
|
144
|
+
actors: T::Array[T.any(String, Knockapi::Models::RecipientReference::ObjectReference, Knockapi::Internal::AnyHash)],
|
145
|
+
archived_at: T.nilable(Time),
|
146
|
+
channel_id: String,
|
147
|
+
clicked_at: T.nilable(Time),
|
148
|
+
data: T.nilable(T::Hash[Symbol, T.anything]),
|
149
|
+
engagement_statuses: T::Array[Knockapi::Models::Message::EngagementStatus::OrSymbol],
|
150
|
+
inserted_at: Time,
|
151
|
+
interacted_at: T.nilable(Time),
|
152
|
+
link_clicked_at: T.nilable(Time),
|
153
|
+
metadata: T.nilable(T::Hash[Symbol, T.anything]),
|
154
|
+
read_at: T.nilable(Time),
|
155
|
+
recipient: T.any(String, Knockapi::Models::RecipientReference::ObjectReference, Knockapi::Internal::AnyHash),
|
156
|
+
scheduled_at: T.nilable(Time),
|
157
|
+
seen_at: T.nilable(Time),
|
158
|
+
source: T.any(Knockapi::Models::Message::Source, Knockapi::Internal::AnyHash),
|
159
|
+
status: Knockapi::Models::Message::Status::OrSymbol,
|
160
|
+
tenant: T.nilable(String),
|
161
|
+
updated_at: Time,
|
162
|
+
workflow: T.nilable(String)
|
163
|
+
)
|
164
|
+
.returns(T.attached_class)
|
165
|
+
end
|
166
|
+
def self.new(
|
167
|
+
# The unique identifier for the message.
|
168
|
+
id: nil,
|
169
|
+
# The typename of the schema.
|
170
|
+
_typename: nil,
|
171
|
+
# One or more actors that are associated with this message. Note: this is a list
|
172
|
+
# that can contain up to 10 actors if the message is produced from a
|
173
|
+
# [batch](/designing-workflows/batch-function).
|
174
|
+
actors: nil,
|
175
|
+
# Timestamp when the message was archived.
|
176
|
+
archived_at: nil,
|
177
|
+
# The ID for the channel the message was sent through.
|
178
|
+
channel_id: nil,
|
179
|
+
# Timestamp when the message was clicked.
|
180
|
+
clicked_at: nil,
|
181
|
+
# Data associated with the message’s workflow run. Includes the workflow trigger
|
182
|
+
# request’s `data` payload merged with any additional data returned by a
|
183
|
+
# [fetch function](/designing-workflows/fetch-function). For messages produced
|
184
|
+
# after a [batch step](/designing-workflows/batch-function), includes the payload
|
185
|
+
# `data` from the most-recent trigger request (the final `activity` in the batch).
|
186
|
+
data: nil,
|
187
|
+
# A list of engagement statuses.
|
188
|
+
engagement_statuses: nil,
|
189
|
+
# Timestamp when the resource was created.
|
190
|
+
inserted_at: nil,
|
191
|
+
# Timestamp when the message was interacted with.
|
192
|
+
interacted_at: nil,
|
193
|
+
# Timestamp when a link in the message was clicked.
|
194
|
+
link_clicked_at: nil,
|
195
|
+
# The metadata associated with the message.
|
196
|
+
metadata: nil,
|
197
|
+
# Timestamp when the message was read.
|
198
|
+
read_at: nil,
|
199
|
+
# A reference to a recipient, either a user identifier (string) or an object
|
200
|
+
# reference (ID, collection).
|
201
|
+
recipient: nil,
|
202
|
+
# Timestamp when the message was scheduled to be sent.
|
203
|
+
scheduled_at: nil,
|
204
|
+
# Timestamp when the message was seen.
|
205
|
+
seen_at: nil,
|
206
|
+
# The workflow that triggered the message.
|
207
|
+
source: nil,
|
208
|
+
# The message delivery status.
|
209
|
+
status: nil,
|
210
|
+
# The ID of the `tenant` associated with the message. Only present when a `tenant`
|
211
|
+
# is provided on a workflow trigger request.
|
212
|
+
tenant: nil,
|
213
|
+
# The timestamp when the resource was last updated.
|
214
|
+
updated_at: nil,
|
215
|
+
# The key of the workflow that generated the message.
|
216
|
+
workflow: nil
|
217
|
+
); end
|
218
|
+
sig do
|
219
|
+
override
|
220
|
+
.returns(
|
221
|
+
{
|
222
|
+
id: String,
|
223
|
+
_typename: String,
|
224
|
+
actors: T::Array[T.any(String, Knockapi::Models::RecipientReference::ObjectReference)],
|
225
|
+
archived_at: T.nilable(Time),
|
226
|
+
channel_id: String,
|
227
|
+
clicked_at: T.nilable(Time),
|
228
|
+
data: T.nilable(T::Hash[Symbol, T.anything]),
|
229
|
+
engagement_statuses: T::Array[Knockapi::Models::Message::EngagementStatus::TaggedSymbol],
|
230
|
+
inserted_at: Time,
|
231
|
+
interacted_at: T.nilable(Time),
|
232
|
+
link_clicked_at: T.nilable(Time),
|
233
|
+
metadata: T.nilable(T::Hash[Symbol, T.anything]),
|
234
|
+
read_at: T.nilable(Time),
|
235
|
+
recipient: T.any(String, Knockapi::Models::RecipientReference::ObjectReference),
|
236
|
+
scheduled_at: T.nilable(Time),
|
237
|
+
seen_at: T.nilable(Time),
|
238
|
+
source: Knockapi::Models::Message::Source,
|
239
|
+
status: Knockapi::Models::Message::Status::TaggedSymbol,
|
240
|
+
tenant: T.nilable(String),
|
241
|
+
updated_at: Time,
|
242
|
+
workflow: T.nilable(String)
|
243
|
+
}
|
244
|
+
)
|
245
|
+
end
|
246
|
+
def to_hash; end
|
247
|
+
|
248
|
+
# An engagement status for a message. Can be one of: read, seen, interacted,
|
249
|
+
# link_clicked, archived.
|
250
|
+
module EngagementStatus
|
251
|
+
extend Knockapi::Internal::Type::Enum
|
252
|
+
|
253
|
+
TaggedSymbol = T.type_alias { T.all(Symbol, Knockapi::Models::Message::EngagementStatus) }
|
254
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
255
|
+
|
256
|
+
SEEN = T.let(:seen, Knockapi::Models::Message::EngagementStatus::TaggedSymbol)
|
257
|
+
READ = T.let(:read, Knockapi::Models::Message::EngagementStatus::TaggedSymbol)
|
258
|
+
INTERACTED = T.let(:interacted, Knockapi::Models::Message::EngagementStatus::TaggedSymbol)
|
259
|
+
LINK_CLICKED = T.let(:link_clicked, Knockapi::Models::Message::EngagementStatus::TaggedSymbol)
|
260
|
+
ARCHIVED = T.let(:archived, Knockapi::Models::Message::EngagementStatus::TaggedSymbol)
|
261
|
+
|
262
|
+
sig { override.returns(T::Array[Knockapi::Models::Message::EngagementStatus::TaggedSymbol]) }
|
263
|
+
def self.values; end
|
264
|
+
end
|
265
|
+
|
266
|
+
class Source < Knockapi::Internal::Type::BaseModel
|
267
|
+
sig { returns(String) }
|
268
|
+
attr_accessor :_typename
|
269
|
+
|
270
|
+
# The categories associated with the message.
|
271
|
+
sig { returns(T::Array[String]) }
|
272
|
+
attr_accessor :categories
|
273
|
+
|
274
|
+
# The key of the workflow that triggered the message.
|
275
|
+
sig { returns(String) }
|
276
|
+
attr_accessor :key
|
277
|
+
|
278
|
+
# The ID of the version of the workflow that triggered the message.
|
279
|
+
sig { returns(String) }
|
280
|
+
attr_accessor :version_id
|
281
|
+
|
282
|
+
# The workflow that triggered the message.
|
283
|
+
sig do
|
284
|
+
params(_typename: String, categories: T::Array[String], key: String, version_id: String)
|
285
|
+
.returns(T.attached_class)
|
286
|
+
end
|
287
|
+
def self.new(
|
288
|
+
_typename:,
|
289
|
+
# The categories associated with the message.
|
290
|
+
categories:,
|
291
|
+
# The key of the workflow that triggered the message.
|
292
|
+
key:,
|
293
|
+
# The ID of the version of the workflow that triggered the message.
|
294
|
+
version_id:
|
295
|
+
); end
|
296
|
+
sig do
|
297
|
+
override.returns({_typename: String, categories: T::Array[String], key: String, version_id: String})
|
298
|
+
end
|
299
|
+
def to_hash; end
|
300
|
+
end
|
301
|
+
|
302
|
+
# The message delivery status.
|
303
|
+
module Status
|
304
|
+
extend Knockapi::Internal::Type::Enum
|
305
|
+
|
306
|
+
TaggedSymbol = T.type_alias { T.all(Symbol, Knockapi::Models::Message::Status) }
|
307
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
308
|
+
|
309
|
+
QUEUED = T.let(:queued, Knockapi::Models::Message::Status::TaggedSymbol)
|
310
|
+
SENT = T.let(:sent, Knockapi::Models::Message::Status::TaggedSymbol)
|
311
|
+
DELIVERED = T.let(:delivered, Knockapi::Models::Message::Status::TaggedSymbol)
|
312
|
+
DELIVERY_ATTEMPTED = T.let(:delivery_attempted, Knockapi::Models::Message::Status::TaggedSymbol)
|
313
|
+
UNDELIVERED = T.let(:undelivered, Knockapi::Models::Message::Status::TaggedSymbol)
|
314
|
+
NOT_SENT = T.let(:not_sent, Knockapi::Models::Message::Status::TaggedSymbol)
|
315
|
+
BOUNCED = T.let(:bounced, Knockapi::Models::Message::Status::TaggedSymbol)
|
316
|
+
|
317
|
+
sig { override.returns(T::Array[Knockapi::Models::Message::Status::TaggedSymbol]) }
|
318
|
+
def self.values; end
|
319
|
+
end
|
320
|
+
end
|
321
|
+
end
|
322
|
+
end
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# typed: strong
|
2
|
+
|
3
|
+
module Knockapi
|
4
|
+
module Models
|
5
|
+
class MessageArchiveParams < 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,260 @@
|
|
1
|
+
# typed: strong
|
2
|
+
|
3
|
+
module Knockapi
|
4
|
+
module Models
|
5
|
+
class MessageDeliveryLog < Knockapi::Internal::Type::BaseModel
|
6
|
+
# The unique identifier for the message delivery log.
|
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 ID of the environment in which the message delivery occurred.
|
15
|
+
sig { returns(String) }
|
16
|
+
attr_accessor :environment_id
|
17
|
+
|
18
|
+
# Timestamp when the message delivery log was created.
|
19
|
+
sig { returns(String) }
|
20
|
+
attr_accessor :inserted_at
|
21
|
+
|
22
|
+
# A message delivery log request.
|
23
|
+
sig { returns(Knockapi::Models::MessageDeliveryLog::Request) }
|
24
|
+
attr_reader :request
|
25
|
+
|
26
|
+
sig { params(request: T.any(Knockapi::Models::MessageDeliveryLog::Request, Knockapi::Internal::AnyHash)).void }
|
27
|
+
attr_writer :request
|
28
|
+
|
29
|
+
# A message delivery log response.
|
30
|
+
sig { returns(Knockapi::Models::MessageDeliveryLog::Response) }
|
31
|
+
attr_reader :response
|
32
|
+
|
33
|
+
sig { params(response: T.any(Knockapi::Models::MessageDeliveryLog::Response, Knockapi::Internal::AnyHash)).void }
|
34
|
+
attr_writer :response
|
35
|
+
|
36
|
+
# The name of the service that processed the delivery.
|
37
|
+
sig { returns(String) }
|
38
|
+
attr_accessor :service_name
|
39
|
+
|
40
|
+
# A message delivery log contains a `request` from Knock to a downstream provider
|
41
|
+
# and the `response` that was returned.
|
42
|
+
sig do
|
43
|
+
params(
|
44
|
+
id: String,
|
45
|
+
_typename: String,
|
46
|
+
environment_id: String,
|
47
|
+
inserted_at: String,
|
48
|
+
request: T.any(Knockapi::Models::MessageDeliveryLog::Request, Knockapi::Internal::AnyHash),
|
49
|
+
response: T.any(Knockapi::Models::MessageDeliveryLog::Response, Knockapi::Internal::AnyHash),
|
50
|
+
service_name: String
|
51
|
+
)
|
52
|
+
.returns(T.attached_class)
|
53
|
+
end
|
54
|
+
def self.new(
|
55
|
+
# The unique identifier for the message delivery log.
|
56
|
+
id:,
|
57
|
+
# The typename of the schema.
|
58
|
+
_typename:,
|
59
|
+
# The ID of the environment in which the message delivery occurred.
|
60
|
+
environment_id:,
|
61
|
+
# Timestamp when the message delivery log was created.
|
62
|
+
inserted_at:,
|
63
|
+
# A message delivery log request.
|
64
|
+
request:,
|
65
|
+
# A message delivery log response.
|
66
|
+
response:,
|
67
|
+
# The name of the service that processed the delivery.
|
68
|
+
service_name:
|
69
|
+
); end
|
70
|
+
sig do
|
71
|
+
override
|
72
|
+
.returns(
|
73
|
+
{
|
74
|
+
id: String,
|
75
|
+
_typename: String,
|
76
|
+
environment_id: String,
|
77
|
+
inserted_at: String,
|
78
|
+
request: Knockapi::Models::MessageDeliveryLog::Request,
|
79
|
+
response: Knockapi::Models::MessageDeliveryLog::Response,
|
80
|
+
service_name: String
|
81
|
+
}
|
82
|
+
)
|
83
|
+
end
|
84
|
+
def to_hash; end
|
85
|
+
|
86
|
+
class Request < Knockapi::Internal::Type::BaseModel
|
87
|
+
# The body content that was sent with the request.
|
88
|
+
sig { returns(T.nilable(T.any(String, T::Hash[Symbol, T.anything]))) }
|
89
|
+
attr_reader :body
|
90
|
+
|
91
|
+
sig { params(body: T.any(String, T::Hash[Symbol, T.anything])).void }
|
92
|
+
attr_writer :body
|
93
|
+
|
94
|
+
# The headers that were sent with the request.
|
95
|
+
sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
96
|
+
attr_accessor :headers
|
97
|
+
|
98
|
+
# The host to which the request was sent.
|
99
|
+
sig { returns(T.nilable(String)) }
|
100
|
+
attr_reader :host
|
101
|
+
|
102
|
+
sig { params(host: String).void }
|
103
|
+
attr_writer :host
|
104
|
+
|
105
|
+
# The HTTP method used for the request.
|
106
|
+
sig { returns(T.nilable(Knockapi::Models::MessageDeliveryLog::Request::Method::TaggedSymbol)) }
|
107
|
+
attr_reader :method_
|
108
|
+
|
109
|
+
sig { params(method_: Knockapi::Models::MessageDeliveryLog::Request::Method::OrSymbol).void }
|
110
|
+
attr_writer :method_
|
111
|
+
|
112
|
+
# The path of the URL that was requested.
|
113
|
+
sig { returns(T.nilable(String)) }
|
114
|
+
attr_reader :path
|
115
|
+
|
116
|
+
sig { params(path: String).void }
|
117
|
+
attr_writer :path
|
118
|
+
|
119
|
+
# The query string of the URL that was requested.
|
120
|
+
sig { returns(T.nilable(String)) }
|
121
|
+
attr_accessor :query
|
122
|
+
|
123
|
+
# A message delivery log request.
|
124
|
+
sig do
|
125
|
+
params(
|
126
|
+
body: T.any(String, T::Hash[Symbol, T.anything]),
|
127
|
+
headers: T.nilable(T::Hash[Symbol, T.anything]),
|
128
|
+
host: String,
|
129
|
+
method_: Knockapi::Models::MessageDeliveryLog::Request::Method::OrSymbol,
|
130
|
+
path: String,
|
131
|
+
query: T.nilable(String)
|
132
|
+
)
|
133
|
+
.returns(T.attached_class)
|
134
|
+
end
|
135
|
+
def self.new(
|
136
|
+
# The body content that was sent with the request.
|
137
|
+
body: nil,
|
138
|
+
# The headers that were sent with the request.
|
139
|
+
headers: nil,
|
140
|
+
# The host to which the request was sent.
|
141
|
+
host: nil,
|
142
|
+
# The HTTP method used for the request.
|
143
|
+
method_: nil,
|
144
|
+
# The path of the URL that was requested.
|
145
|
+
path: nil,
|
146
|
+
# The query string of the URL that was requested.
|
147
|
+
query: nil
|
148
|
+
); end
|
149
|
+
sig do
|
150
|
+
override
|
151
|
+
.returns(
|
152
|
+
{
|
153
|
+
body: T.any(String, T::Hash[Symbol, T.anything]),
|
154
|
+
headers: T.nilable(T::Hash[Symbol, T.anything]),
|
155
|
+
host: String,
|
156
|
+
method_: Knockapi::Models::MessageDeliveryLog::Request::Method::TaggedSymbol,
|
157
|
+
path: String,
|
158
|
+
query: T.nilable(String)
|
159
|
+
}
|
160
|
+
)
|
161
|
+
end
|
162
|
+
def to_hash; end
|
163
|
+
|
164
|
+
# The body content that was sent with the request.
|
165
|
+
module Body
|
166
|
+
extend Knockapi::Internal::Type::Union
|
167
|
+
|
168
|
+
sig { override.returns([String, T::Hash[Symbol, T.anything]]) }
|
169
|
+
def self.variants; end
|
170
|
+
|
171
|
+
UnionMember1Map =
|
172
|
+
T.let(
|
173
|
+
Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown],
|
174
|
+
Knockapi::Internal::Type::Converter
|
175
|
+
)
|
176
|
+
end
|
177
|
+
|
178
|
+
# The HTTP method used for the request.
|
179
|
+
module Method
|
180
|
+
extend Knockapi::Internal::Type::Enum
|
181
|
+
|
182
|
+
TaggedSymbol = T.type_alias { T.all(Symbol, Knockapi::Models::MessageDeliveryLog::Request::Method) }
|
183
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
184
|
+
|
185
|
+
GET = T.let(:GET, Knockapi::Models::MessageDeliveryLog::Request::Method::TaggedSymbol)
|
186
|
+
POST = T.let(:POST, Knockapi::Models::MessageDeliveryLog::Request::Method::TaggedSymbol)
|
187
|
+
PUT = T.let(:PUT, Knockapi::Models::MessageDeliveryLog::Request::Method::TaggedSymbol)
|
188
|
+
DELETE = T.let(:DELETE, Knockapi::Models::MessageDeliveryLog::Request::Method::TaggedSymbol)
|
189
|
+
PATCH = T.let(:PATCH, Knockapi::Models::MessageDeliveryLog::Request::Method::TaggedSymbol)
|
190
|
+
|
191
|
+
sig { override.returns(T::Array[Knockapi::Models::MessageDeliveryLog::Request::Method::TaggedSymbol]) }
|
192
|
+
def self.values; end
|
193
|
+
end
|
194
|
+
end
|
195
|
+
|
196
|
+
class Response < Knockapi::Internal::Type::BaseModel
|
197
|
+
# The body content that was received with the response.
|
198
|
+
sig { returns(T.nilable(T.any(String, T::Hash[Symbol, T.anything]))) }
|
199
|
+
attr_reader :body
|
200
|
+
|
201
|
+
sig { params(body: T.any(String, T::Hash[Symbol, T.anything])).void }
|
202
|
+
attr_writer :body
|
203
|
+
|
204
|
+
# The headers that were received with the response.
|
205
|
+
sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
206
|
+
attr_accessor :headers
|
207
|
+
|
208
|
+
# The HTTP status code of the response.
|
209
|
+
sig { returns(T.nilable(Integer)) }
|
210
|
+
attr_reader :status
|
211
|
+
|
212
|
+
sig { params(status: Integer).void }
|
213
|
+
attr_writer :status
|
214
|
+
|
215
|
+
# A message delivery log response.
|
216
|
+
sig do
|
217
|
+
params(
|
218
|
+
body: T.any(String, T::Hash[Symbol, T.anything]),
|
219
|
+
headers: T.nilable(T::Hash[Symbol, T.anything]),
|
220
|
+
status: Integer
|
221
|
+
)
|
222
|
+
.returns(T.attached_class)
|
223
|
+
end
|
224
|
+
def self.new(
|
225
|
+
# The body content that was received with the response.
|
226
|
+
body: nil,
|
227
|
+
# The headers that were received with the response.
|
228
|
+
headers: nil,
|
229
|
+
# The HTTP status code of the response.
|
230
|
+
status: nil
|
231
|
+
); end
|
232
|
+
sig do
|
233
|
+
override
|
234
|
+
.returns(
|
235
|
+
{
|
236
|
+
body: T.any(String, T::Hash[Symbol, T.anything]),
|
237
|
+
headers: T.nilable(T::Hash[Symbol, T.anything]),
|
238
|
+
status: Integer
|
239
|
+
}
|
240
|
+
)
|
241
|
+
end
|
242
|
+
def to_hash; end
|
243
|
+
|
244
|
+
# The body content that was received with the response.
|
245
|
+
module Body
|
246
|
+
extend Knockapi::Internal::Type::Union
|
247
|
+
|
248
|
+
sig { override.returns([String, T::Hash[Symbol, T.anything]]) }
|
249
|
+
def self.variants; end
|
250
|
+
|
251
|
+
UnionMember1Map =
|
252
|
+
T.let(
|
253
|
+
Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown],
|
254
|
+
Knockapi::Internal::Type::Converter
|
255
|
+
)
|
256
|
+
end
|
257
|
+
end
|
258
|
+
end
|
259
|
+
end
|
260
|
+
end
|
@@ -0,0 +1,103 @@
|
|
1
|
+
# typed: strong
|
2
|
+
|
3
|
+
module Knockapi
|
4
|
+
module Models
|
5
|
+
class MessageEvent < Knockapi::Internal::Type::BaseModel
|
6
|
+
# The unique identifier for the message event.
|
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
|
+
# Timestamp when the event was created.
|
15
|
+
sig { returns(Time) }
|
16
|
+
attr_accessor :inserted_at
|
17
|
+
|
18
|
+
# A reference to a recipient, either a user identifier (string) or an object
|
19
|
+
# reference (ID, collection).
|
20
|
+
sig { returns(T.any(String, Knockapi::Models::RecipientReference::ObjectReference)) }
|
21
|
+
attr_accessor :recipient
|
22
|
+
|
23
|
+
# The type of event that occurred.
|
24
|
+
sig { returns(Knockapi::Models::MessageEvent::Type::TaggedSymbol) }
|
25
|
+
attr_accessor :type
|
26
|
+
|
27
|
+
# The data associated with the message event. Only present for some event types.
|
28
|
+
sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
29
|
+
attr_accessor :data
|
30
|
+
|
31
|
+
# A message event. Occurs when a message
|
32
|
+
# [delivery or engagement status](/send-notifications/message-statuses) changes.
|
33
|
+
sig do
|
34
|
+
params(
|
35
|
+
id: String,
|
36
|
+
_typename: String,
|
37
|
+
inserted_at: Time,
|
38
|
+
recipient: T.any(String, Knockapi::Models::RecipientReference::ObjectReference, Knockapi::Internal::AnyHash),
|
39
|
+
type: Knockapi::Models::MessageEvent::Type::OrSymbol,
|
40
|
+
data: T.nilable(T::Hash[Symbol, T.anything])
|
41
|
+
)
|
42
|
+
.returns(T.attached_class)
|
43
|
+
end
|
44
|
+
def self.new(
|
45
|
+
# The unique identifier for the message event.
|
46
|
+
id:,
|
47
|
+
# The typename of the schema.
|
48
|
+
_typename:,
|
49
|
+
# Timestamp when the event was created.
|
50
|
+
inserted_at:,
|
51
|
+
# A reference to a recipient, either a user identifier (string) or an object
|
52
|
+
# reference (ID, collection).
|
53
|
+
recipient:,
|
54
|
+
# The type of event that occurred.
|
55
|
+
type:,
|
56
|
+
# The data associated with the message event. Only present for some event types.
|
57
|
+
data: nil
|
58
|
+
); end
|
59
|
+
sig do
|
60
|
+
override
|
61
|
+
.returns(
|
62
|
+
{
|
63
|
+
id: String,
|
64
|
+
_typename: String,
|
65
|
+
inserted_at: Time,
|
66
|
+
recipient: T.any(String, Knockapi::Models::RecipientReference::ObjectReference),
|
67
|
+
type: Knockapi::Models::MessageEvent::Type::TaggedSymbol,
|
68
|
+
data: T.nilable(T::Hash[Symbol, T.anything])
|
69
|
+
}
|
70
|
+
)
|
71
|
+
end
|
72
|
+
def to_hash; end
|
73
|
+
|
74
|
+
# The type of event that occurred.
|
75
|
+
module Type
|
76
|
+
extend Knockapi::Internal::Type::Enum
|
77
|
+
|
78
|
+
TaggedSymbol = T.type_alias { T.all(Symbol, Knockapi::Models::MessageEvent::Type) }
|
79
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
80
|
+
|
81
|
+
MESSAGE_ARCHIVED = T.let(:"message.archived", Knockapi::Models::MessageEvent::Type::TaggedSymbol)
|
82
|
+
MESSAGE_BOUNCED = T.let(:"message.bounced", Knockapi::Models::MessageEvent::Type::TaggedSymbol)
|
83
|
+
MESSAGE_DELIVERED = T.let(:"message.delivered", Knockapi::Models::MessageEvent::Type::TaggedSymbol)
|
84
|
+
MESSAGE_DELIVERY_ATTEMPTED =
|
85
|
+
T.let(:"message.delivery_attempted", Knockapi::Models::MessageEvent::Type::TaggedSymbol)
|
86
|
+
MESSAGE_INTERACTED = T.let(:"message.interacted", Knockapi::Models::MessageEvent::Type::TaggedSymbol)
|
87
|
+
MESSAGE_LINK_CLICKED = T.let(:"message.link_clicked", Knockapi::Models::MessageEvent::Type::TaggedSymbol)
|
88
|
+
MESSAGE_NOT_SENT = T.let(:"message.not_sent", Knockapi::Models::MessageEvent::Type::TaggedSymbol)
|
89
|
+
MESSAGE_QUEUED = T.let(:"message.queued", Knockapi::Models::MessageEvent::Type::TaggedSymbol)
|
90
|
+
MESSAGE_READ = T.let(:"message.read", Knockapi::Models::MessageEvent::Type::TaggedSymbol)
|
91
|
+
MESSAGE_SEEN = T.let(:"message.seen", Knockapi::Models::MessageEvent::Type::TaggedSymbol)
|
92
|
+
MESSAGE_SENT = T.let(:"message.sent", Knockapi::Models::MessageEvent::Type::TaggedSymbol)
|
93
|
+
MESSAGE_UNARCHIVED = T.let(:"message.unarchived", Knockapi::Models::MessageEvent::Type::TaggedSymbol)
|
94
|
+
MESSAGE_UNDELIVERED = T.let(:"message.undelivered", Knockapi::Models::MessageEvent::Type::TaggedSymbol)
|
95
|
+
MESSAGE_UNREAD = T.let(:"message.unread", Knockapi::Models::MessageEvent::Type::TaggedSymbol)
|
96
|
+
MESSAGE_UNSEEN = T.let(:"message.unseen", Knockapi::Models::MessageEvent::Type::TaggedSymbol)
|
97
|
+
|
98
|
+
sig { override.returns(T::Array[Knockapi::Models::MessageEvent::Type::TaggedSymbol]) }
|
99
|
+
def self.values; end
|
100
|
+
end
|
101
|
+
end
|
102
|
+
end
|
103
|
+
end
|