knockapi 0.6.1 → 1.1.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 +61 -0
- data/README.md +204 -89
- 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 +555 -0
- data/lib/knockapi/internal/transport/pooled_net_requester.rb +209 -0
- data/lib/knockapi/internal/type/array_of.rb +154 -0
- data/lib/knockapi/internal/type/base_model.rb +477 -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 +292 -0
- data/lib/knockapi/internal/type/enum.rb +108 -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 +42 -0
- data/lib/knockapi/internal/type/union.rb +226 -0
- data/lib/knockapi/internal/type/unknown.rb +67 -0
- data/lib/knockapi/internal/util.rb +862 -0
- data/lib/knockapi/internal.rb +17 -0
- data/lib/knockapi/models/activity.rb +70 -0
- data/lib/knockapi/models/audience_add_members_params.rb +57 -0
- data/lib/knockapi/models/audience_add_members_response.rb +7 -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 +55 -0
- data/lib/knockapi/models/audience_remove_members_params.rb +60 -0
- data/lib/knockapi/models/audience_remove_members_response.rb +7 -0
- data/lib/knockapi/models/bulk_operation.rb +165 -0
- data/lib/knockapi/models/bulk_operation_get_params.rb +14 -0
- data/lib/knockapi/models/channels/bulk_update_message_status_params.rb +168 -0
- data/lib/knockapi/models/condition.rb +63 -0
- data/lib/knockapi/models/identify_user_request.rb +97 -0
- data/lib/knockapi/models/inline_identify_user_request.rb +106 -0
- data/lib/knockapi/models/inline_object_request.rb +56 -0
- data/lib/knockapi/models/inline_tenant_request.rb +23 -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 +264 -0
- data/lib/knockapi/models/message_archive_params.rb +14 -0
- data/lib/knockapi/models/message_delivery_log.rb +210 -0
- data/lib/knockapi/models/message_event.rb +90 -0
- data/lib/knockapi/models/message_get_content_params.rb +14 -0
- data/lib/knockapi/models/message_get_content_response.rb +517 -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 +196 -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/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 +525 -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 +59 -0
- data/lib/knockapi/models/object_add_subscriptions_params.rb +34 -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_response.rb +7 -0
- data/lib/knockapi/models/object_delete_subscriptions_params.rb +26 -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 +199 -0
- data/lib/knockapi/models/object_list_params.rb +55 -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 +59 -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/object_unset_channel_data_response.rb +7 -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 +63 -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 +73 -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 +80 -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 +23 -0
- data/lib/knockapi/models/recipient_reference.rb +45 -0
- data/lib/knockapi/models/recipient_request.rb +28 -0
- data/lib/knockapi/models/recipients/channel_data.rb +100 -0
- data/lib/knockapi/models/recipients/channel_data_request.rb +57 -0
- data/lib/knockapi/models/recipients/discord_channel_data.rb +92 -0
- data/lib/knockapi/models/recipients/inline_channel_data_request.rb +46 -0
- data/lib/knockapi/models/recipients/inline_preference_set_request.rb +11 -0
- data/lib/knockapi/models/recipients/ms_teams_channel_data.rb +123 -0
- data/lib/knockapi/models/recipients/one_signal_channel_data.rb +20 -0
- data/lib/knockapi/models/recipients/preference_set.rb +150 -0
- data/lib/knockapi/models/recipients/preference_set_channel_type_setting.rb +21 -0
- data/lib/knockapi/models/recipients/preference_set_channel_types.rb +174 -0
- data/lib/knockapi/models/recipients/preference_set_request.rb +141 -0
- data/lib/knockapi/models/recipients/push_channel_data.rb +20 -0
- data/lib/knockapi/models/recipients/slack_channel_data.rb +110 -0
- data/lib/knockapi/models/recipients/subscription.rb +60 -0
- data/lib/knockapi/models/schedule.rb +112 -0
- data/lib/knockapi/models/schedule_create_params.rb +70 -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 +74 -0
- data/lib/knockapi/models/schedule_update_response.rb +8 -0
- data/lib/knockapi/models/schedules/bulk_create_params.rb +101 -0
- data/lib/knockapi/models/tenant.rb +112 -0
- data/lib/knockapi/models/tenant_delete_params.rb +14 -0
- data/lib/knockapi/models/tenant_delete_response.rb +7 -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 +92 -0
- data/lib/knockapi/models/user_delete_params.rb +14 -0
- data/lib/knockapi/models/user_delete_response.rb +7 -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 +201 -0
- data/lib/knockapi/models/user_list_params.rb +55 -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_unset_channel_data_response.rb +7 -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 +342 -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 +40 -0
- data/lib/knockapi/models/workflow_cancel_response.rb +7 -0
- data/lib/knockapi/models/workflow_trigger_params.rb +64 -0
- data/lib/knockapi/models/workflow_trigger_response.rb +23 -0
- data/lib/knockapi/models.rb +202 -0
- data/lib/knockapi/request_options.rb +77 -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 +66 -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/batch.rb +208 -0
- data/lib/knockapi/resources/messages.rb +358 -0
- data/lib/knockapi/resources/objects/bulk.rb +92 -0
- data/lib/knockapi/resources/objects.rb +498 -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 +154 -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 +440 -0
- data/lib/knockapi/resources/workflows.rb +84 -0
- data/lib/knockapi/version.rb +5 -0
- data/lib/knockapi.rb +248 -0
- data/manifest.yaml +15 -0
- data/rbi/knockapi/client.rbi +85 -0
- data/rbi/knockapi/errors.rbi +162 -0
- data/rbi/knockapi/file_part.rbi +37 -0
- data/rbi/knockapi/internal/entries_cursor.rbi +40 -0
- data/rbi/knockapi/internal/items_cursor.rbi +40 -0
- data/rbi/knockapi/internal/ms_teams_pagination.rbi +22 -0
- data/rbi/knockapi/internal/slack_channels_cursor.rbi +22 -0
- data/rbi/knockapi/internal/transport/base_client.rbi +293 -0
- data/rbi/knockapi/internal/transport/pooled_net_requester.rbi +79 -0
- data/rbi/knockapi/internal/type/array_of.rbi +98 -0
- data/rbi/knockapi/internal/type/base_model.rbi +297 -0
- data/rbi/knockapi/internal/type/base_page.rbi +42 -0
- data/rbi/knockapi/internal/type/boolean.rbi +50 -0
- data/rbi/knockapi/internal/type/converter.rbi +162 -0
- data/rbi/knockapi/internal/type/enum.rbi +77 -0
- data/rbi/knockapi/internal/type/file_input.rbi +54 -0
- data/rbi/knockapi/internal/type/hash_of.rbi +98 -0
- data/rbi/knockapi/internal/type/request_parameters.rbi +29 -0
- data/rbi/knockapi/internal/type/union.rbi +111 -0
- data/rbi/knockapi/internal/type/unknown.rbi +50 -0
- data/rbi/knockapi/internal/util.rbi +451 -0
- data/rbi/knockapi/internal.rbi +13 -0
- data/rbi/knockapi/models/activity.rbi +107 -0
- data/rbi/knockapi/models/audience_add_members_params.rbi +123 -0
- data/rbi/knockapi/models/audience_add_members_response.rbi +7 -0
- data/rbi/knockapi/models/audience_list_members_params.rbi +30 -0
- data/rbi/knockapi/models/audience_list_members_response.rbi +52 -0
- data/rbi/knockapi/models/audience_member.rbi +77 -0
- data/rbi/knockapi/models/audience_remove_members_params.rbi +127 -0
- data/rbi/knockapi/models/audience_remove_members_response.rbi +7 -0
- data/rbi/knockapi/models/bulk_operation.rbi +222 -0
- data/rbi/knockapi/models/bulk_operation_get_params.rbi +27 -0
- data/rbi/knockapi/models/channels/bulk_update_message_status_params.rbi +432 -0
- data/rbi/knockapi/models/condition.rbi +124 -0
- data/rbi/knockapi/models/identify_user_request.rbi +164 -0
- data/rbi/knockapi/models/inline_identify_user_request.rbi +176 -0
- data/rbi/knockapi/models/inline_object_request.rbi +122 -0
- data/rbi/knockapi/models/inline_tenant_request.rbi +18 -0
- data/rbi/knockapi/models/integrations/census_custom_destination_params.rbi +75 -0
- data/rbi/knockapi/models/integrations/census_custom_destination_response.rbi +50 -0
- data/rbi/knockapi/models/integrations/hightouch_embedded_destination_params.rbi +75 -0
- data/rbi/knockapi/models/integrations/hightouch_embedded_destination_response.rbi +50 -0
- data/rbi/knockapi/models/message.rbi +406 -0
- data/rbi/knockapi/models/message_archive_params.rbi +27 -0
- data/rbi/knockapi/models/message_delivery_log.rbi +347 -0
- data/rbi/knockapi/models/message_event.rbi +152 -0
- data/rbi/knockapi/models/message_get_content_params.rbi +27 -0
- data/rbi/knockapi/models/message_get_content_response.rbi +899 -0
- data/rbi/knockapi/models/message_get_params.rbi +27 -0
- data/rbi/knockapi/models/message_list_activities_params.rbi +82 -0
- data/rbi/knockapi/models/message_list_delivery_logs_params.rbi +71 -0
- data/rbi/knockapi/models/message_list_events_params.rbi +68 -0
- data/rbi/knockapi/models/message_list_params.rbi +360 -0
- data/rbi/knockapi/models/message_mark_as_interacted_params.rbi +49 -0
- data/rbi/knockapi/models/message_mark_as_read_params.rbi +27 -0
- data/rbi/knockapi/models/message_mark_as_seen_params.rbi +27 -0
- data/rbi/knockapi/models/message_mark_as_unread_params.rbi +30 -0
- data/rbi/knockapi/models/message_mark_as_unseen_params.rbi +30 -0
- data/rbi/knockapi/models/message_unarchive_params.rbi +27 -0
- data/rbi/knockapi/models/messages/batch_archive_params.rbi +48 -0
- data/rbi/knockapi/models/messages/batch_archive_response.rbi +13 -0
- data/rbi/knockapi/models/messages/batch_get_content_params.rbi +48 -0
- data/rbi/knockapi/models/messages/batch_get_content_response.rbi +909 -0
- data/rbi/knockapi/models/messages/batch_mark_as_interacted_params.rbi +56 -0
- data/rbi/knockapi/models/messages/batch_mark_as_interacted_response.rbi +13 -0
- data/rbi/knockapi/models/messages/batch_mark_as_read_params.rbi +48 -0
- data/rbi/knockapi/models/messages/batch_mark_as_read_response.rbi +13 -0
- data/rbi/knockapi/models/messages/batch_mark_as_seen_params.rbi +48 -0
- data/rbi/knockapi/models/messages/batch_mark_as_seen_response.rbi +13 -0
- data/rbi/knockapi/models/messages/batch_mark_as_unread_params.rbi +48 -0
- data/rbi/knockapi/models/messages/batch_mark_as_unread_response.rbi +13 -0
- data/rbi/knockapi/models/messages/batch_mark_as_unseen_params.rbi +48 -0
- data/rbi/knockapi/models/messages/batch_mark_as_unseen_response.rbi +13 -0
- data/rbi/knockapi/models/messages/batch_unarchive_params.rbi +48 -0
- data/rbi/knockapi/models/messages/batch_unarchive_response.rbi +13 -0
- data/rbi/knockapi/models/object.rbi +79 -0
- data/rbi/knockapi/models/object_add_subscriptions_params.rbi +80 -0
- data/rbi/knockapi/models/object_add_subscriptions_response.rbi +11 -0
- data/rbi/knockapi/models/object_delete_params.rbi +27 -0
- data/rbi/knockapi/models/object_delete_response.rbi +7 -0
- data/rbi/knockapi/models/object_delete_subscriptions_params.rbi +61 -0
- data/rbi/knockapi/models/object_delete_subscriptions_response.rbi +11 -0
- data/rbi/knockapi/models/object_get_channel_data_params.rbi +30 -0
- data/rbi/knockapi/models/object_get_params.rbi +27 -0
- data/rbi/knockapi/models/object_get_preferences_params.rbi +30 -0
- data/rbi/knockapi/models/object_list_messages_params.rbi +390 -0
- data/rbi/knockapi/models/object_list_params.rbi +106 -0
- data/rbi/knockapi/models/object_list_preferences_params.rbi +30 -0
- data/rbi/knockapi/models/object_list_preferences_response.rbi +11 -0
- data/rbi/knockapi/models/object_list_schedules_params.rbi +93 -0
- data/rbi/knockapi/models/object_list_subscriptions_params.rbi +279 -0
- data/rbi/knockapi/models/object_set_channel_data_params.rbi +30 -0
- data/rbi/knockapi/models/object_set_params.rbi +141 -0
- data/rbi/knockapi/models/object_set_preferences_params.rbi +30 -0
- data/rbi/knockapi/models/object_unset_channel_data_params.rbi +30 -0
- data/rbi/knockapi/models/object_unset_channel_data_response.rbi +7 -0
- data/rbi/knockapi/models/objects/bulk_add_subscriptions_params.rbi +129 -0
- data/rbi/knockapi/models/objects/bulk_delete_params.rbi +48 -0
- data/rbi/knockapi/models/objects/bulk_set_params.rbi +45 -0
- data/rbi/knockapi/models/page_info.rbi +60 -0
- data/rbi/knockapi/models/providers/ms_team_check_auth_params.rbi +48 -0
- data/rbi/knockapi/models/providers/ms_team_check_auth_response.rbi +95 -0
- data/rbi/knockapi/models/providers/ms_team_list_channels_params.rbi +121 -0
- data/rbi/knockapi/models/providers/ms_team_list_channels_response.rbi +140 -0
- data/rbi/knockapi/models/providers/ms_team_list_teams_params.rbi +147 -0
- data/rbi/knockapi/models/providers/ms_team_list_teams_response.rbi +54 -0
- data/rbi/knockapi/models/providers/ms_team_revoke_access_params.rbi +48 -0
- data/rbi/knockapi/models/providers/ms_team_revoke_access_response.rbi +36 -0
- data/rbi/knockapi/models/providers/slack_check_auth_params.rbi +48 -0
- data/rbi/knockapi/models/providers/slack_check_auth_response.rbi +95 -0
- data/rbi/knockapi/models/providers/slack_list_channels_params.rbi +158 -0
- data/rbi/knockapi/models/providers/slack_list_channels_response.rbi +75 -0
- data/rbi/knockapi/models/providers/slack_revoke_access_params.rbi +48 -0
- data/rbi/knockapi/models/providers/slack_revoke_access_response.rbi +36 -0
- data/rbi/knockapi/models/recipient.rbi +16 -0
- data/rbi/knockapi/models/recipient_reference.rbi +58 -0
- data/rbi/knockapi/models/recipient_request.rbi +25 -0
- data/rbi/knockapi/models/recipients/channel_data.rbi +198 -0
- data/rbi/knockapi/models/recipients/channel_data_request.rbi +91 -0
- data/rbi/knockapi/models/recipients/discord_channel_data.rbi +190 -0
- data/rbi/knockapi/models/recipients/inline_channel_data_request.rbi +41 -0
- data/rbi/knockapi/models/recipients/inline_preference_set_request.rbi +15 -0
- data/rbi/knockapi/models/recipients/ms_teams_channel_data.rbi +231 -0
- data/rbi/knockapi/models/recipients/one_signal_channel_data.rbi +33 -0
- data/rbi/knockapi/models/recipients/preference_set.rbi +314 -0
- data/rbi/knockapi/models/recipients/preference_set_channel_type_setting.rbi +38 -0
- data/rbi/knockapi/models/recipients/preference_set_channel_types.rbi +389 -0
- data/rbi/knockapi/models/recipients/preference_set_request.rbi +309 -0
- data/rbi/knockapi/models/recipients/push_channel_data.rbi +33 -0
- data/rbi/knockapi/models/recipients/slack_channel_data.rbi +212 -0
- data/rbi/knockapi/models/recipients/subscription.rbi +86 -0
- data/rbi/knockapi/models/schedule.rbi +132 -0
- data/rbi/knockapi/models/schedule_create_params.rbi +115 -0
- data/rbi/knockapi/models/schedule_create_response.rbi +11 -0
- data/rbi/knockapi/models/schedule_delete_params.rbi +43 -0
- data/rbi/knockapi/models/schedule_delete_response.rbi +11 -0
- data/rbi/knockapi/models/schedule_list_params.rbi +98 -0
- data/rbi/knockapi/models/schedule_repeat_rule.rbi +148 -0
- data/rbi/knockapi/models/schedule_update_params.rbi +113 -0
- data/rbi/knockapi/models/schedule_update_response.rbi +11 -0
- data/rbi/knockapi/models/schedules/bulk_create_params.rbi +213 -0
- data/rbi/knockapi/models/tenant.rbi +188 -0
- data/rbi/knockapi/models/tenant_delete_params.rbi +27 -0
- data/rbi/knockapi/models/tenant_delete_response.rbi +7 -0
- data/rbi/knockapi/models/tenant_get_params.rbi +27 -0
- data/rbi/knockapi/models/tenant_list_params.rbi +90 -0
- data/rbi/knockapi/models/tenant_request.rbi +243 -0
- data/rbi/knockapi/models/tenant_set_params.rbi +241 -0
- data/rbi/knockapi/models/tenants/bulk_delete_params.rbi +48 -0
- data/rbi/knockapi/models/tenants/bulk_set_params.rbi +45 -0
- data/rbi/knockapi/models/user.rbi +110 -0
- data/rbi/knockapi/models/user_delete_params.rbi +27 -0
- data/rbi/knockapi/models/user_delete_response.rbi +7 -0
- data/rbi/knockapi/models/user_get_channel_data_params.rbi +27 -0
- data/rbi/knockapi/models/user_get_params.rbi +27 -0
- data/rbi/knockapi/models/user_get_preferences_params.rbi +43 -0
- data/rbi/knockapi/models/user_list_messages_params.rbi +386 -0
- data/rbi/knockapi/models/user_list_params.rbi +106 -0
- data/rbi/knockapi/models/user_list_preferences_params.rbi +30 -0
- data/rbi/knockapi/models/user_list_preferences_response.rbi +11 -0
- data/rbi/knockapi/models/user_list_schedules_params.rbi +90 -0
- data/rbi/knockapi/models/user_list_subscriptions_params.rbi +134 -0
- data/rbi/knockapi/models/user_merge_params.rbi +40 -0
- data/rbi/knockapi/models/user_set_channel_data_params.rbi +27 -0
- data/rbi/knockapi/models/user_set_preferences_params.rbi +27 -0
- data/rbi/knockapi/models/user_unset_channel_data_params.rbi +30 -0
- data/rbi/knockapi/models/user_unset_channel_data_response.rbi +7 -0
- data/rbi/knockapi/models/user_update_params.rbi +27 -0
- data/rbi/knockapi/models/users/bulk_delete_params.rbi +48 -0
- data/rbi/knockapi/models/users/bulk_identify_params.rbi +48 -0
- data/rbi/knockapi/models/users/bulk_set_preferences_params.rbi +63 -0
- data/rbi/knockapi/models/users/feed_get_settings_params.rbi +32 -0
- data/rbi/knockapi/models/users/feed_get_settings_response.rbi +83 -0
- data/rbi/knockapi/models/users/feed_list_items_params.rbi +251 -0
- data/rbi/knockapi/models/users/feed_list_items_response.rbi +540 -0
- data/rbi/knockapi/models/users/guide_get_channel_params.rbi +73 -0
- data/rbi/knockapi/models/users/guide_get_channel_response.rbi +183 -0
- data/rbi/knockapi/models/users/guide_mark_message_as_archived_params.rbi +124 -0
- data/rbi/knockapi/models/users/guide_mark_message_as_archived_response.rbi +33 -0
- data/rbi/knockapi/models/users/guide_mark_message_as_interacted_params.rbi +124 -0
- data/rbi/knockapi/models/users/guide_mark_message_as_interacted_response.rbi +33 -0
- data/rbi/knockapi/models/users/guide_mark_message_as_seen_params.rbi +124 -0
- data/rbi/knockapi/models/users/guide_mark_message_as_seen_response.rbi +33 -0
- data/rbi/knockapi/models/workflow_cancel_params.rbi +82 -0
- data/rbi/knockapi/models/workflow_cancel_response.rbi +7 -0
- data/rbi/knockapi/models/workflow_trigger_params.rbi +137 -0
- data/rbi/knockapi/models/workflow_trigger_response.rbi +33 -0
- data/rbi/knockapi/models.rbi +179 -0
- data/rbi/knockapi/request_options.rbi +59 -0
- data/rbi/knockapi/resources/audiences.rbi +61 -0
- data/rbi/knockapi/resources/bulk_operations.rbi +26 -0
- data/rbi/knockapi/resources/channels/bulk.rbi +70 -0
- data/rbi/knockapi/resources/channels.rbi +15 -0
- data/rbi/knockapi/resources/integrations/census.rbi +39 -0
- data/rbi/knockapi/resources/integrations/hightouch.rbi +39 -0
- data/rbi/knockapi/resources/integrations.rbi +18 -0
- data/rbi/knockapi/resources/messages/batch.rbi +145 -0
- data/rbi/knockapi/resources/messages.rbi +290 -0
- data/rbi/knockapi/resources/objects/bulk.rbi +72 -0
- data/rbi/knockapi/resources/objects.rbi +504 -0
- data/rbi/knockapi/resources/providers/ms_teams.rbi +98 -0
- data/rbi/knockapi/resources/providers/slack.rbi +72 -0
- data/rbi/knockapi/resources/providers.rbi +18 -0
- data/rbi/knockapi/resources/recipients/channel_data.rbi +14 -0
- data/rbi/knockapi/resources/recipients/preferences.rbi +14 -0
- data/rbi/knockapi/resources/recipients/subscriptions.rbi +14 -0
- data/rbi/knockapi/resources/recipients.rbi +21 -0
- data/rbi/knockapi/resources/schedules/bulk.rbi +31 -0
- data/rbi/knockapi/resources/schedules.rbi +146 -0
- data/rbi/knockapi/resources/shared.rbi +12 -0
- data/rbi/knockapi/resources/tenants/bulk.rbi +42 -0
- data/rbi/knockapi/resources/tenants.rbi +111 -0
- data/rbi/knockapi/resources/users/bulk.rbi +64 -0
- data/rbi/knockapi/resources/users/feeds.rbi +83 -0
- data/rbi/knockapi/resources/users/guides.rbi +177 -0
- data/rbi/knockapi/resources/users.rbi +426 -0
- data/rbi/knockapi/resources/workflows.rbi +101 -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 +22 -0
- data/sig/knockapi/internal/items_cursor.rbs +22 -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 +131 -0
- data/sig/knockapi/internal/transport/pooled_net_requester.rbs +45 -0
- data/sig/knockapi/internal/type/array_of.rbs +45 -0
- data/sig/knockapi/internal/type/base_model.rbs +100 -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 +56 -0
- data/sig/knockapi/internal/type/enum.rbs +30 -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 +17 -0
- data/sig/knockapi/internal/type/union.rbs +50 -0
- data/sig/knockapi/internal/type/unknown.rbs +23 -0
- data/sig/knockapi/internal/util.rbs +173 -0
- data/sig/knockapi/internal.rbs +7 -0
- data/sig/knockapi/models/activity.rbs +52 -0
- data/sig/knockapi/models/audience_add_members_params.rbs +46 -0
- data/sig/knockapi/models/audience_add_members_response.rbs +5 -0
- data/sig/knockapi/models/audience_list_members_params.rbs +13 -0
- data/sig/knockapi/models/audience_list_members_response.rbs +20 -0
- data/sig/knockapi/models/audience_member.rbs +32 -0
- data/sig/knockapi/models/audience_remove_members_params.rbs +46 -0
- data/sig/knockapi/models/audience_remove_members_response.rbs +5 -0
- data/sig/knockapi/models/bulk_operation.rbs +103 -0
- data/sig/knockapi/models/bulk_operation_get_params.rbs +13 -0
- data/sig/knockapi/models/channels/bulk_update_message_status_params.rbs +174 -0
- data/sig/knockapi/models/condition.rbs +69 -0
- data/sig/knockapi/models/identify_user_request.rbs +48 -0
- data/sig/knockapi/models/inline_identify_user_request.rbs +52 -0
- data/sig/knockapi/models/inline_object_request.rbs +32 -0
- data/sig/knockapi/models/inline_tenant_request.rbs +11 -0
- data/sig/knockapi/models/integrations/census_custom_destination_params.rbs +37 -0
- data/sig/knockapi/models/integrations/census_custom_destination_response.rbs +20 -0
- data/sig/knockapi/models/integrations/hightouch_embedded_destination_params.rbs +37 -0
- data/sig/knockapi/models/integrations/hightouch_embedded_destination_response.rbs +20 -0
- data/sig/knockapi/models/message.rbs +185 -0
- data/sig/knockapi/models/message_archive_params.rbs +13 -0
- data/sig/knockapi/models/message_delivery_log.rbs +146 -0
- data/sig/knockapi/models/message_event.rbs +75 -0
- data/sig/knockapi/models/message_get_content_params.rbs +13 -0
- data/sig/knockapi/models/message_get_content_response.rbs +316 -0
- data/sig/knockapi/models/message_get_params.rbs +13 -0
- data/sig/knockapi/models/message_list_activities_params.rbs +41 -0
- data/sig/knockapi/models/message_list_delivery_logs_params.rbs +31 -0
- data/sig/knockapi/models/message_list_events_params.rbs +31 -0
- data/sig/knockapi/models/message_list_params.rbs +172 -0
- data/sig/knockapi/models/message_mark_as_interacted_params.rbs +21 -0
- data/sig/knockapi/models/message_mark_as_read_params.rbs +13 -0
- data/sig/knockapi/models/message_mark_as_seen_params.rbs +13 -0
- data/sig/knockapi/models/message_mark_as_unread_params.rbs +13 -0
- data/sig/knockapi/models/message_mark_as_unseen_params.rbs +13 -0
- data/sig/knockapi/models/message_unarchive_params.rbs +13 -0
- data/sig/knockapi/models/messages/batch_archive_params.rbs +21 -0
- data/sig/knockapi/models/messages/batch_archive_response.rbs +9 -0
- data/sig/knockapi/models/messages/batch_get_content_params.rbs +21 -0
- data/sig/knockapi/models/messages/batch_get_content_response.rbs +327 -0
- data/sig/knockapi/models/messages/batch_mark_as_interacted_params.rbs +24 -0
- data/sig/knockapi/models/messages/batch_mark_as_interacted_response.rbs +9 -0
- data/sig/knockapi/models/messages/batch_mark_as_read_params.rbs +21 -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 +21 -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 +21 -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 +21 -0
- data/sig/knockapi/models/messages/batch_mark_as_unseen_response.rbs +9 -0
- data/sig/knockapi/models/messages/batch_unarchive_params.rbs +21 -0
- data/sig/knockapi/models/messages/batch_unarchive_response.rbs +9 -0
- data/sig/knockapi/models/object.rbs +38 -0
- data/sig/knockapi/models/object_add_subscriptions_params.rbs +25 -0
- data/sig/knockapi/models/object_add_subscriptions_response.rbs +8 -0
- data/sig/knockapi/models/object_delete_params.rbs +13 -0
- data/sig/knockapi/models/object_delete_response.rbs +5 -0
- data/sig/knockapi/models/object_delete_subscriptions_params.rbs +19 -0
- data/sig/knockapi/models/object_delete_subscriptions_response.rbs +8 -0
- data/sig/knockapi/models/object_get_channel_data_params.rbs +13 -0
- data/sig/knockapi/models/object_get_params.rbs +12 -0
- data/sig/knockapi/models/object_get_preferences_params.rbs +13 -0
- data/sig/knockapi/models/object_list_messages_params.rbs +172 -0
- data/sig/knockapi/models/object_list_params.rbs +53 -0
- data/sig/knockapi/models/object_list_preferences_params.rbs +13 -0
- data/sig/knockapi/models/object_list_preferences_response.rbs +8 -0
- data/sig/knockapi/models/object_list_schedules_params.rbs +47 -0
- data/sig/knockapi/models/object_list_subscriptions_params.rbs +102 -0
- data/sig/knockapi/models/object_set_channel_data_params.rbs +13 -0
- data/sig/knockapi/models/object_set_params.rbs +41 -0
- data/sig/knockapi/models/object_set_preferences_params.rbs +13 -0
- data/sig/knockapi/models/object_unset_channel_data_params.rbs +13 -0
- data/sig/knockapi/models/object_unset_channel_data_response.rbs +5 -0
- data/sig/knockapi/models/objects/bulk_add_subscriptions_params.rbs +40 -0
- data/sig/knockapi/models/objects/bulk_delete_params.rbs +21 -0
- data/sig/knockapi/models/objects/bulk_set_params.rbs +21 -0
- data/sig/knockapi/models/page_info.rbs +23 -0
- data/sig/knockapi/models/providers/ms_team_check_auth_params.rbs +21 -0
- data/sig/knockapi/models/providers/ms_team_check_auth_response.rbs +28 -0
- data/sig/knockapi/models/providers/ms_team_list_channels_params.rbs +49 -0
- data/sig/knockapi/models/providers/ms_team_list_channels_response.rbs +57 -0
- data/sig/knockapi/models/providers/ms_team_list_teams_params.rbs +59 -0
- data/sig/knockapi/models/providers/ms_team_list_teams_response.rbs +22 -0
- data/sig/knockapi/models/providers/ms_team_revoke_access_params.rbs +21 -0
- data/sig/knockapi/models/providers/ms_team_revoke_access_response.rbs +15 -0
- data/sig/knockapi/models/providers/slack_check_auth_params.rbs +21 -0
- data/sig/knockapi/models/providers/slack_check_auth_response.rbs +28 -0
- data/sig/knockapi/models/providers/slack_list_channels_params.rbs +70 -0
- data/sig/knockapi/models/providers/slack_list_channels_response.rbs +34 -0
- data/sig/knockapi/models/providers/slack_revoke_access_params.rbs +21 -0
- data/sig/knockapi/models/providers/slack_revoke_access_response.rbs +15 -0
- data/sig/knockapi/models/recipient.rbs +11 -0
- data/sig/knockapi/models/recipient_reference.rbs +26 -0
- data/sig/knockapi/models/recipient_request.rbs +14 -0
- data/sig/knockapi/models/recipients/channel_data.rbs +72 -0
- data/sig/knockapi/models/recipients/channel_data_request.rbs +29 -0
- data/sig/knockapi/models/recipients/discord_channel_data.rbs +57 -0
- data/sig/knockapi/models/recipients/inline_channel_data_request.rbs +23 -0
- data/sig/knockapi/models/recipients/inline_preference_set_request.rbs +10 -0
- data/sig/knockapi/models/recipients/ms_teams_channel_data.rbs +78 -0
- data/sig/knockapi/models/recipients/one_signal_channel_data.rbs +13 -0
- data/sig/knockapi/models/recipients/preference_set.rbs +84 -0
- data/sig/knockapi/models/recipients/preference_set_channel_type_setting.rbs +14 -0
- data/sig/knockapi/models/recipients/preference_set_channel_types.rbs +112 -0
- data/sig/knockapi/models/recipients/preference_set_request.rbs +80 -0
- data/sig/knockapi/models/recipients/push_channel_data.rbs +13 -0
- data/sig/knockapi/models/recipients/slack_channel_data.rbs +65 -0
- data/sig/knockapi/models/recipients/subscription.rbs +38 -0
- data/sig/knockapi/models/schedule.rbs +62 -0
- data/sig/knockapi/models/schedule_create_params.rbs +45 -0
- data/sig/knockapi/models/schedule_create_response.rbs +7 -0
- data/sig/knockapi/models/schedule_delete_params.rbs +19 -0
- data/sig/knockapi/models/schedule_delete_response.rbs +7 -0
- data/sig/knockapi/models/schedule_list_params.rbs +51 -0
- data/sig/knockapi/models/schedule_repeat_rule.rbs +71 -0
- data/sig/knockapi/models/schedule_update_params.rbs +49 -0
- data/sig/knockapi/models/schedule_update_response.rbs +7 -0
- data/sig/knockapi/models/schedules/bulk_create_params.rbs +70 -0
- data/sig/knockapi/models/tenant.rbs +70 -0
- data/sig/knockapi/models/tenant_delete_params.rbs +13 -0
- data/sig/knockapi/models/tenant_delete_response.rbs +5 -0
- data/sig/knockapi/models/tenant_get_params.rbs +12 -0
- data/sig/knockapi/models/tenant_list_params.rbs +47 -0
- data/sig/knockapi/models/tenant_request.rbs +78 -0
- data/sig/knockapi/models/tenant_set_params.rbs +79 -0
- data/sig/knockapi/models/tenants/bulk_delete_params.rbs +21 -0
- data/sig/knockapi/models/tenants/bulk_set_params.rbs +21 -0
- data/sig/knockapi/models/user.rbs +48 -0
- data/sig/knockapi/models/user_delete_params.rbs +13 -0
- data/sig/knockapi/models/user_delete_response.rbs +5 -0
- data/sig/knockapi/models/user_get_channel_data_params.rbs +13 -0
- data/sig/knockapi/models/user_get_params.rbs +12 -0
- data/sig/knockapi/models/user_get_preferences_params.rbs +20 -0
- data/sig/knockapi/models/user_list_messages_params.rbs +172 -0
- data/sig/knockapi/models/user_list_params.rbs +53 -0
- data/sig/knockapi/models/user_list_preferences_params.rbs +13 -0
- data/sig/knockapi/models/user_list_preferences_response.rbs +8 -0
- data/sig/knockapi/models/user_list_schedules_params.rbs +47 -0
- data/sig/knockapi/models/user_list_subscriptions_params.rbs +59 -0
- data/sig/knockapi/models/user_merge_params.rbs +18 -0
- data/sig/knockapi/models/user_set_channel_data_params.rbs +13 -0
- data/sig/knockapi/models/user_set_preferences_params.rbs +13 -0
- data/sig/knockapi/models/user_unset_channel_data_params.rbs +13 -0
- data/sig/knockapi/models/user_unset_channel_data_response.rbs +5 -0
- data/sig/knockapi/models/user_update_params.rbs +13 -0
- data/sig/knockapi/models/users/bulk_delete_params.rbs +21 -0
- data/sig/knockapi/models/users/bulk_identify_params.rbs +21 -0
- data/sig/knockapi/models/users/bulk_set_preferences_params.rbs +27 -0
- data/sig/knockapi/models/users/feed_get_settings_params.rbs +15 -0
- data/sig/knockapi/models/users/feed_get_settings_response.rbs +24 -0
- data/sig/knockapi/models/users/feed_list_items_params.rbs +109 -0
- data/sig/knockapi/models/users/feed_list_items_response.rbs +204 -0
- data/sig/knockapi/models/users/guide_get_channel_params.rbs +33 -0
- data/sig/knockapi/models/users/guide_get_channel_response.rbs +65 -0
- data/sig/knockapi/models/users/guide_mark_message_as_archived_params.rbs +63 -0
- data/sig/knockapi/models/users/guide_mark_message_as_archived_response.rbs +13 -0
- data/sig/knockapi/models/users/guide_mark_message_as_interacted_params.rbs +63 -0
- data/sig/knockapi/models/users/guide_mark_message_as_interacted_response.rbs +13 -0
- data/sig/knockapi/models/users/guide_mark_message_as_seen_params.rbs +63 -0
- data/sig/knockapi/models/users/guide_mark_message_as_seen_response.rbs +13 -0
- data/sig/knockapi/models/workflow_cancel_params.rbs +25 -0
- data/sig/knockapi/models/workflow_cancel_response.rbs +5 -0
- data/sig/knockapi/models/workflow_trigger_params.rbs +37 -0
- data/sig/knockapi/models/workflow_trigger_response.rbs +11 -0
- data/sig/knockapi/models.rbs +173 -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/batch.rbs +50 -0
- data/sig/knockapi/resources/messages.rbs +98 -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 +678 -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
data/lib/knockapi.rb
ADDED
@@ -0,0 +1,248 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Standard libraries.
|
4
|
+
# rubocop:disable Lint/RedundantRequireStatement
|
5
|
+
require "English"
|
6
|
+
require "cgi"
|
7
|
+
require "date"
|
8
|
+
require "erb"
|
9
|
+
require "etc"
|
10
|
+
require "json"
|
11
|
+
require "net/http"
|
12
|
+
require "pathname"
|
13
|
+
require "rbconfig"
|
14
|
+
require "securerandom"
|
15
|
+
require "set"
|
16
|
+
require "stringio"
|
17
|
+
require "time"
|
18
|
+
require "uri"
|
19
|
+
# rubocop:enable Lint/RedundantRequireStatement
|
20
|
+
|
21
|
+
# We already ship the preferred sorbet manifests in the package itself.
|
22
|
+
# `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
|
23
|
+
if Object.const_defined?(:Tapioca) && caller.chain([$PROGRAM_NAME]).chain(ARGV).grep(/tapioca/)
|
24
|
+
return
|
25
|
+
end
|
26
|
+
|
27
|
+
# Gems.
|
28
|
+
require "connection_pool"
|
29
|
+
|
30
|
+
# Package files.
|
31
|
+
require_relative "knockapi/version"
|
32
|
+
require_relative "knockapi/internal/util"
|
33
|
+
require_relative "knockapi/internal/type/converter"
|
34
|
+
require_relative "knockapi/internal/type/unknown"
|
35
|
+
require_relative "knockapi/internal/type/boolean"
|
36
|
+
require_relative "knockapi/internal/type/file_input"
|
37
|
+
require_relative "knockapi/internal/type/enum"
|
38
|
+
require_relative "knockapi/internal/type/union"
|
39
|
+
require_relative "knockapi/internal/type/array_of"
|
40
|
+
require_relative "knockapi/internal/type/hash_of"
|
41
|
+
require_relative "knockapi/internal/type/base_model"
|
42
|
+
require_relative "knockapi/internal/type/base_page"
|
43
|
+
require_relative "knockapi/internal/type/request_parameters"
|
44
|
+
require_relative "knockapi/internal"
|
45
|
+
require_relative "knockapi/request_options"
|
46
|
+
require_relative "knockapi/file_part"
|
47
|
+
require_relative "knockapi/errors"
|
48
|
+
require_relative "knockapi/internal/transport/base_client"
|
49
|
+
require_relative "knockapi/internal/transport/pooled_net_requester"
|
50
|
+
require_relative "knockapi/client"
|
51
|
+
require_relative "knockapi/internal/entries_cursor"
|
52
|
+
require_relative "knockapi/internal/items_cursor"
|
53
|
+
require_relative "knockapi/internal/ms_teams_pagination"
|
54
|
+
require_relative "knockapi/internal/slack_channels_cursor"
|
55
|
+
require_relative "knockapi/models/recipients/channel_data_request"
|
56
|
+
require_relative "knockapi/models/recipients/preference_set_request"
|
57
|
+
require_relative "knockapi/models/identify_user_request"
|
58
|
+
require_relative "knockapi/models/activity"
|
59
|
+
require_relative "knockapi/models/audience_add_members_params"
|
60
|
+
require_relative "knockapi/models/audience_add_members_response"
|
61
|
+
require_relative "knockapi/models/audience_list_members_params"
|
62
|
+
require_relative "knockapi/models/audience_list_members_response"
|
63
|
+
require_relative "knockapi/models/audience_member"
|
64
|
+
require_relative "knockapi/models/audience_remove_members_params"
|
65
|
+
require_relative "knockapi/models/audience_remove_members_response"
|
66
|
+
require_relative "knockapi/models/bulk_operation"
|
67
|
+
require_relative "knockapi/models/bulk_operation_get_params"
|
68
|
+
require_relative "knockapi/models/channels/bulk_update_message_status_params"
|
69
|
+
require_relative "knockapi/models/condition"
|
70
|
+
require_relative "knockapi/models/inline_identify_user_request"
|
71
|
+
require_relative "knockapi/models/inline_object_request"
|
72
|
+
require_relative "knockapi/models/inline_tenant_request"
|
73
|
+
require_relative "knockapi/models/integrations/census_custom_destination_params"
|
74
|
+
require_relative "knockapi/models/integrations/census_custom_destination_response"
|
75
|
+
require_relative "knockapi/models/integrations/hightouch_embedded_destination_params"
|
76
|
+
require_relative "knockapi/models/integrations/hightouch_embedded_destination_response"
|
77
|
+
require_relative "knockapi/models/message"
|
78
|
+
require_relative "knockapi/models/message_archive_params"
|
79
|
+
require_relative "knockapi/models/message_delivery_log"
|
80
|
+
require_relative "knockapi/models/message_event"
|
81
|
+
require_relative "knockapi/models/message_get_content_params"
|
82
|
+
require_relative "knockapi/models/message_get_content_response"
|
83
|
+
require_relative "knockapi/models/message_get_params"
|
84
|
+
require_relative "knockapi/models/message_list_activities_params"
|
85
|
+
require_relative "knockapi/models/message_list_delivery_logs_params"
|
86
|
+
require_relative "knockapi/models/message_list_events_params"
|
87
|
+
require_relative "knockapi/models/message_list_params"
|
88
|
+
require_relative "knockapi/models/message_mark_as_interacted_params"
|
89
|
+
require_relative "knockapi/models/message_mark_as_read_params"
|
90
|
+
require_relative "knockapi/models/message_mark_as_seen_params"
|
91
|
+
require_relative "knockapi/models/message_mark_as_unread_params"
|
92
|
+
require_relative "knockapi/models/message_mark_as_unseen_params"
|
93
|
+
require_relative "knockapi/models/messages/batch_archive_params"
|
94
|
+
require_relative "knockapi/models/messages/batch_archive_response"
|
95
|
+
require_relative "knockapi/models/messages/batch_get_content_params"
|
96
|
+
require_relative "knockapi/models/messages/batch_get_content_response"
|
97
|
+
require_relative "knockapi/models/messages/batch_mark_as_interacted_params"
|
98
|
+
require_relative "knockapi/models/messages/batch_mark_as_interacted_response"
|
99
|
+
require_relative "knockapi/models/messages/batch_mark_as_read_params"
|
100
|
+
require_relative "knockapi/models/messages/batch_mark_as_read_response"
|
101
|
+
require_relative "knockapi/models/messages/batch_mark_as_seen_params"
|
102
|
+
require_relative "knockapi/models/messages/batch_mark_as_seen_response"
|
103
|
+
require_relative "knockapi/models/messages/batch_mark_as_unread_params"
|
104
|
+
require_relative "knockapi/models/messages/batch_mark_as_unread_response"
|
105
|
+
require_relative "knockapi/models/messages/batch_mark_as_unseen_params"
|
106
|
+
require_relative "knockapi/models/messages/batch_mark_as_unseen_response"
|
107
|
+
require_relative "knockapi/models/messages/batch_unarchive_params"
|
108
|
+
require_relative "knockapi/models/messages/batch_unarchive_response"
|
109
|
+
require_relative "knockapi/models/message_unarchive_params"
|
110
|
+
require_relative "knockapi/models/object"
|
111
|
+
require_relative "knockapi/models/object_add_subscriptions_params"
|
112
|
+
require_relative "knockapi/models/object_add_subscriptions_response"
|
113
|
+
require_relative "knockapi/models/object_delete_params"
|
114
|
+
require_relative "knockapi/models/object_delete_response"
|
115
|
+
require_relative "knockapi/models/object_delete_subscriptions_params"
|
116
|
+
require_relative "knockapi/models/object_delete_subscriptions_response"
|
117
|
+
require_relative "knockapi/models/object_get_channel_data_params"
|
118
|
+
require_relative "knockapi/models/object_get_params"
|
119
|
+
require_relative "knockapi/models/object_get_preferences_params"
|
120
|
+
require_relative "knockapi/models/object_list_messages_params"
|
121
|
+
require_relative "knockapi/models/object_list_params"
|
122
|
+
require_relative "knockapi/models/object_list_preferences_params"
|
123
|
+
require_relative "knockapi/models/object_list_preferences_response"
|
124
|
+
require_relative "knockapi/models/object_list_schedules_params"
|
125
|
+
require_relative "knockapi/models/object_list_subscriptions_params"
|
126
|
+
require_relative "knockapi/models/objects/bulk_add_subscriptions_params"
|
127
|
+
require_relative "knockapi/models/objects/bulk_delete_params"
|
128
|
+
require_relative "knockapi/models/objects/bulk_set_params"
|
129
|
+
require_relative "knockapi/models/object_set_channel_data_params"
|
130
|
+
require_relative "knockapi/models/object_set_params"
|
131
|
+
require_relative "knockapi/models/object_set_preferences_params"
|
132
|
+
require_relative "knockapi/models/object_unset_channel_data_params"
|
133
|
+
require_relative "knockapi/models/object_unset_channel_data_response"
|
134
|
+
require_relative "knockapi/models/page_info"
|
135
|
+
require_relative "knockapi/models/providers/ms_team_check_auth_params"
|
136
|
+
require_relative "knockapi/models/providers/ms_team_check_auth_response"
|
137
|
+
require_relative "knockapi/models/providers/ms_team_list_channels_params"
|
138
|
+
require_relative "knockapi/models/providers/ms_team_list_channels_response"
|
139
|
+
require_relative "knockapi/models/providers/ms_team_list_teams_params"
|
140
|
+
require_relative "knockapi/models/providers/ms_team_list_teams_response"
|
141
|
+
require_relative "knockapi/models/providers/ms_team_revoke_access_params"
|
142
|
+
require_relative "knockapi/models/providers/ms_team_revoke_access_response"
|
143
|
+
require_relative "knockapi/models/providers/slack_check_auth_params"
|
144
|
+
require_relative "knockapi/models/providers/slack_check_auth_response"
|
145
|
+
require_relative "knockapi/models/providers/slack_list_channels_params"
|
146
|
+
require_relative "knockapi/models/providers/slack_list_channels_response"
|
147
|
+
require_relative "knockapi/models/providers/slack_revoke_access_params"
|
148
|
+
require_relative "knockapi/models/providers/slack_revoke_access_response"
|
149
|
+
require_relative "knockapi/models/recipient"
|
150
|
+
require_relative "knockapi/models/recipient_reference"
|
151
|
+
require_relative "knockapi/models/recipient_request"
|
152
|
+
require_relative "knockapi/models/recipients/discord_channel_data"
|
153
|
+
require_relative "knockapi/models/recipients/inline_channel_data_request"
|
154
|
+
require_relative "knockapi/models/recipients/inline_preference_set_request"
|
155
|
+
require_relative "knockapi/models/recipients/ms_teams_channel_data"
|
156
|
+
require_relative "knockapi/models/recipients/one_signal_channel_data"
|
157
|
+
require_relative "knockapi/models/recipients/preference_set"
|
158
|
+
require_relative "knockapi/models/recipients/preference_set_channel_types"
|
159
|
+
require_relative "knockapi/models/recipients/preference_set_channel_type_setting"
|
160
|
+
require_relative "knockapi/models/recipients/push_channel_data"
|
161
|
+
require_relative "knockapi/models/recipients/channel_data"
|
162
|
+
require_relative "knockapi/models/recipients/slack_channel_data"
|
163
|
+
require_relative "knockapi/models/recipients/subscription"
|
164
|
+
require_relative "knockapi/models/schedule"
|
165
|
+
require_relative "knockapi/models/schedule_create_params"
|
166
|
+
require_relative "knockapi/models/schedule_create_response"
|
167
|
+
require_relative "knockapi/models/schedule_delete_params"
|
168
|
+
require_relative "knockapi/models/schedule_delete_response"
|
169
|
+
require_relative "knockapi/models/schedule_list_params"
|
170
|
+
require_relative "knockapi/models/schedule_repeat_rule"
|
171
|
+
require_relative "knockapi/models/schedules/bulk_create_params"
|
172
|
+
require_relative "knockapi/models/schedule_update_params"
|
173
|
+
require_relative "knockapi/models/schedule_update_response"
|
174
|
+
require_relative "knockapi/models/tenant"
|
175
|
+
require_relative "knockapi/models/tenant_delete_params"
|
176
|
+
require_relative "knockapi/models/tenant_delete_response"
|
177
|
+
require_relative "knockapi/models/tenant_get_params"
|
178
|
+
require_relative "knockapi/models/tenant_list_params"
|
179
|
+
require_relative "knockapi/models/tenant_request"
|
180
|
+
require_relative "knockapi/models/tenants/bulk_delete_params"
|
181
|
+
require_relative "knockapi/models/tenants/bulk_set_params"
|
182
|
+
require_relative "knockapi/models/tenant_set_params"
|
183
|
+
require_relative "knockapi/models/user"
|
184
|
+
require_relative "knockapi/models/user_delete_params"
|
185
|
+
require_relative "knockapi/models/user_delete_response"
|
186
|
+
require_relative "knockapi/models/user_get_channel_data_params"
|
187
|
+
require_relative "knockapi/models/user_get_params"
|
188
|
+
require_relative "knockapi/models/user_get_preferences_params"
|
189
|
+
require_relative "knockapi/models/user_list_messages_params"
|
190
|
+
require_relative "knockapi/models/user_list_params"
|
191
|
+
require_relative "knockapi/models/user_list_preferences_params"
|
192
|
+
require_relative "knockapi/models/user_list_preferences_response"
|
193
|
+
require_relative "knockapi/models/user_list_schedules_params"
|
194
|
+
require_relative "knockapi/models/user_list_subscriptions_params"
|
195
|
+
require_relative "knockapi/models/user_merge_params"
|
196
|
+
require_relative "knockapi/models/users/bulk_delete_params"
|
197
|
+
require_relative "knockapi/models/users/bulk_identify_params"
|
198
|
+
require_relative "knockapi/models/users/bulk_set_preferences_params"
|
199
|
+
require_relative "knockapi/models/users/feed_get_settings_params"
|
200
|
+
require_relative "knockapi/models/users/feed_get_settings_response"
|
201
|
+
require_relative "knockapi/models/users/feed_list_items_params"
|
202
|
+
require_relative "knockapi/models/users/feed_list_items_response"
|
203
|
+
require_relative "knockapi/models/users/guide_get_channel_params"
|
204
|
+
require_relative "knockapi/models/users/guide_get_channel_response"
|
205
|
+
require_relative "knockapi/models/users/guide_mark_message_as_archived_params"
|
206
|
+
require_relative "knockapi/models/users/guide_mark_message_as_archived_response"
|
207
|
+
require_relative "knockapi/models/users/guide_mark_message_as_interacted_params"
|
208
|
+
require_relative "knockapi/models/users/guide_mark_message_as_interacted_response"
|
209
|
+
require_relative "knockapi/models/users/guide_mark_message_as_seen_params"
|
210
|
+
require_relative "knockapi/models/users/guide_mark_message_as_seen_response"
|
211
|
+
require_relative "knockapi/models/user_set_channel_data_params"
|
212
|
+
require_relative "knockapi/models/user_set_preferences_params"
|
213
|
+
require_relative "knockapi/models/user_unset_channel_data_params"
|
214
|
+
require_relative "knockapi/models/user_unset_channel_data_response"
|
215
|
+
require_relative "knockapi/models/user_update_params"
|
216
|
+
require_relative "knockapi/models/workflow_cancel_params"
|
217
|
+
require_relative "knockapi/models/workflow_cancel_response"
|
218
|
+
require_relative "knockapi/models/workflow_trigger_params"
|
219
|
+
require_relative "knockapi/models/workflow_trigger_response"
|
220
|
+
require_relative "knockapi/models"
|
221
|
+
require_relative "knockapi/resources/audiences"
|
222
|
+
require_relative "knockapi/resources/bulk_operations"
|
223
|
+
require_relative "knockapi/resources/channels"
|
224
|
+
require_relative "knockapi/resources/channels/bulk"
|
225
|
+
require_relative "knockapi/resources/integrations"
|
226
|
+
require_relative "knockapi/resources/integrations/census"
|
227
|
+
require_relative "knockapi/resources/integrations/hightouch"
|
228
|
+
require_relative "knockapi/resources/messages"
|
229
|
+
require_relative "knockapi/resources/messages/batch"
|
230
|
+
require_relative "knockapi/resources/objects"
|
231
|
+
require_relative "knockapi/resources/objects/bulk"
|
232
|
+
require_relative "knockapi/resources/providers"
|
233
|
+
require_relative "knockapi/resources/providers/ms_teams"
|
234
|
+
require_relative "knockapi/resources/providers/slack"
|
235
|
+
require_relative "knockapi/resources/recipients"
|
236
|
+
require_relative "knockapi/resources/recipients/channel_data"
|
237
|
+
require_relative "knockapi/resources/recipients/preferences"
|
238
|
+
require_relative "knockapi/resources/recipients/subscriptions"
|
239
|
+
require_relative "knockapi/resources/schedules"
|
240
|
+
require_relative "knockapi/resources/schedules/bulk"
|
241
|
+
require_relative "knockapi/resources/shared"
|
242
|
+
require_relative "knockapi/resources/tenants"
|
243
|
+
require_relative "knockapi/resources/tenants/bulk"
|
244
|
+
require_relative "knockapi/resources/users"
|
245
|
+
require_relative "knockapi/resources/users/bulk"
|
246
|
+
require_relative "knockapi/resources/users/feeds"
|
247
|
+
require_relative "knockapi/resources/users/guides"
|
248
|
+
require_relative "knockapi/resources/workflows"
|
data/manifest.yaml
ADDED
@@ -0,0 +1,85 @@
|
|
1
|
+
# typed: strong
|
2
|
+
|
3
|
+
module Knockapi
|
4
|
+
class Client < Knockapi::Internal::Transport::BaseClient
|
5
|
+
DEFAULT_MAX_RETRIES = 2
|
6
|
+
|
7
|
+
DEFAULT_TIMEOUT_IN_SECONDS = T.let(60.0, Float)
|
8
|
+
|
9
|
+
DEFAULT_INITIAL_RETRY_DELAY = T.let(0.5, Float)
|
10
|
+
|
11
|
+
DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float)
|
12
|
+
|
13
|
+
sig { returns(String) }
|
14
|
+
attr_reader :api_key
|
15
|
+
|
16
|
+
sig { returns(Knockapi::Resources::Shared) }
|
17
|
+
attr_reader :shared
|
18
|
+
|
19
|
+
sig { returns(Knockapi::Resources::Recipients) }
|
20
|
+
attr_reader :recipients
|
21
|
+
|
22
|
+
sig { returns(Knockapi::Resources::Users) }
|
23
|
+
attr_reader :users
|
24
|
+
|
25
|
+
sig { returns(Knockapi::Resources::Objects) }
|
26
|
+
attr_reader :objects
|
27
|
+
|
28
|
+
sig { returns(Knockapi::Resources::Tenants) }
|
29
|
+
attr_reader :tenants
|
30
|
+
|
31
|
+
sig { returns(Knockapi::Resources::BulkOperations) }
|
32
|
+
attr_reader :bulk_operations
|
33
|
+
|
34
|
+
sig { returns(Knockapi::Resources::Messages) }
|
35
|
+
attr_reader :messages
|
36
|
+
|
37
|
+
sig { returns(Knockapi::Resources::Providers) }
|
38
|
+
attr_reader :providers
|
39
|
+
|
40
|
+
sig { returns(Knockapi::Resources::Integrations) }
|
41
|
+
attr_reader :integrations
|
42
|
+
|
43
|
+
sig { returns(Knockapi::Resources::Workflows) }
|
44
|
+
attr_reader :workflows
|
45
|
+
|
46
|
+
sig { returns(Knockapi::Resources::Schedules) }
|
47
|
+
attr_reader :schedules
|
48
|
+
|
49
|
+
sig { returns(Knockapi::Resources::Channels) }
|
50
|
+
attr_reader :channels
|
51
|
+
|
52
|
+
sig { returns(Knockapi::Resources::Audiences) }
|
53
|
+
attr_reader :audiences
|
54
|
+
|
55
|
+
# @api private
|
56
|
+
sig { override.returns(T::Hash[String, String]) }
|
57
|
+
private def auth_headers
|
58
|
+
end
|
59
|
+
|
60
|
+
# Creates and returns a new client for interacting with the API.
|
61
|
+
sig do
|
62
|
+
params(
|
63
|
+
api_key: T.nilable(String),
|
64
|
+
base_url: T.nilable(String),
|
65
|
+
max_retries: Integer,
|
66
|
+
timeout: Float,
|
67
|
+
initial_retry_delay: Float,
|
68
|
+
max_retry_delay: Float
|
69
|
+
).returns(T.attached_class)
|
70
|
+
end
|
71
|
+
def self.new(
|
72
|
+
# Defaults to `ENV["KNOCK_API_KEY"]`
|
73
|
+
api_key: ENV["KNOCK_API_KEY"],
|
74
|
+
# Override the default base URL for the API, e.g.,
|
75
|
+
# `"https://api.example.com/v2/"`. Defaults to `ENV["KNOCK_BASE_URL"]`
|
76
|
+
base_url: ENV["KNOCK_BASE_URL"],
|
77
|
+
# Max number of retries to attempt after a failed retryable request.
|
78
|
+
max_retries: Knockapi::Client::DEFAULT_MAX_RETRIES,
|
79
|
+
timeout: Knockapi::Client::DEFAULT_TIMEOUT_IN_SECONDS,
|
80
|
+
initial_retry_delay: Knockapi::Client::DEFAULT_INITIAL_RETRY_DELAY,
|
81
|
+
max_retry_delay: Knockapi::Client::DEFAULT_MAX_RETRY_DELAY
|
82
|
+
)
|
83
|
+
end
|
84
|
+
end
|
85
|
+
end
|
@@ -0,0 +1,162 @@
|
|
1
|
+
# typed: strong
|
2
|
+
|
3
|
+
module Knockapi
|
4
|
+
module Errors
|
5
|
+
class Error < StandardError
|
6
|
+
sig { returns(T.nilable(StandardError)) }
|
7
|
+
attr_accessor :cause
|
8
|
+
end
|
9
|
+
|
10
|
+
class ConversionError < Knockapi::Errors::Error
|
11
|
+
end
|
12
|
+
|
13
|
+
class APIError < Knockapi::Errors::Error
|
14
|
+
sig { returns(URI::Generic) }
|
15
|
+
attr_accessor :url
|
16
|
+
|
17
|
+
sig { returns(T.nilable(Integer)) }
|
18
|
+
attr_accessor :status
|
19
|
+
|
20
|
+
sig { returns(T.nilable(T.anything)) }
|
21
|
+
attr_accessor :body
|
22
|
+
|
23
|
+
# @api private
|
24
|
+
sig do
|
25
|
+
params(
|
26
|
+
url: URI::Generic,
|
27
|
+
status: T.nilable(Integer),
|
28
|
+
body: T.nilable(Object),
|
29
|
+
request: NilClass,
|
30
|
+
response: NilClass,
|
31
|
+
message: T.nilable(String)
|
32
|
+
).returns(T.attached_class)
|
33
|
+
end
|
34
|
+
def self.new(
|
35
|
+
url:,
|
36
|
+
status: nil,
|
37
|
+
body: nil,
|
38
|
+
request: nil,
|
39
|
+
response: nil,
|
40
|
+
message: nil
|
41
|
+
)
|
42
|
+
end
|
43
|
+
end
|
44
|
+
|
45
|
+
class APIConnectionError < Knockapi::Errors::APIError
|
46
|
+
sig { void }
|
47
|
+
attr_accessor :status
|
48
|
+
|
49
|
+
sig { void }
|
50
|
+
attr_accessor :body
|
51
|
+
|
52
|
+
# @api private
|
53
|
+
sig do
|
54
|
+
params(
|
55
|
+
url: URI::Generic,
|
56
|
+
status: NilClass,
|
57
|
+
body: NilClass,
|
58
|
+
request: NilClass,
|
59
|
+
response: NilClass,
|
60
|
+
message: T.nilable(String)
|
61
|
+
).returns(T.attached_class)
|
62
|
+
end
|
63
|
+
def self.new(
|
64
|
+
url:,
|
65
|
+
status: nil,
|
66
|
+
body: nil,
|
67
|
+
request: nil,
|
68
|
+
response: nil,
|
69
|
+
message: "Connection error."
|
70
|
+
)
|
71
|
+
end
|
72
|
+
end
|
73
|
+
|
74
|
+
class APITimeoutError < Knockapi::Errors::APIConnectionError
|
75
|
+
# @api private
|
76
|
+
sig do
|
77
|
+
params(
|
78
|
+
url: URI::Generic,
|
79
|
+
status: NilClass,
|
80
|
+
body: NilClass,
|
81
|
+
request: NilClass,
|
82
|
+
response: NilClass,
|
83
|
+
message: T.nilable(String)
|
84
|
+
).returns(T.attached_class)
|
85
|
+
end
|
86
|
+
def self.new(
|
87
|
+
url:,
|
88
|
+
status: nil,
|
89
|
+
body: nil,
|
90
|
+
request: nil,
|
91
|
+
response: nil,
|
92
|
+
message: "Request timed out."
|
93
|
+
)
|
94
|
+
end
|
95
|
+
end
|
96
|
+
|
97
|
+
class APIStatusError < Knockapi::Errors::APIError
|
98
|
+
# @api private
|
99
|
+
sig do
|
100
|
+
params(
|
101
|
+
url: URI::Generic,
|
102
|
+
status: Integer,
|
103
|
+
body: T.nilable(Object),
|
104
|
+
request: NilClass,
|
105
|
+
response: NilClass,
|
106
|
+
message: T.nilable(String)
|
107
|
+
).returns(T.attached_class)
|
108
|
+
end
|
109
|
+
def self.for(url:, status:, body:, request:, response:, message: nil)
|
110
|
+
end
|
111
|
+
|
112
|
+
sig { returns(Integer) }
|
113
|
+
attr_accessor :status
|
114
|
+
|
115
|
+
# @api private
|
116
|
+
sig do
|
117
|
+
params(
|
118
|
+
url: URI::Generic,
|
119
|
+
status: Integer,
|
120
|
+
body: T.nilable(Object),
|
121
|
+
request: NilClass,
|
122
|
+
response: NilClass,
|
123
|
+
message: T.nilable(String)
|
124
|
+
).returns(T.attached_class)
|
125
|
+
end
|
126
|
+
def self.new(url:, status:, body:, request:, response:, message: nil)
|
127
|
+
end
|
128
|
+
end
|
129
|
+
|
130
|
+
class BadRequestError < Knockapi::Errors::APIStatusError
|
131
|
+
HTTP_STATUS = 400
|
132
|
+
end
|
133
|
+
|
134
|
+
class AuthenticationError < Knockapi::Errors::APIStatusError
|
135
|
+
HTTP_STATUS = 401
|
136
|
+
end
|
137
|
+
|
138
|
+
class PermissionDeniedError < Knockapi::Errors::APIStatusError
|
139
|
+
HTTP_STATUS = 403
|
140
|
+
end
|
141
|
+
|
142
|
+
class NotFoundError < Knockapi::Errors::APIStatusError
|
143
|
+
HTTP_STATUS = 404
|
144
|
+
end
|
145
|
+
|
146
|
+
class ConflictError < Knockapi::Errors::APIStatusError
|
147
|
+
HTTP_STATUS = 409
|
148
|
+
end
|
149
|
+
|
150
|
+
class UnprocessableEntityError < Knockapi::Errors::APIStatusError
|
151
|
+
HTTP_STATUS = 422
|
152
|
+
end
|
153
|
+
|
154
|
+
class RateLimitError < Knockapi::Errors::APIStatusError
|
155
|
+
HTTP_STATUS = 429
|
156
|
+
end
|
157
|
+
|
158
|
+
class InternalServerError < Knockapi::Errors::APIStatusError
|
159
|
+
HTTP_STATUS = T.let((500..), T::Range[Integer])
|
160
|
+
end
|
161
|
+
end
|
162
|
+
end
|
@@ -0,0 +1,37 @@
|
|
1
|
+
# typed: strong
|
2
|
+
|
3
|
+
module Knockapi
|
4
|
+
class FilePart
|
5
|
+
sig { returns(T.any(Pathname, StringIO, IO, String)) }
|
6
|
+
attr_reader :content
|
7
|
+
|
8
|
+
sig { returns(T.nilable(String)) }
|
9
|
+
attr_reader :content_type
|
10
|
+
|
11
|
+
sig { returns(T.nilable(String)) }
|
12
|
+
attr_reader :filename
|
13
|
+
|
14
|
+
# @api private
|
15
|
+
sig { returns(String) }
|
16
|
+
private def read
|
17
|
+
end
|
18
|
+
|
19
|
+
sig { params(a: T.anything).returns(String) }
|
20
|
+
def to_json(*a)
|
21
|
+
end
|
22
|
+
|
23
|
+
sig { params(a: T.anything).returns(String) }
|
24
|
+
def to_yaml(*a)
|
25
|
+
end
|
26
|
+
|
27
|
+
sig do
|
28
|
+
params(
|
29
|
+
content: T.any(Pathname, StringIO, IO, String),
|
30
|
+
filename: T.nilable(String),
|
31
|
+
content_type: T.nilable(String)
|
32
|
+
).returns(T.attached_class)
|
33
|
+
end
|
34
|
+
def self.new(content, filename: nil, content_type: nil)
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
@@ -0,0 +1,40 @@
|
|
1
|
+
# typed: strong
|
2
|
+
|
3
|
+
module Knockapi
|
4
|
+
module Internal
|
5
|
+
class EntriesCursor
|
6
|
+
include Knockapi::Internal::Type::BasePage
|
7
|
+
|
8
|
+
Elem = type_member
|
9
|
+
|
10
|
+
sig { returns(T.nilable(T::Array[Elem])) }
|
11
|
+
attr_accessor :entries
|
12
|
+
|
13
|
+
sig { returns(PageInfo) }
|
14
|
+
attr_accessor :page_info
|
15
|
+
|
16
|
+
# @api private
|
17
|
+
sig { returns(String) }
|
18
|
+
def inspect
|
19
|
+
end
|
20
|
+
|
21
|
+
class PageInfo < Knockapi::Internal::Type::BaseModel
|
22
|
+
OrHash = T.type_alias { T.any(PageInfo, Knockapi::Internal::AnyHash) }
|
23
|
+
|
24
|
+
sig { returns(T.nilable(String)) }
|
25
|
+
attr_reader :after
|
26
|
+
|
27
|
+
sig { params(after: String).void }
|
28
|
+
attr_writer :after
|
29
|
+
|
30
|
+
sig { params(after: String).returns(T.attached_class) }
|
31
|
+
def self.new(after: nil)
|
32
|
+
end
|
33
|
+
|
34
|
+
sig { override.returns({ after: String }) }
|
35
|
+
def to_hash
|
36
|
+
end
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|
40
|
+
end
|
@@ -0,0 +1,40 @@
|
|
1
|
+
# typed: strong
|
2
|
+
|
3
|
+
module Knockapi
|
4
|
+
module Internal
|
5
|
+
class ItemsCursor
|
6
|
+
include Knockapi::Internal::Type::BasePage
|
7
|
+
|
8
|
+
Elem = type_member
|
9
|
+
|
10
|
+
sig { returns(T.nilable(T::Array[Elem])) }
|
11
|
+
attr_accessor :items
|
12
|
+
|
13
|
+
sig { returns(PageInfo) }
|
14
|
+
attr_accessor :page_info
|
15
|
+
|
16
|
+
# @api private
|
17
|
+
sig { returns(String) }
|
18
|
+
def inspect
|
19
|
+
end
|
20
|
+
|
21
|
+
class PageInfo < Knockapi::Internal::Type::BaseModel
|
22
|
+
OrHash = T.type_alias { T.any(PageInfo, Knockapi::Internal::AnyHash) }
|
23
|
+
|
24
|
+
sig { returns(T.nilable(String)) }
|
25
|
+
attr_reader :after
|
26
|
+
|
27
|
+
sig { params(after: String).void }
|
28
|
+
attr_writer :after
|
29
|
+
|
30
|
+
sig { params(after: String).returns(T.attached_class) }
|
31
|
+
def self.new(after: nil)
|
32
|
+
end
|
33
|
+
|
34
|
+
sig { override.returns({ after: String }) }
|
35
|
+
def to_hash
|
36
|
+
end
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|
40
|
+
end
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# typed: strong
|
2
|
+
|
3
|
+
module Knockapi
|
4
|
+
module Internal
|
5
|
+
class MsTeamsPagination
|
6
|
+
include Knockapi::Internal::Type::BasePage
|
7
|
+
|
8
|
+
Elem = type_member
|
9
|
+
|
10
|
+
sig { returns(String) }
|
11
|
+
attr_accessor :skip_token
|
12
|
+
|
13
|
+
sig { returns(T.nilable(T::Array[Elem])) }
|
14
|
+
attr_accessor :ms_teams_teams
|
15
|
+
|
16
|
+
# @api private
|
17
|
+
sig { returns(String) }
|
18
|
+
def inspect
|
19
|
+
end
|
20
|
+
end
|
21
|
+
end
|
22
|
+
end
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# typed: strong
|
2
|
+
|
3
|
+
module Knockapi
|
4
|
+
module Internal
|
5
|
+
class SlackChannelsCursor
|
6
|
+
include Knockapi::Internal::Type::BasePage
|
7
|
+
|
8
|
+
Elem = type_member
|
9
|
+
|
10
|
+
sig { returns(String) }
|
11
|
+
attr_accessor :next_cursor
|
12
|
+
|
13
|
+
sig { returns(T.nilable(T::Array[Elem])) }
|
14
|
+
attr_accessor :slack_channels
|
15
|
+
|
16
|
+
# @api private
|
17
|
+
sig { returns(String) }
|
18
|
+
def inspect
|
19
|
+
end
|
20
|
+
end
|
21
|
+
end
|
22
|
+
end
|