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,108 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Knockapi
|
4
|
+
module Models
|
5
|
+
module Recipients
|
6
|
+
class MsTeamsChannelData < Knockapi::Internal::Type::BaseModel
|
7
|
+
# @!attribute connections
|
8
|
+
# List of Microsoft Teams connections.
|
9
|
+
#
|
10
|
+
# @return [Array<Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsTokenConnection, Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection>]
|
11
|
+
required :connections,
|
12
|
+
-> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::Models::Recipients::MsTeamsChannelData::Connection] }
|
13
|
+
|
14
|
+
# @!attribute ms_teams_tenant_id
|
15
|
+
# Microsoft Teams tenant ID.
|
16
|
+
#
|
17
|
+
# @return [String, nil]
|
18
|
+
optional :ms_teams_tenant_id, String, nil?: true
|
19
|
+
|
20
|
+
# @!method initialize(connections:, ms_teams_tenant_id: nil)
|
21
|
+
# Microsoft Teams channel connection.
|
22
|
+
#
|
23
|
+
# @param connections [Array<Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsTokenConnection, Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection>] List of Microsoft Teams connections.
|
24
|
+
#
|
25
|
+
# @param ms_teams_tenant_id [String, nil] Microsoft Teams tenant ID.
|
26
|
+
|
27
|
+
# Microsoft Teams token connection.
|
28
|
+
module Connection
|
29
|
+
extend Knockapi::Internal::Type::Union
|
30
|
+
|
31
|
+
# Microsoft Teams token connection.
|
32
|
+
variant -> { Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsTokenConnection }
|
33
|
+
|
34
|
+
# Microsoft Teams incoming webhook connection.
|
35
|
+
variant -> { Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection }
|
36
|
+
|
37
|
+
class MsTeamsTokenConnection < Knockapi::Internal::Type::BaseModel
|
38
|
+
# @!attribute ms_teams_channel_id
|
39
|
+
# Microsoft Teams channel ID.
|
40
|
+
#
|
41
|
+
# @return [String, nil]
|
42
|
+
optional :ms_teams_channel_id, String, nil?: true
|
43
|
+
|
44
|
+
# @!attribute ms_teams_team_id
|
45
|
+
# Microsoft Teams team ID.
|
46
|
+
#
|
47
|
+
# @return [String, nil]
|
48
|
+
optional :ms_teams_team_id, String, nil?: true
|
49
|
+
|
50
|
+
# @!attribute ms_teams_tenant_id
|
51
|
+
# Microsoft Teams tenant ID.
|
52
|
+
#
|
53
|
+
# @return [String, nil]
|
54
|
+
optional :ms_teams_tenant_id, String, nil?: true
|
55
|
+
|
56
|
+
# @!attribute ms_teams_user_id
|
57
|
+
# Microsoft Teams user ID.
|
58
|
+
#
|
59
|
+
# @return [String, nil]
|
60
|
+
optional :ms_teams_user_id, String, nil?: true
|
61
|
+
|
62
|
+
# @!method initialize(ms_teams_channel_id: nil, ms_teams_team_id: nil, ms_teams_tenant_id: nil, ms_teams_user_id: nil)
|
63
|
+
# Microsoft Teams token connection.
|
64
|
+
#
|
65
|
+
# @param ms_teams_channel_id [String, nil] Microsoft Teams channel ID.
|
66
|
+
#
|
67
|
+
# @param ms_teams_team_id [String, nil] Microsoft Teams team ID.
|
68
|
+
#
|
69
|
+
# @param ms_teams_tenant_id [String, nil] Microsoft Teams tenant ID.
|
70
|
+
#
|
71
|
+
# @param ms_teams_user_id [String, nil] Microsoft Teams user ID.
|
72
|
+
end
|
73
|
+
|
74
|
+
class MsTeamsIncomingWebhookConnection < Knockapi::Internal::Type::BaseModel
|
75
|
+
# @!attribute incoming_webhook
|
76
|
+
# Microsoft Teams incoming webhook.
|
77
|
+
#
|
78
|
+
# @return [Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection::IncomingWebhook]
|
79
|
+
required :incoming_webhook,
|
80
|
+
-> { Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection::IncomingWebhook }
|
81
|
+
|
82
|
+
# @!method initialize(incoming_webhook:)
|
83
|
+
# Microsoft Teams incoming webhook connection.
|
84
|
+
#
|
85
|
+
# @param incoming_webhook [Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection::IncomingWebhook] Microsoft Teams incoming webhook.
|
86
|
+
|
87
|
+
# @see Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection#incoming_webhook
|
88
|
+
class IncomingWebhook < Knockapi::Internal::Type::BaseModel
|
89
|
+
# @!attribute url
|
90
|
+
# Microsoft Teams incoming webhook URL.
|
91
|
+
#
|
92
|
+
# @return [String]
|
93
|
+
required :url, String
|
94
|
+
|
95
|
+
# @!method initialize(url:)
|
96
|
+
# Microsoft Teams incoming webhook.
|
97
|
+
#
|
98
|
+
# @param url [String] Microsoft Teams incoming webhook URL.
|
99
|
+
end
|
100
|
+
end
|
101
|
+
|
102
|
+
# @!method self.variants
|
103
|
+
# @return [Array(Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsTokenConnection, Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection)]
|
104
|
+
end
|
105
|
+
end
|
106
|
+
end
|
107
|
+
end
|
108
|
+
end
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Knockapi
|
4
|
+
module Models
|
5
|
+
module Recipients
|
6
|
+
class OneSignalChannelData < Knockapi::Internal::Type::BaseModel
|
7
|
+
# @!attribute player_ids
|
8
|
+
# A list of OneSignal player IDs.
|
9
|
+
#
|
10
|
+
# @return [Array<String>]
|
11
|
+
required :player_ids, Knockapi::Internal::Type::ArrayOf[String]
|
12
|
+
|
13
|
+
# @!method initialize(player_ids:)
|
14
|
+
# OneSignal channel data.
|
15
|
+
#
|
16
|
+
# @param player_ids [Array<String>] A list of OneSignal player IDs.
|
17
|
+
end
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
@@ -0,0 +1,126 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Knockapi
|
4
|
+
module Models
|
5
|
+
module Recipients
|
6
|
+
class PreferenceSet < Knockapi::Internal::Type::BaseModel
|
7
|
+
# @!attribute id
|
8
|
+
# Unique identifier for the preference set.
|
9
|
+
#
|
10
|
+
# @return [String]
|
11
|
+
required :id, String
|
12
|
+
|
13
|
+
# @!attribute categories
|
14
|
+
# An object where the key is the category and the values are the preference
|
15
|
+
# settings for that category.
|
16
|
+
#
|
17
|
+
# @return [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject}, nil]
|
18
|
+
optional :categories,
|
19
|
+
-> { Knockapi::Internal::Type::HashOf[union: Knockapi::Models::Recipients::PreferenceSet::Category] },
|
20
|
+
nil?: true
|
21
|
+
|
22
|
+
# @!attribute channel_types
|
23
|
+
# Channel type preferences.
|
24
|
+
#
|
25
|
+
# @return [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil]
|
26
|
+
optional :channel_types, -> { Knockapi::Models::Recipients::PreferenceSetChannelTypes }, nil?: true
|
27
|
+
|
28
|
+
# @!attribute workflows
|
29
|
+
# An object where the key is the workflow key and the values are the preference
|
30
|
+
# settings for that workflow.
|
31
|
+
#
|
32
|
+
# @return [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject}, nil]
|
33
|
+
optional :workflows,
|
34
|
+
-> { Knockapi::Internal::Type::HashOf[union: Knockapi::Models::Recipients::PreferenceSet::Workflow] },
|
35
|
+
nil?: true
|
36
|
+
|
37
|
+
# @!method initialize(id:, categories: nil, channel_types: nil, workflows: nil)
|
38
|
+
# Some parameter documentations has been truncated, see
|
39
|
+
# {Knockapi::Models::Recipients::PreferenceSet} for more details.
|
40
|
+
#
|
41
|
+
# A preference set represents a specific set of notification preferences for a
|
42
|
+
# recipient. A recipient can have multiple preference sets.
|
43
|
+
#
|
44
|
+
# @param id [String] Unique identifier for the preference set.
|
45
|
+
#
|
46
|
+
# @param categories [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the category and the values are the preference settin
|
47
|
+
# ...
|
48
|
+
#
|
49
|
+
# @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
|
50
|
+
#
|
51
|
+
# @param workflows [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the workflow key and the values are the preference se
|
52
|
+
# ...
|
53
|
+
|
54
|
+
# Workflow or category preferences within a preference set
|
55
|
+
module Category
|
56
|
+
extend Knockapi::Internal::Type::Union
|
57
|
+
|
58
|
+
variant Knockapi::Internal::Type::Boolean
|
59
|
+
|
60
|
+
# The settings object for a workflow or category, where you can specify channel types or conditions.
|
61
|
+
variant -> { Knockapi::Models::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject }
|
62
|
+
|
63
|
+
class PreferenceSetWorkflowCategorySettingObject < Knockapi::Internal::Type::BaseModel
|
64
|
+
# @!attribute channel_types
|
65
|
+
# Channel type preferences.
|
66
|
+
#
|
67
|
+
# @return [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil]
|
68
|
+
optional :channel_types, -> { Knockapi::Models::Recipients::PreferenceSetChannelTypes }, nil?: true
|
69
|
+
|
70
|
+
# @!attribute conditions
|
71
|
+
# A list of conditions to apply to a channel type.
|
72
|
+
#
|
73
|
+
# @return [Array<Knockapi::Models::Condition>, nil]
|
74
|
+
optional :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Condition] }, nil?: true
|
75
|
+
|
76
|
+
# @!method initialize(channel_types: nil, conditions: nil)
|
77
|
+
# The settings object for a workflow or category, where you can specify channel
|
78
|
+
# types or conditions.
|
79
|
+
#
|
80
|
+
# @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
|
81
|
+
#
|
82
|
+
# @param conditions [Array<Knockapi::Models::Condition>, nil] A list of conditions to apply to a channel type.
|
83
|
+
end
|
84
|
+
|
85
|
+
# @!method self.variants
|
86
|
+
# @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject)]
|
87
|
+
end
|
88
|
+
|
89
|
+
# Workflow or category preferences within a preference set
|
90
|
+
module Workflow
|
91
|
+
extend Knockapi::Internal::Type::Union
|
92
|
+
|
93
|
+
variant Knockapi::Internal::Type::Boolean
|
94
|
+
|
95
|
+
# The settings object for a workflow or category, where you can specify channel types or conditions.
|
96
|
+
variant -> { Knockapi::Models::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject }
|
97
|
+
|
98
|
+
class PreferenceSetWorkflowCategorySettingObject < Knockapi::Internal::Type::BaseModel
|
99
|
+
# @!attribute channel_types
|
100
|
+
# Channel type preferences.
|
101
|
+
#
|
102
|
+
# @return [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil]
|
103
|
+
optional :channel_types, -> { Knockapi::Models::Recipients::PreferenceSetChannelTypes }, nil?: true
|
104
|
+
|
105
|
+
# @!attribute conditions
|
106
|
+
# A list of conditions to apply to a channel type.
|
107
|
+
#
|
108
|
+
# @return [Array<Knockapi::Models::Condition>, nil]
|
109
|
+
optional :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Condition] }, nil?: true
|
110
|
+
|
111
|
+
# @!method initialize(channel_types: nil, conditions: nil)
|
112
|
+
# The settings object for a workflow or category, where you can specify channel
|
113
|
+
# types or conditions.
|
114
|
+
#
|
115
|
+
# @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
|
116
|
+
#
|
117
|
+
# @param conditions [Array<Knockapi::Models::Condition>, nil] A list of conditions to apply to a channel type.
|
118
|
+
end
|
119
|
+
|
120
|
+
# @!method self.variants
|
121
|
+
# @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject)]
|
122
|
+
end
|
123
|
+
end
|
124
|
+
end
|
125
|
+
end
|
126
|
+
end
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Knockapi
|
4
|
+
module Models
|
5
|
+
module Recipients
|
6
|
+
class PreferenceSetChannelTypeSetting < Knockapi::Internal::Type::BaseModel
|
7
|
+
# @!attribute conditions
|
8
|
+
# A list of conditions to apply to a channel type.
|
9
|
+
#
|
10
|
+
# @return [Array<Knockapi::Models::Condition>]
|
11
|
+
required :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Condition] }
|
12
|
+
|
13
|
+
# @!method initialize(conditions:)
|
14
|
+
# A set of settings for a channel type. Currently, this can only be a list of
|
15
|
+
# conditions to apply.
|
16
|
+
#
|
17
|
+
# @param conditions [Array<Knockapi::Models::Condition>] A list of conditions to apply to a channel type.
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
21
|
+
end
|
@@ -0,0 +1,150 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Knockapi
|
4
|
+
module Models
|
5
|
+
module Recipients
|
6
|
+
class PreferenceSetChannelTypes < Knockapi::Internal::Type::BaseModel
|
7
|
+
# @!attribute chat
|
8
|
+
# Whether the channel type is enabled for the preference set.
|
9
|
+
#
|
10
|
+
# @return [Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting, nil]
|
11
|
+
optional :chat, union: -> { Knockapi::Models::Recipients::PreferenceSetChannelTypes::Chat }
|
12
|
+
|
13
|
+
# @!attribute email
|
14
|
+
# Whether the channel type is enabled for the preference set.
|
15
|
+
#
|
16
|
+
# @return [Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting, nil]
|
17
|
+
optional :email, union: -> { Knockapi::Models::Recipients::PreferenceSetChannelTypes::Email }
|
18
|
+
|
19
|
+
# @!attribute http
|
20
|
+
# Whether the channel type is enabled for the preference set.
|
21
|
+
#
|
22
|
+
# @return [Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting, nil]
|
23
|
+
optional :http, union: -> { Knockapi::Models::Recipients::PreferenceSetChannelTypes::HTTP }
|
24
|
+
|
25
|
+
# @!attribute in_app_feed
|
26
|
+
# Whether the channel type is enabled for the preference set.
|
27
|
+
#
|
28
|
+
# @return [Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting, nil]
|
29
|
+
optional :in_app_feed, union: -> { Knockapi::Models::Recipients::PreferenceSetChannelTypes::InAppFeed }
|
30
|
+
|
31
|
+
# @!attribute push
|
32
|
+
# Whether the channel type is enabled for the preference set.
|
33
|
+
#
|
34
|
+
# @return [Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting, nil]
|
35
|
+
optional :push, union: -> { Knockapi::Models::Recipients::PreferenceSetChannelTypes::Push }
|
36
|
+
|
37
|
+
# @!attribute sms
|
38
|
+
# Whether the channel type is enabled for the preference set.
|
39
|
+
#
|
40
|
+
# @return [Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting, nil]
|
41
|
+
optional :sms, union: -> { Knockapi::Models::Recipients::PreferenceSetChannelTypes::SMS }
|
42
|
+
|
43
|
+
# @!method initialize(chat: nil, email: nil, http: nil, in_app_feed: nil, push: nil, sms: nil)
|
44
|
+
# Channel type preferences.
|
45
|
+
#
|
46
|
+
# @param chat [Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
|
47
|
+
#
|
48
|
+
# @param email [Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
|
49
|
+
#
|
50
|
+
# @param http [Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
|
51
|
+
#
|
52
|
+
# @param in_app_feed [Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
|
53
|
+
#
|
54
|
+
# @param push [Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
|
55
|
+
#
|
56
|
+
# @param sms [Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
|
57
|
+
|
58
|
+
# Whether the channel type is enabled for the preference set.
|
59
|
+
#
|
60
|
+
# @see Knockapi::Models::Recipients::PreferenceSetChannelTypes#chat
|
61
|
+
module Chat
|
62
|
+
extend Knockapi::Internal::Type::Union
|
63
|
+
|
64
|
+
variant Knockapi::Internal::Type::Boolean
|
65
|
+
|
66
|
+
# A set of settings for a channel type. Currently, this can only be a list of conditions to apply.
|
67
|
+
variant -> { Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting }
|
68
|
+
|
69
|
+
# @!method self.variants
|
70
|
+
# @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting)]
|
71
|
+
end
|
72
|
+
|
73
|
+
# Whether the channel type is enabled for the preference set.
|
74
|
+
#
|
75
|
+
# @see Knockapi::Models::Recipients::PreferenceSetChannelTypes#email
|
76
|
+
module Email
|
77
|
+
extend Knockapi::Internal::Type::Union
|
78
|
+
|
79
|
+
variant Knockapi::Internal::Type::Boolean
|
80
|
+
|
81
|
+
# A set of settings for a channel type. Currently, this can only be a list of conditions to apply.
|
82
|
+
variant -> { Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting }
|
83
|
+
|
84
|
+
# @!method self.variants
|
85
|
+
# @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting)]
|
86
|
+
end
|
87
|
+
|
88
|
+
# Whether the channel type is enabled for the preference set.
|
89
|
+
#
|
90
|
+
# @see Knockapi::Models::Recipients::PreferenceSetChannelTypes#http
|
91
|
+
module HTTP
|
92
|
+
extend Knockapi::Internal::Type::Union
|
93
|
+
|
94
|
+
variant Knockapi::Internal::Type::Boolean
|
95
|
+
|
96
|
+
# A set of settings for a channel type. Currently, this can only be a list of conditions to apply.
|
97
|
+
variant -> { Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting }
|
98
|
+
|
99
|
+
# @!method self.variants
|
100
|
+
# @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting)]
|
101
|
+
end
|
102
|
+
|
103
|
+
# Whether the channel type is enabled for the preference set.
|
104
|
+
#
|
105
|
+
# @see Knockapi::Models::Recipients::PreferenceSetChannelTypes#in_app_feed
|
106
|
+
module InAppFeed
|
107
|
+
extend Knockapi::Internal::Type::Union
|
108
|
+
|
109
|
+
variant Knockapi::Internal::Type::Boolean
|
110
|
+
|
111
|
+
# A set of settings for a channel type. Currently, this can only be a list of conditions to apply.
|
112
|
+
variant -> { Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting }
|
113
|
+
|
114
|
+
# @!method self.variants
|
115
|
+
# @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting)]
|
116
|
+
end
|
117
|
+
|
118
|
+
# Whether the channel type is enabled for the preference set.
|
119
|
+
#
|
120
|
+
# @see Knockapi::Models::Recipients::PreferenceSetChannelTypes#push
|
121
|
+
module Push
|
122
|
+
extend Knockapi::Internal::Type::Union
|
123
|
+
|
124
|
+
variant Knockapi::Internal::Type::Boolean
|
125
|
+
|
126
|
+
# A set of settings for a channel type. Currently, this can only be a list of conditions to apply.
|
127
|
+
variant -> { Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting }
|
128
|
+
|
129
|
+
# @!method self.variants
|
130
|
+
# @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting)]
|
131
|
+
end
|
132
|
+
|
133
|
+
# Whether the channel type is enabled for the preference set.
|
134
|
+
#
|
135
|
+
# @see Knockapi::Models::Recipients::PreferenceSetChannelTypes#sms
|
136
|
+
module SMS
|
137
|
+
extend Knockapi::Internal::Type::Union
|
138
|
+
|
139
|
+
variant Knockapi::Internal::Type::Boolean
|
140
|
+
|
141
|
+
# A set of settings for a channel type. Currently, this can only be a list of conditions to apply.
|
142
|
+
variant -> { Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting }
|
143
|
+
|
144
|
+
# @!method self.variants
|
145
|
+
# @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting)]
|
146
|
+
end
|
147
|
+
end
|
148
|
+
end
|
149
|
+
end
|
150
|
+
end
|
@@ -0,0 +1,117 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Knockapi
|
4
|
+
module Models
|
5
|
+
module Recipients
|
6
|
+
class PreferenceSetRequest < Knockapi::Internal::Type::BaseModel
|
7
|
+
# @!attribute categories
|
8
|
+
# An object where the key is the category and the values are the preference
|
9
|
+
# settings for that category.
|
10
|
+
#
|
11
|
+
# @return [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject}, nil]
|
12
|
+
optional :categories,
|
13
|
+
-> { Knockapi::Internal::Type::HashOf[union: Knockapi::Models::Recipients::PreferenceSetRequest::Category] },
|
14
|
+
nil?: true
|
15
|
+
|
16
|
+
# @!attribute channel_types
|
17
|
+
# Channel type preferences.
|
18
|
+
#
|
19
|
+
# @return [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil]
|
20
|
+
optional :channel_types, -> { Knockapi::Models::Recipients::PreferenceSetChannelTypes }, nil?: true
|
21
|
+
|
22
|
+
# @!attribute workflows
|
23
|
+
# An object where the key is the workflow key and the values are the preference
|
24
|
+
# settings for that workflow.
|
25
|
+
#
|
26
|
+
# @return [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject}, nil]
|
27
|
+
optional :workflows,
|
28
|
+
-> { Knockapi::Internal::Type::HashOf[union: Knockapi::Models::Recipients::PreferenceSetRequest::Workflow] },
|
29
|
+
nil?: true
|
30
|
+
|
31
|
+
# @!method initialize(categories: nil, channel_types: nil, workflows: nil)
|
32
|
+
# Some parameter documentations has been truncated, see
|
33
|
+
# {Knockapi::Models::Recipients::PreferenceSetRequest} for more details.
|
34
|
+
#
|
35
|
+
# A request to set a preference set for a recipient.
|
36
|
+
#
|
37
|
+
# @param categories [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the category and the values are the preference settin
|
38
|
+
# ...
|
39
|
+
#
|
40
|
+
# @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
|
41
|
+
#
|
42
|
+
# @param workflows [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the workflow key and the values are the preference se
|
43
|
+
# ...
|
44
|
+
|
45
|
+
# Workflow or category preferences within a preference set
|
46
|
+
module Category
|
47
|
+
extend Knockapi::Internal::Type::Union
|
48
|
+
|
49
|
+
variant Knockapi::Internal::Type::Boolean
|
50
|
+
|
51
|
+
# The settings object for a workflow or category, where you can specify channel types or conditions.
|
52
|
+
variant -> { Knockapi::Models::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject }
|
53
|
+
|
54
|
+
class PreferenceSetWorkflowCategorySettingObject < Knockapi::Internal::Type::BaseModel
|
55
|
+
# @!attribute channel_types
|
56
|
+
# Channel type preferences.
|
57
|
+
#
|
58
|
+
# @return [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil]
|
59
|
+
optional :channel_types, -> { Knockapi::Models::Recipients::PreferenceSetChannelTypes }, nil?: true
|
60
|
+
|
61
|
+
# @!attribute conditions
|
62
|
+
# A list of conditions to apply to a channel type.
|
63
|
+
#
|
64
|
+
# @return [Array<Knockapi::Models::Condition>, nil]
|
65
|
+
optional :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Condition] }, nil?: true
|
66
|
+
|
67
|
+
# @!method initialize(channel_types: nil, conditions: nil)
|
68
|
+
# The settings object for a workflow or category, where you can specify channel
|
69
|
+
# types or conditions.
|
70
|
+
#
|
71
|
+
# @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
|
72
|
+
#
|
73
|
+
# @param conditions [Array<Knockapi::Models::Condition>, nil] A list of conditions to apply to a channel type.
|
74
|
+
end
|
75
|
+
|
76
|
+
# @!method self.variants
|
77
|
+
# @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject)]
|
78
|
+
end
|
79
|
+
|
80
|
+
# Workflow or category preferences within a preference set
|
81
|
+
module Workflow
|
82
|
+
extend Knockapi::Internal::Type::Union
|
83
|
+
|
84
|
+
variant Knockapi::Internal::Type::Boolean
|
85
|
+
|
86
|
+
# The settings object for a workflow or category, where you can specify channel types or conditions.
|
87
|
+
variant -> { Knockapi::Models::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject }
|
88
|
+
|
89
|
+
class PreferenceSetWorkflowCategorySettingObject < Knockapi::Internal::Type::BaseModel
|
90
|
+
# @!attribute channel_types
|
91
|
+
# Channel type preferences.
|
92
|
+
#
|
93
|
+
# @return [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil]
|
94
|
+
optional :channel_types, -> { Knockapi::Models::Recipients::PreferenceSetChannelTypes }, nil?: true
|
95
|
+
|
96
|
+
# @!attribute conditions
|
97
|
+
# A list of conditions to apply to a channel type.
|
98
|
+
#
|
99
|
+
# @return [Array<Knockapi::Models::Condition>, nil]
|
100
|
+
optional :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Condition] }, nil?: true
|
101
|
+
|
102
|
+
# @!method initialize(channel_types: nil, conditions: nil)
|
103
|
+
# The settings object for a workflow or category, where you can specify channel
|
104
|
+
# types or conditions.
|
105
|
+
#
|
106
|
+
# @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
|
107
|
+
#
|
108
|
+
# @param conditions [Array<Knockapi::Models::Condition>, nil] A list of conditions to apply to a channel type.
|
109
|
+
end
|
110
|
+
|
111
|
+
# @!method self.variants
|
112
|
+
# @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject)]
|
113
|
+
end
|
114
|
+
end
|
115
|
+
end
|
116
|
+
end
|
117
|
+
end
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Knockapi
|
4
|
+
module Models
|
5
|
+
module Recipients
|
6
|
+
class PushChannelData < Knockapi::Internal::Type::BaseModel
|
7
|
+
# @!attribute tokens
|
8
|
+
# A list of push channel tokens.
|
9
|
+
#
|
10
|
+
# @return [Array<String>]
|
11
|
+
required :tokens, Knockapi::Internal::Type::ArrayOf[String]
|
12
|
+
|
13
|
+
# @!method initialize(tokens:)
|
14
|
+
# The content of a push notification.
|
15
|
+
#
|
16
|
+
# @param tokens [Array<String>] A list of push channel tokens.
|
17
|
+
end
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
@@ -0,0 +1,99 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Knockapi
|
4
|
+
module Models
|
5
|
+
module Recipients
|
6
|
+
class SlackChannelData < Knockapi::Internal::Type::BaseModel
|
7
|
+
# @!attribute connections
|
8
|
+
# List of Slack channel connections.
|
9
|
+
#
|
10
|
+
# @return [Array<Knockapi::Models::Recipients::SlackChannelData::Connection::SlackTokenConnection, Knockapi::Models::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection>]
|
11
|
+
required :connections,
|
12
|
+
-> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::Models::Recipients::SlackChannelData::Connection] }
|
13
|
+
|
14
|
+
# @!attribute token
|
15
|
+
# A Slack connection token.
|
16
|
+
#
|
17
|
+
# @return [Knockapi::Models::Recipients::SlackChannelData::Token, nil]
|
18
|
+
optional :token, -> { Knockapi::Models::Recipients::SlackChannelData::Token }, nil?: true
|
19
|
+
|
20
|
+
# @!method initialize(connections:, token: nil)
|
21
|
+
# Slack channel data
|
22
|
+
#
|
23
|
+
# @param connections [Array<Knockapi::Models::Recipients::SlackChannelData::Connection::SlackTokenConnection, Knockapi::Models::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection>] List of Slack channel connections.
|
24
|
+
#
|
25
|
+
# @param token [Knockapi::Models::Recipients::SlackChannelData::Token, nil] A Slack connection token.
|
26
|
+
|
27
|
+
# A Slack connection, either an access token or an incoming webhook
|
28
|
+
module Connection
|
29
|
+
extend Knockapi::Internal::Type::Union
|
30
|
+
|
31
|
+
# A Slack connection token.
|
32
|
+
variant -> { Knockapi::Models::Recipients::SlackChannelData::Connection::SlackTokenConnection }
|
33
|
+
|
34
|
+
# A Slack connection incoming webhook.
|
35
|
+
variant -> { Knockapi::Models::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection }
|
36
|
+
|
37
|
+
class SlackTokenConnection < Knockapi::Internal::Type::BaseModel
|
38
|
+
# @!attribute access_token
|
39
|
+
# A Slack access token.
|
40
|
+
#
|
41
|
+
# @return [String, nil]
|
42
|
+
optional :access_token, String, nil?: true
|
43
|
+
|
44
|
+
# @!attribute channel_id
|
45
|
+
# A Slack channel ID from the Slack provider.
|
46
|
+
#
|
47
|
+
# @return [String, nil]
|
48
|
+
optional :channel_id, String, nil?: true
|
49
|
+
|
50
|
+
# @!attribute user_id
|
51
|
+
# A Slack user ID from the Slack provider.
|
52
|
+
#
|
53
|
+
# @return [String, nil]
|
54
|
+
optional :user_id, String, nil?: true
|
55
|
+
|
56
|
+
# @!method initialize(access_token: nil, channel_id: nil, user_id: nil)
|
57
|
+
# A Slack connection token.
|
58
|
+
#
|
59
|
+
# @param access_token [String, nil] A Slack access token.
|
60
|
+
#
|
61
|
+
# @param channel_id [String, nil] A Slack channel ID from the Slack provider.
|
62
|
+
#
|
63
|
+
# @param user_id [String, nil] A Slack user ID from the Slack provider.
|
64
|
+
end
|
65
|
+
|
66
|
+
class SlackIncomingWebhookConnection < Knockapi::Internal::Type::BaseModel
|
67
|
+
# @!attribute url
|
68
|
+
# The URL of the incoming webhook for a Slack connection.
|
69
|
+
#
|
70
|
+
# @return [String]
|
71
|
+
required :url, String
|
72
|
+
|
73
|
+
# @!method initialize(url:)
|
74
|
+
# A Slack connection incoming webhook.
|
75
|
+
#
|
76
|
+
# @param url [String] The URL of the incoming webhook for a Slack connection.
|
77
|
+
end
|
78
|
+
|
79
|
+
# @!method self.variants
|
80
|
+
# @return [Array(Knockapi::Models::Recipients::SlackChannelData::Connection::SlackTokenConnection, Knockapi::Models::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection)]
|
81
|
+
end
|
82
|
+
|
83
|
+
# @see Knockapi::Models::Recipients::SlackChannelData#token
|
84
|
+
class Token < Knockapi::Internal::Type::BaseModel
|
85
|
+
# @!attribute access_token
|
86
|
+
# A Slack access token.
|
87
|
+
#
|
88
|
+
# @return [String, nil]
|
89
|
+
required :access_token, String, nil?: true
|
90
|
+
|
91
|
+
# @!method initialize(access_token:)
|
92
|
+
# A Slack connection token.
|
93
|
+
#
|
94
|
+
# @param access_token [String, nil] A Slack access token.
|
95
|
+
end
|
96
|
+
end
|
97
|
+
end
|
98
|
+
end
|
99
|
+
end
|