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,504 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Knockapi
|
4
|
+
module Models
|
5
|
+
module Messages
|
6
|
+
class BatchGetContentResponseItem < Knockapi::Internal::Type::BaseModel
|
7
|
+
# @!attribute _typename
|
8
|
+
# The typename of the schema.
|
9
|
+
#
|
10
|
+
# @return [String]
|
11
|
+
required :_typename, String, api_name: :__typename
|
12
|
+
|
13
|
+
# @!attribute data
|
14
|
+
# Content data specific to the channel type.
|
15
|
+
#
|
16
|
+
# @return [Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageEmailContent, Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageSMSContent, Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessagePushContent, Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent, Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent]
|
17
|
+
required :data, union: -> { Knockapi::Models::Messages::BatchGetContentResponseItem::Data }
|
18
|
+
|
19
|
+
# @!attribute inserted_at
|
20
|
+
# Timestamp when the message content was created.
|
21
|
+
#
|
22
|
+
# @return [Time]
|
23
|
+
required :inserted_at, Time
|
24
|
+
|
25
|
+
# @!attribute message_id
|
26
|
+
# The unique identifier for the message content.
|
27
|
+
#
|
28
|
+
# @return [String]
|
29
|
+
required :message_id, String
|
30
|
+
|
31
|
+
# @!method initialize(_typename:, data:, inserted_at:, message_id:)
|
32
|
+
# The content of a message.
|
33
|
+
#
|
34
|
+
# @param _typename [String] The typename of the schema.
|
35
|
+
#
|
36
|
+
# @param data [Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageEmailContent, Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageSMSContent, Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessagePushContent, Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent, Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent] Content data specific to the channel type.
|
37
|
+
#
|
38
|
+
# @param inserted_at [Time] Timestamp when the message content was created.
|
39
|
+
#
|
40
|
+
# @param message_id [String] The unique identifier for the message content.
|
41
|
+
|
42
|
+
# Content data specific to the channel type.
|
43
|
+
#
|
44
|
+
# @see Knockapi::Models::Messages::BatchGetContentResponseItem#data
|
45
|
+
module Data
|
46
|
+
extend Knockapi::Internal::Type::Union
|
47
|
+
|
48
|
+
# The content of an email message.
|
49
|
+
variant -> { Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageEmailContent }
|
50
|
+
|
51
|
+
# The content of an SMS message.
|
52
|
+
variant -> { Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageSMSContent }
|
53
|
+
|
54
|
+
# The content of a push notification.
|
55
|
+
variant -> { Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessagePushContent }
|
56
|
+
|
57
|
+
# The content of a chat message.
|
58
|
+
variant -> { Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent }
|
59
|
+
|
60
|
+
# The content of an in-app feed message.
|
61
|
+
variant -> { Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent }
|
62
|
+
|
63
|
+
class MessageEmailContent < Knockapi::Internal::Type::BaseModel
|
64
|
+
# @!attribute _typename
|
65
|
+
# The typename of the schema.
|
66
|
+
#
|
67
|
+
# @return [String]
|
68
|
+
required :_typename, String, api_name: :__typename
|
69
|
+
|
70
|
+
# @!attribute from
|
71
|
+
# The sender's email address.
|
72
|
+
#
|
73
|
+
# @return [String]
|
74
|
+
required :from, String
|
75
|
+
|
76
|
+
# @!attribute html_body
|
77
|
+
# The HTML body of the email message.
|
78
|
+
#
|
79
|
+
# @return [String]
|
80
|
+
required :html_body, String
|
81
|
+
|
82
|
+
# @!attribute subject_line
|
83
|
+
# The subject line of the email message.
|
84
|
+
#
|
85
|
+
# @return [String]
|
86
|
+
required :subject_line, String
|
87
|
+
|
88
|
+
# @!attribute text_body
|
89
|
+
# The text body of the email message.
|
90
|
+
#
|
91
|
+
# @return [String]
|
92
|
+
required :text_body, String
|
93
|
+
|
94
|
+
# @!attribute to
|
95
|
+
# The recipient's email address.
|
96
|
+
#
|
97
|
+
# @return [String]
|
98
|
+
required :to, String
|
99
|
+
|
100
|
+
# @!attribute bcc
|
101
|
+
# The BCC email addresses.
|
102
|
+
#
|
103
|
+
# @return [String, nil]
|
104
|
+
optional :bcc, String, nil?: true
|
105
|
+
|
106
|
+
# @!attribute cc
|
107
|
+
# The CC email addresses.
|
108
|
+
#
|
109
|
+
# @return [String, nil]
|
110
|
+
optional :cc, String, nil?: true
|
111
|
+
|
112
|
+
# @!attribute reply_to
|
113
|
+
# The reply-to email address.
|
114
|
+
#
|
115
|
+
# @return [String, nil]
|
116
|
+
optional :reply_to, String, nil?: true
|
117
|
+
|
118
|
+
# @!method initialize(_typename:, from:, html_body:, subject_line:, text_body:, to:, bcc: nil, cc: nil, reply_to: nil)
|
119
|
+
# The content of an email message.
|
120
|
+
#
|
121
|
+
# @param _typename [String] The typename of the schema.
|
122
|
+
#
|
123
|
+
# @param from [String] The sender's email address.
|
124
|
+
#
|
125
|
+
# @param html_body [String] The HTML body of the email message.
|
126
|
+
#
|
127
|
+
# @param subject_line [String] The subject line of the email message.
|
128
|
+
#
|
129
|
+
# @param text_body [String] The text body of the email message.
|
130
|
+
#
|
131
|
+
# @param to [String] The recipient's email address.
|
132
|
+
#
|
133
|
+
# @param bcc [String, nil] The BCC email addresses.
|
134
|
+
#
|
135
|
+
# @param cc [String, nil] The CC email addresses.
|
136
|
+
#
|
137
|
+
# @param reply_to [String, nil] The reply-to email address.
|
138
|
+
end
|
139
|
+
|
140
|
+
class MessageSMSContent < Knockapi::Internal::Type::BaseModel
|
141
|
+
# @!attribute _typename
|
142
|
+
# The typename of the schema.
|
143
|
+
#
|
144
|
+
# @return [String]
|
145
|
+
required :_typename, String, api_name: :__typename
|
146
|
+
|
147
|
+
# @!attribute body
|
148
|
+
# The content body of the SMS message.
|
149
|
+
#
|
150
|
+
# @return [String]
|
151
|
+
required :body, String
|
152
|
+
|
153
|
+
# @!attribute to
|
154
|
+
# The phone number the SMS was sent to.
|
155
|
+
#
|
156
|
+
# @return [String]
|
157
|
+
required :to, String
|
158
|
+
|
159
|
+
# @!method initialize(_typename:, body:, to:)
|
160
|
+
# The content of an SMS message.
|
161
|
+
#
|
162
|
+
# @param _typename [String] The typename of the schema.
|
163
|
+
#
|
164
|
+
# @param body [String] The content body of the SMS message.
|
165
|
+
#
|
166
|
+
# @param to [String] The phone number the SMS was sent to.
|
167
|
+
end
|
168
|
+
|
169
|
+
class MessagePushContent < Knockapi::Internal::Type::BaseModel
|
170
|
+
# @!attribute token
|
171
|
+
# The device token to send the push notification to.
|
172
|
+
#
|
173
|
+
# @return [String]
|
174
|
+
required :token, String
|
175
|
+
|
176
|
+
# @!attribute _typename
|
177
|
+
# The typename of the schema.
|
178
|
+
#
|
179
|
+
# @return [String]
|
180
|
+
required :_typename, String, api_name: :__typename
|
181
|
+
|
182
|
+
# @!attribute body
|
183
|
+
# The content body of the push notification.
|
184
|
+
#
|
185
|
+
# @return [String]
|
186
|
+
required :body, String
|
187
|
+
|
188
|
+
# @!attribute title
|
189
|
+
# The title of the push notification.
|
190
|
+
#
|
191
|
+
# @return [String]
|
192
|
+
required :title, String
|
193
|
+
|
194
|
+
# @!attribute data
|
195
|
+
# Additional data payload for the push notification.
|
196
|
+
#
|
197
|
+
# @return [Hash{Symbol=>Object}, nil]
|
198
|
+
optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
|
199
|
+
|
200
|
+
# @!method initialize(token:, _typename:, body:, title:, data: nil)
|
201
|
+
# The content of a push notification.
|
202
|
+
#
|
203
|
+
# @param token [String] The device token to send the push notification to.
|
204
|
+
#
|
205
|
+
# @param _typename [String] The typename of the schema.
|
206
|
+
#
|
207
|
+
# @param body [String] The content body of the push notification.
|
208
|
+
#
|
209
|
+
# @param title [String] The title of the push notification.
|
210
|
+
#
|
211
|
+
# @param data [Hash{Symbol=>Object}, nil] Additional data payload for the push notification.
|
212
|
+
end
|
213
|
+
|
214
|
+
class MessageChatContent < Knockapi::Internal::Type::BaseModel
|
215
|
+
# @!attribute _typename
|
216
|
+
# The typename of the schema.
|
217
|
+
#
|
218
|
+
# @return [String]
|
219
|
+
required :_typename, String, api_name: :__typename
|
220
|
+
|
221
|
+
# @!attribute connection
|
222
|
+
# The channel data connection from the recipient to the underlying provider.
|
223
|
+
#
|
224
|
+
# @return [Hash{Symbol=>Object}]
|
225
|
+
required :connection, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]
|
226
|
+
|
227
|
+
# @!attribute template
|
228
|
+
# The template structure for the chat message.
|
229
|
+
#
|
230
|
+
# @return [Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent::Template]
|
231
|
+
required :template,
|
232
|
+
-> { Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent::Template }
|
233
|
+
|
234
|
+
# @!attribute metadata
|
235
|
+
# Additional metadata associated with the chat message.
|
236
|
+
#
|
237
|
+
# @return [Hash{Symbol=>Object}, nil]
|
238
|
+
optional :metadata,
|
239
|
+
Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown],
|
240
|
+
nil?: true
|
241
|
+
|
242
|
+
# @!method initialize(_typename:, connection:, template:, metadata: nil)
|
243
|
+
# The content of a chat message.
|
244
|
+
#
|
245
|
+
# @param _typename [String] The typename of the schema.
|
246
|
+
#
|
247
|
+
# @param connection [Hash{Symbol=>Object}] The channel data connection from the recipient to the underlying provider.
|
248
|
+
#
|
249
|
+
# @param template [Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent::Template] The template structure for the chat message.
|
250
|
+
#
|
251
|
+
# @param metadata [Hash{Symbol=>Object}, nil] Additional metadata associated with the chat message.
|
252
|
+
|
253
|
+
# @see Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent#template
|
254
|
+
class Template < Knockapi::Internal::Type::BaseModel
|
255
|
+
# @!attribute blocks
|
256
|
+
# The blocks of the message in a chat.
|
257
|
+
#
|
258
|
+
# @return [Array<Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent::Template::Block>, nil]
|
259
|
+
optional :blocks,
|
260
|
+
-> { Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent::Template::Block] },
|
261
|
+
nil?: true
|
262
|
+
|
263
|
+
# @!attribute json_content
|
264
|
+
# The JSON content of the message.
|
265
|
+
#
|
266
|
+
# @return [Hash{Symbol=>Object}, nil]
|
267
|
+
optional :json_content,
|
268
|
+
Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown],
|
269
|
+
nil?: true
|
270
|
+
|
271
|
+
# @!attribute summary
|
272
|
+
# The summary of the chat message.
|
273
|
+
#
|
274
|
+
# @return [String, nil]
|
275
|
+
optional :summary, String, nil?: true
|
276
|
+
|
277
|
+
# @!method initialize(blocks: nil, json_content: nil, summary: nil)
|
278
|
+
# The template structure for the chat message.
|
279
|
+
#
|
280
|
+
# @param blocks [Array<Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent::Template::Block>, nil] The blocks of the message in a chat.
|
281
|
+
#
|
282
|
+
# @param json_content [Hash{Symbol=>Object}, nil] The JSON content of the message.
|
283
|
+
#
|
284
|
+
# @param summary [String, nil] The summary of the chat message.
|
285
|
+
|
286
|
+
class Block < Knockapi::Internal::Type::BaseModel
|
287
|
+
# @!attribute content
|
288
|
+
# The actual content of the block.
|
289
|
+
#
|
290
|
+
# @return [String]
|
291
|
+
required :content, String
|
292
|
+
|
293
|
+
# @!attribute name
|
294
|
+
# The name of the block for identification.
|
295
|
+
#
|
296
|
+
# @return [String]
|
297
|
+
required :name, String
|
298
|
+
|
299
|
+
# @!attribute type
|
300
|
+
# The type of block in a message in a chat (text or markdown).
|
301
|
+
#
|
302
|
+
# @return [Symbol, Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent::Template::Block::Type]
|
303
|
+
required :type,
|
304
|
+
enum: -> { Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent::Template::Block::Type }
|
305
|
+
|
306
|
+
# @!method initialize(content:, name:, type:)
|
307
|
+
# A block in a message in a chat.
|
308
|
+
#
|
309
|
+
# @param content [String] The actual content of the block.
|
310
|
+
#
|
311
|
+
# @param name [String] The name of the block for identification.
|
312
|
+
#
|
313
|
+
# @param type [Symbol, Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent::Template::Block::Type] The type of block in a message in a chat (text or markdown).
|
314
|
+
|
315
|
+
# The type of block in a message in a chat (text or markdown).
|
316
|
+
#
|
317
|
+
# @see Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent::Template::Block#type
|
318
|
+
module Type
|
319
|
+
extend Knockapi::Internal::Type::Enum
|
320
|
+
|
321
|
+
TEXT = :text
|
322
|
+
MARKDOWN = :markdown
|
323
|
+
|
324
|
+
# @!method self.values
|
325
|
+
# @return [Array<Symbol>]
|
326
|
+
end
|
327
|
+
end
|
328
|
+
end
|
329
|
+
end
|
330
|
+
|
331
|
+
class MessageInAppFeedContent < Knockapi::Internal::Type::BaseModel
|
332
|
+
# @!attribute _typename
|
333
|
+
# The typename of the schema.
|
334
|
+
#
|
335
|
+
# @return [String]
|
336
|
+
required :_typename, String, api_name: :__typename
|
337
|
+
|
338
|
+
# @!attribute blocks
|
339
|
+
# The blocks of the message in an app feed.
|
340
|
+
#
|
341
|
+
# @return [Array<Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock, Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock>]
|
342
|
+
required :blocks,
|
343
|
+
-> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block] }
|
344
|
+
|
345
|
+
# @!method initialize(_typename:, blocks:)
|
346
|
+
# The content of an in-app feed message.
|
347
|
+
#
|
348
|
+
# @param _typename [String] The typename of the schema.
|
349
|
+
#
|
350
|
+
# @param blocks [Array<Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock, Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock>] The blocks of the message in an app feed.
|
351
|
+
|
352
|
+
# A block in a message in an app feed.
|
353
|
+
module Block
|
354
|
+
extend Knockapi::Internal::Type::Union
|
355
|
+
|
356
|
+
# A block in a message in an app feed.
|
357
|
+
variant -> { Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock }
|
358
|
+
|
359
|
+
# A button set block in a message in an app feed.
|
360
|
+
variant -> { Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock }
|
361
|
+
|
362
|
+
class MessageInAppFeedContentBlock < Knockapi::Internal::Type::BaseModel
|
363
|
+
# @!attribute content
|
364
|
+
# The content of the block in a message in an app feed.
|
365
|
+
#
|
366
|
+
# @return [String]
|
367
|
+
required :content, String
|
368
|
+
|
369
|
+
# @!attribute name
|
370
|
+
# The name of the block in a message in an app feed.
|
371
|
+
#
|
372
|
+
# @return [String]
|
373
|
+
required :name, String
|
374
|
+
|
375
|
+
# @!attribute rendered
|
376
|
+
# The rendered HTML version of the content.
|
377
|
+
#
|
378
|
+
# @return [String]
|
379
|
+
required :rendered, String
|
380
|
+
|
381
|
+
# @!attribute type
|
382
|
+
# The type of block in a message in an app feed.
|
383
|
+
#
|
384
|
+
# @return [Symbol, Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock::Type]
|
385
|
+
required :type,
|
386
|
+
enum: -> { Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock::Type }
|
387
|
+
|
388
|
+
# @!method initialize(content:, name:, rendered:, type:)
|
389
|
+
# A block in a message in an app feed.
|
390
|
+
#
|
391
|
+
# @param content [String] The content of the block in a message in an app feed.
|
392
|
+
#
|
393
|
+
# @param name [String] The name of the block in a message in an app feed.
|
394
|
+
#
|
395
|
+
# @param rendered [String] The rendered HTML version of the content.
|
396
|
+
#
|
397
|
+
# @param type [Symbol, Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock::Type] The type of block in a message in an app feed.
|
398
|
+
|
399
|
+
# The type of block in a message in an app feed.
|
400
|
+
#
|
401
|
+
# @see Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock#type
|
402
|
+
module Type
|
403
|
+
extend Knockapi::Internal::Type::Enum
|
404
|
+
|
405
|
+
MARKDOWN = :markdown
|
406
|
+
TEXT = :text
|
407
|
+
|
408
|
+
# @!method self.values
|
409
|
+
# @return [Array<Symbol>]
|
410
|
+
end
|
411
|
+
end
|
412
|
+
|
413
|
+
class MessageInAppFeedButtonSetBlock < Knockapi::Internal::Type::BaseModel
|
414
|
+
# @!attribute buttons
|
415
|
+
# A list of buttons in an in app feed message.
|
416
|
+
#
|
417
|
+
# @return [Array<Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::Button>]
|
418
|
+
required :buttons,
|
419
|
+
-> do
|
420
|
+
Knockapi::Internal::Type::ArrayOf[
|
421
|
+
Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::Button
|
422
|
+
]
|
423
|
+
end
|
424
|
+
|
425
|
+
# @!attribute name
|
426
|
+
# The name of the button set in a message in an app feed.
|
427
|
+
#
|
428
|
+
# @return [String]
|
429
|
+
required :name, String
|
430
|
+
|
431
|
+
# @!attribute type
|
432
|
+
# The type of block in a message in an app feed.
|
433
|
+
#
|
434
|
+
# @return [Symbol, Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::Type]
|
435
|
+
required :type,
|
436
|
+
enum: -> { Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::Type }
|
437
|
+
|
438
|
+
# @!method initialize(buttons:, name:, type:)
|
439
|
+
# A button set block in a message in an app feed.
|
440
|
+
#
|
441
|
+
# @param buttons [Array<Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::Button>] A list of buttons in an in app feed message.
|
442
|
+
#
|
443
|
+
# @param name [String] The name of the button set in a message in an app feed.
|
444
|
+
#
|
445
|
+
# @param type [Symbol, Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::Type] The type of block in a message in an app feed.
|
446
|
+
|
447
|
+
class Button < Knockapi::Internal::Type::BaseModel
|
448
|
+
# @!attribute action
|
449
|
+
# The action to take when the button is clicked.
|
450
|
+
#
|
451
|
+
# @return [String]
|
452
|
+
required :action, String
|
453
|
+
|
454
|
+
# @!attribute label
|
455
|
+
# The label of the button.
|
456
|
+
#
|
457
|
+
# @return [String]
|
458
|
+
required :label, String
|
459
|
+
|
460
|
+
# @!attribute name
|
461
|
+
# The name of the button.
|
462
|
+
#
|
463
|
+
# @return [String]
|
464
|
+
required :name, String
|
465
|
+
|
466
|
+
# @!method initialize(action:, label:, name:)
|
467
|
+
# A button in an in app feed message.
|
468
|
+
#
|
469
|
+
# @param action [String] The action to take when the button is clicked.
|
470
|
+
#
|
471
|
+
# @param label [String] The label of the button.
|
472
|
+
#
|
473
|
+
# @param name [String] The name of the button.
|
474
|
+
end
|
475
|
+
|
476
|
+
# The type of block in a message in an app feed.
|
477
|
+
#
|
478
|
+
# @see Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock#type
|
479
|
+
module Type
|
480
|
+
extend Knockapi::Internal::Type::Enum
|
481
|
+
|
482
|
+
BUTTON_SET = :button_set
|
483
|
+
|
484
|
+
# @!method self.values
|
485
|
+
# @return [Array<Symbol>]
|
486
|
+
end
|
487
|
+
end
|
488
|
+
|
489
|
+
# @!method self.variants
|
490
|
+
# @return [Array(Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock, Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock)]
|
491
|
+
end
|
492
|
+
end
|
493
|
+
|
494
|
+
# @!method self.variants
|
495
|
+
# @return [Array(Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageEmailContent, Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageSMSContent, Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessagePushContent, Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent, Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent)]
|
496
|
+
end
|
497
|
+
end
|
498
|
+
|
499
|
+
# @type [Knockapi::Internal::Type::Converter]
|
500
|
+
BatchGetContentResponse =
|
501
|
+
Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Models::Messages::BatchGetContentResponseItem }]
|
502
|
+
end
|
503
|
+
end
|
504
|
+
end
|
@@ -0,0 +1,32 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Knockapi
|
4
|
+
module Models
|
5
|
+
module Messages
|
6
|
+
# @see Knockapi::Resources::Messages::Batch#mark_as_interacted
|
7
|
+
class BatchMarkAsInteractedParams < Knockapi::Internal::Type::BaseModel
|
8
|
+
extend Knockapi::Internal::Type::RequestParameters::Converter
|
9
|
+
include Knockapi::Internal::Type::RequestParameters
|
10
|
+
|
11
|
+
# @!attribute message_ids
|
12
|
+
# The message IDs to batch mark as interacted with.
|
13
|
+
#
|
14
|
+
# @return [Array<String>]
|
15
|
+
required :message_ids, Knockapi::Internal::Type::ArrayOf[String]
|
16
|
+
|
17
|
+
# @!attribute metadata
|
18
|
+
# Metadata about the interaction.
|
19
|
+
#
|
20
|
+
# @return [Hash{Symbol=>Object}, nil]
|
21
|
+
optional :metadata, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
|
22
|
+
|
23
|
+
# @!method initialize(message_ids:, metadata: nil, request_options: {})
|
24
|
+
# @param message_ids [Array<String>] The message IDs to batch mark as interacted with.
|
25
|
+
#
|
26
|
+
# @param metadata [Hash{Symbol=>Object}, nil] Metadata about the interaction.
|
27
|
+
#
|
28
|
+
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
29
|
+
end
|
30
|
+
end
|
31
|
+
end
|
32
|
+
end
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Knockapi
|
4
|
+
module Models
|
5
|
+
module Messages
|
6
|
+
# @see Knockapi::Resources::Messages::Batch#mark_as_read
|
7
|
+
class BatchMarkAsReadParams < Knockapi::Internal::Type::BaseModel
|
8
|
+
extend Knockapi::Internal::Type::RequestParameters::Converter
|
9
|
+
include Knockapi::Internal::Type::RequestParameters
|
10
|
+
|
11
|
+
# @!attribute message_ids
|
12
|
+
# The message IDs to update the status of.
|
13
|
+
#
|
14
|
+
# @return [Array<String>]
|
15
|
+
required :message_ids, Knockapi::Internal::Type::ArrayOf[String]
|
16
|
+
|
17
|
+
# @!method initialize(message_ids:, request_options: {})
|
18
|
+
# @param message_ids [Array<String>] The message IDs to update the status of.
|
19
|
+
#
|
20
|
+
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Knockapi
|
4
|
+
module Models
|
5
|
+
module Messages
|
6
|
+
# @see Knockapi::Resources::Messages::Batch#mark_as_seen
|
7
|
+
class BatchMarkAsSeenParams < Knockapi::Internal::Type::BaseModel
|
8
|
+
extend Knockapi::Internal::Type::RequestParameters::Converter
|
9
|
+
include Knockapi::Internal::Type::RequestParameters
|
10
|
+
|
11
|
+
# @!attribute message_ids
|
12
|
+
# The message IDs to update the status of.
|
13
|
+
#
|
14
|
+
# @return [Array<String>]
|
15
|
+
required :message_ids, Knockapi::Internal::Type::ArrayOf[String]
|
16
|
+
|
17
|
+
# @!method initialize(message_ids:, request_options: {})
|
18
|
+
# @param message_ids [Array<String>] The message IDs to update the status of.
|
19
|
+
#
|
20
|
+
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Knockapi
|
4
|
+
module Models
|
5
|
+
module Messages
|
6
|
+
# @see Knockapi::Resources::Messages::Batch#mark_as_unread
|
7
|
+
class BatchMarkAsUnreadParams < Knockapi::Internal::Type::BaseModel
|
8
|
+
extend Knockapi::Internal::Type::RequestParameters::Converter
|
9
|
+
include Knockapi::Internal::Type::RequestParameters
|
10
|
+
|
11
|
+
# @!attribute message_ids
|
12
|
+
# The message IDs to update the status of.
|
13
|
+
#
|
14
|
+
# @return [Array<String>]
|
15
|
+
required :message_ids, Knockapi::Internal::Type::ArrayOf[String]
|
16
|
+
|
17
|
+
# @!method initialize(message_ids:, request_options: {})
|
18
|
+
# @param message_ids [Array<String>] The message IDs to update the status of.
|
19
|
+
#
|
20
|
+
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Knockapi
|
4
|
+
module Models
|
5
|
+
module Messages
|
6
|
+
# @see Knockapi::Resources::Messages::Batch#mark_as_unseen
|
7
|
+
class BatchMarkAsUnseenParams < Knockapi::Internal::Type::BaseModel
|
8
|
+
extend Knockapi::Internal::Type::RequestParameters::Converter
|
9
|
+
include Knockapi::Internal::Type::RequestParameters
|
10
|
+
|
11
|
+
# @!attribute message_ids
|
12
|
+
# The message IDs to update the status of.
|
13
|
+
#
|
14
|
+
# @return [Array<String>]
|
15
|
+
required :message_ids, Knockapi::Internal::Type::ArrayOf[String]
|
16
|
+
|
17
|
+
# @!method initialize(message_ids:, request_options: {})
|
18
|
+
# @param message_ids [Array<String>] The message IDs to update the status of.
|
19
|
+
#
|
20
|
+
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|