knockapi 1.0.0 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +41 -0
- data/README.md +101 -49
- data/lib/knockapi/client.rb +4 -4
- data/lib/knockapi/errors.rb +1 -1
- data/lib/knockapi/file_part.rb +2 -2
- data/lib/knockapi/internal/entries_cursor.rb +3 -3
- data/lib/knockapi/internal/items_cursor.rb +3 -3
- data/lib/knockapi/internal/ms_teams_pagination.rb +3 -3
- data/lib/knockapi/internal/slack_channels_cursor.rb +3 -3
- data/lib/knockapi/internal/transport/base_client.rb +79 -7
- data/lib/knockapi/internal/transport/pooled_net_requester.rb +17 -1
- data/lib/knockapi/internal/type/array_of.rb +1 -1
- data/lib/knockapi/internal/type/base_model.rb +71 -39
- data/lib/knockapi/internal/type/converter.rb +18 -0
- data/lib/knockapi/internal/type/enum.rb +1 -0
- data/lib/knockapi/internal/type/hash_of.rb +1 -1
- data/lib/knockapi/internal/type/request_parameters.rb +6 -12
- data/lib/knockapi/internal/type/union.rb +4 -3
- data/lib/knockapi/internal/util.rb +74 -2
- data/lib/knockapi/internal.rb +6 -0
- data/lib/knockapi/models/activity.rb +6 -6
- data/lib/knockapi/models/audience_add_members_params.rb +10 -8
- data/lib/knockapi/models/audience_add_members_response.rb +7 -0
- data/lib/knockapi/models/audience_list_members_response.rb +6 -6
- data/lib/knockapi/models/audience_member.rb +5 -6
- data/lib/knockapi/models/audience_remove_members_params.rb +12 -7
- data/lib/knockapi/models/audience_remove_members_response.rb +7 -0
- data/lib/knockapi/models/bulk_operation.rb +7 -8
- data/lib/knockapi/models/channels/bulk_update_message_status_params.rb +11 -10
- data/lib/knockapi/models/condition.rb +4 -4
- data/lib/knockapi/models/identify_user_request.rb +16 -17
- data/lib/knockapi/models/inline_identify_user_request.rb +64 -7
- data/lib/knockapi/models/inline_object_request.rb +8 -6
- data/lib/knockapi/models/inline_tenant_request.rb +6 -2
- data/lib/knockapi/models/message.rb +19 -23
- data/lib/knockapi/models/message_delivery_log.rb +26 -18
- data/lib/knockapi/models/message_event.rb +9 -10
- data/lib/knockapi/models/message_get_content_response.rb +21 -0
- data/lib/knockapi/models/message_list_params.rb +9 -13
- data/lib/knockapi/models/messages/batch_archive_response.rb +1 -1
- data/lib/knockapi/models/messages/batch_get_content_response.rb +21 -0
- data/lib/knockapi/models/messages/batch_mark_as_interacted_response.rb +1 -1
- data/lib/knockapi/models/messages/batch_mark_as_read_response.rb +1 -1
- data/lib/knockapi/models/messages/batch_mark_as_seen_response.rb +1 -1
- data/lib/knockapi/models/messages/batch_mark_as_unread_response.rb +1 -1
- data/lib/knockapi/models/messages/batch_mark_as_unseen_response.rb +1 -1
- data/lib/knockapi/models/messages/batch_unarchive_response.rb +1 -1
- data/lib/knockapi/models/object.rb +9 -1
- data/lib/knockapi/models/object_add_subscriptions_params.rb +3 -4
- data/lib/knockapi/models/object_add_subscriptions_response.rb +1 -1
- data/lib/knockapi/models/object_delete_response.rb +7 -0
- data/lib/knockapi/models/object_delete_subscriptions_params.rb +3 -5
- data/lib/knockapi/models/object_delete_subscriptions_response.rb +1 -1
- data/lib/knockapi/models/object_list_messages_params.rb +11 -12
- data/lib/knockapi/models/object_list_params.rb +3 -4
- data/lib/knockapi/models/object_list_preferences_response.rb +1 -1
- data/lib/knockapi/models/object_list_subscriptions_params.rb +14 -14
- data/lib/knockapi/models/object_set_params.rb +15 -13
- data/lib/knockapi/models/object_unset_channel_data_response.rb +7 -0
- data/lib/knockapi/models/objects/bulk_add_subscriptions_params.rb +9 -9
- data/lib/knockapi/models/objects/bulk_set_params.rb +3 -3
- data/lib/knockapi/models/providers/ms_team_list_channels_params.rb +4 -7
- data/lib/knockapi/models/providers/ms_team_list_teams_params.rb +4 -9
- data/lib/knockapi/models/providers/slack_list_channels_params.rb +4 -7
- data/lib/knockapi/models/recipient.rb +7 -3
- data/lib/knockapi/models/recipient_reference.rb +6 -2
- data/lib/knockapi/models/recipient_request.rb +7 -3
- data/lib/knockapi/models/recipients/channel_data.rb +26 -14
- data/lib/knockapi/models/recipients/channel_data_request.rb +22 -10
- data/lib/knockapi/models/recipients/discord_channel_data.rb +25 -10
- data/lib/knockapi/models/recipients/inline_channel_data_request.rb +36 -1
- data/lib/knockapi/models/recipients/inline_preference_set_request.rb +1 -1
- data/lib/knockapi/models/recipients/ms_teams_channel_data.rb +25 -10
- data/lib/knockapi/models/recipients/preference_set.rb +52 -28
- data/lib/knockapi/models/recipients/preference_set_channel_type_setting.rb +3 -3
- data/lib/knockapi/models/recipients/preference_set_channel_types.rb +60 -36
- data/lib/knockapi/models/recipients/preference_set_request.rb +52 -28
- data/lib/knockapi/models/recipients/slack_channel_data.rb +21 -10
- data/lib/knockapi/models/recipients/subscription.rb +6 -6
- data/lib/knockapi/models/schedule.rb +11 -12
- data/lib/knockapi/models/schedule_create_params.rb +10 -15
- data/lib/knockapi/models/schedule_create_response.rb +1 -1
- data/lib/knockapi/models/schedule_delete_response.rb +1 -1
- data/lib/knockapi/models/schedule_repeat_rule.rb +7 -7
- data/lib/knockapi/models/schedule_update_params.rb +9 -10
- data/lib/knockapi/models/schedule_update_response.rb +1 -1
- data/lib/knockapi/models/schedules/bulk_create_params.rb +16 -18
- data/lib/knockapi/models/tenant.rb +13 -16
- data/lib/knockapi/models/tenant_delete_response.rb +7 -0
- data/lib/knockapi/models/tenant_request.rb +20 -20
- data/lib/knockapi/models/tenant_set_params.rb +19 -19
- data/lib/knockapi/models/tenants/bulk_set_params.rb +3 -3
- data/lib/knockapi/models/user.rb +9 -11
- data/lib/knockapi/models/user_delete_response.rb +7 -0
- data/lib/knockapi/models/user_list_messages_params.rb +13 -12
- data/lib/knockapi/models/user_list_params.rb +3 -4
- data/lib/knockapi/models/user_list_preferences_response.rb +1 -1
- data/lib/knockapi/models/user_list_subscriptions_params.rb +3 -3
- data/lib/knockapi/models/user_unset_channel_data_response.rb +7 -0
- data/lib/knockapi/models/users/bulk_identify_params.rb +3 -3
- data/lib/knockapi/models/users/bulk_set_preferences_params.rb +3 -3
- data/lib/knockapi/models/users/feed_list_items_params.rb +6 -6
- data/lib/knockapi/models/users/feed_list_items_response.rb +15 -6
- data/lib/knockapi/models/workflow_cancel_params.rb +3 -5
- data/lib/knockapi/models/workflow_cancel_response.rb +7 -0
- data/lib/knockapi/models/workflow_trigger_params.rb +9 -12
- data/lib/knockapi/models/workflow_trigger_response.rb +0 -1
- data/lib/knockapi/models.rb +202 -0
- data/lib/knockapi/request_options.rb +4 -0
- data/lib/knockapi/resources/audiences.rb +4 -4
- data/lib/knockapi/resources/bulk_operations.rb +2 -2
- data/lib/knockapi/resources/channels/bulk.rb +7 -8
- data/lib/knockapi/resources/integrations/census.rb +1 -1
- data/lib/knockapi/resources/integrations/hightouch.rb +1 -1
- data/lib/knockapi/resources/messages/batch.rb +22 -22
- data/lib/knockapi/resources/messages.rb +32 -39
- data/lib/knockapi/resources/objects/bulk.rb +11 -11
- data/lib/knockapi/resources/objects.rb +52 -62
- data/lib/knockapi/resources/providers/ms_teams.rb +6 -6
- data/lib/knockapi/resources/providers/slack.rb +4 -4
- data/lib/knockapi/resources/schedules/bulk.rb +4 -4
- data/lib/knockapi/resources/schedules.rb +18 -23
- data/lib/knockapi/resources/tenants/bulk.rb +7 -7
- data/lib/knockapi/resources/tenants.rb +11 -11
- data/lib/knockapi/resources/users/bulk.rb +11 -11
- data/lib/knockapi/resources/users/feeds.rb +3 -3
- data/lib/knockapi/resources/users/guides.rb +4 -4
- data/lib/knockapi/resources/users.rb +46 -54
- data/lib/knockapi/resources/workflows.rb +6 -11
- data/lib/knockapi/version.rb +1 -1
- data/lib/knockapi.rb +11 -2
- data/rbi/knockapi/client.rbi +5 -4
- data/rbi/knockapi/errors.rbi +35 -16
- data/rbi/knockapi/file_part.rbi +9 -6
- data/rbi/knockapi/internal/entries_cursor.rbi +9 -4
- data/rbi/knockapi/internal/items_cursor.rbi +9 -4
- data/rbi/knockapi/internal/ms_teams_pagination.rbi +2 -1
- data/rbi/knockapi/internal/slack_channels_cursor.rbi +2 -1
- data/rbi/knockapi/internal/transport/base_client.rbi +158 -78
- data/rbi/knockapi/internal/transport/pooled_net_requester.rbi +32 -13
- data/rbi/knockapi/internal/type/array_of.rbi +34 -24
- data/rbi/knockapi/internal/type/base_model.rbi +151 -73
- data/rbi/knockapi/internal/type/base_page.rbi +12 -8
- data/rbi/knockapi/internal/type/boolean.rbi +16 -14
- data/rbi/knockapi/internal/type/converter.rbi +70 -28
- data/rbi/knockapi/internal/type/enum.rbi +28 -15
- data/rbi/knockapi/internal/type/file_input.rbi +8 -4
- data/rbi/knockapi/internal/type/hash_of.rbi +34 -24
- data/rbi/knockapi/internal/type/request_parameters.rbi +12 -4
- data/rbi/knockapi/internal/type/union.rbi +55 -19
- data/rbi/knockapi/internal/type/unknown.rbi +16 -6
- data/rbi/knockapi/internal/util.rbi +239 -87
- data/rbi/knockapi/internal.rbi +2 -0
- data/rbi/knockapi/models/activity.rbi +28 -22
- data/rbi/knockapi/models/audience_add_members_params.rbi +62 -27
- data/rbi/knockapi/models/audience_add_members_response.rbi +7 -0
- data/rbi/knockapi/models/audience_list_members_params.rbi +16 -5
- data/rbi/knockapi/models/audience_list_members_response.rbi +25 -11
- data/rbi/knockapi/models/audience_member.rbi +23 -11
- data/rbi/knockapi/models/audience_remove_members_params.rbi +65 -28
- data/rbi/knockapi/models/audience_remove_members_response.rbi +7 -0
- data/rbi/knockapi/models/bulk_operation.rbi +70 -42
- data/rbi/knockapi/models/bulk_operation_get_params.rbi +13 -5
- data/rbi/knockapi/models/channels/bulk_update_message_status_params.rbi +224 -79
- data/rbi/knockapi/models/condition.rbi +78 -31
- data/rbi/knockapi/models/identify_user_request.rbi +90 -36
- data/rbi/knockapi/models/inline_identify_user_request.rbi +135 -22
- data/rbi/knockapi/models/inline_object_request.rbi +76 -22
- data/rbi/knockapi/models/inline_tenant_request.rbi +7 -2
- data/rbi/knockapi/models/integrations/census_custom_destination_params.rbi +24 -15
- data/rbi/knockapi/models/integrations/census_custom_destination_response.rbi +21 -4
- data/rbi/knockapi/models/integrations/hightouch_embedded_destination_params.rbi +24 -15
- data/rbi/knockapi/models/integrations/hightouch_embedded_destination_response.rbi +21 -4
- data/rbi/knockapi/models/message.rbi +156 -72
- data/rbi/knockapi/models/message_archive_params.rbi +13 -5
- data/rbi/knockapi/models/message_delivery_log.rbi +153 -66
- data/rbi/knockapi/models/message_event.rbi +86 -37
- data/rbi/knockapi/models/message_get_content_params.rbi +13 -5
- data/rbi/knockapi/models/message_get_content_response.rbi +364 -203
- data/rbi/knockapi/models/message_get_params.rbi +13 -5
- data/rbi/knockapi/models/message_list_activities_params.rbi +24 -15
- data/rbi/knockapi/models/message_list_delivery_logs_params.rbi +23 -12
- data/rbi/knockapi/models/message_list_events_params.rbi +20 -12
- data/rbi/knockapi/models/message_list_params.rbi +147 -58
- data/rbi/knockapi/models/message_mark_as_interacted_params.rbi +21 -6
- data/rbi/knockapi/models/message_mark_as_read_params.rbi +13 -5
- data/rbi/knockapi/models/message_mark_as_seen_params.rbi +13 -5
- data/rbi/knockapi/models/message_mark_as_unread_params.rbi +16 -5
- data/rbi/knockapi/models/message_mark_as_unseen_params.rbi +16 -5
- data/rbi/knockapi/models/message_unarchive_params.rbi +13 -5
- data/rbi/knockapi/models/messages/batch_archive_params.rbi +23 -6
- data/rbi/knockapi/models/messages/batch_archive_response.rbi +4 -1
- data/rbi/knockapi/models/messages/batch_get_content_params.rbi +23 -6
- data/rbi/knockapi/models/messages/batch_get_content_response.rbi +367 -206
- data/rbi/knockapi/models/messages/batch_mark_as_interacted_params.rbi +22 -13
- data/rbi/knockapi/models/messages/batch_mark_as_interacted_response.rbi +4 -1
- data/rbi/knockapi/models/messages/batch_mark_as_read_params.rbi +23 -6
- data/rbi/knockapi/models/messages/batch_mark_as_read_response.rbi +4 -1
- data/rbi/knockapi/models/messages/batch_mark_as_seen_params.rbi +23 -6
- data/rbi/knockapi/models/messages/batch_mark_as_seen_response.rbi +4 -1
- data/rbi/knockapi/models/messages/batch_mark_as_unread_params.rbi +23 -6
- data/rbi/knockapi/models/messages/batch_mark_as_unread_response.rbi +4 -1
- data/rbi/knockapi/models/messages/batch_mark_as_unseen_params.rbi +23 -6
- data/rbi/knockapi/models/messages/batch_mark_as_unseen_response.rbi +4 -1
- data/rbi/knockapi/models/messages/batch_unarchive_params.rbi +23 -6
- data/rbi/knockapi/models/messages/batch_unarchive_response.rbi +4 -1
- data/rbi/knockapi/models/object.rbi +31 -10
- data/rbi/knockapi/models/object_add_subscriptions_params.rbi +44 -22
- data/rbi/knockapi/models/object_add_subscriptions_response.rbi +1 -1
- data/rbi/knockapi/models/object_delete_params.rbi +13 -5
- data/rbi/knockapi/models/object_delete_response.rbi +7 -0
- data/rbi/knockapi/models/object_delete_subscriptions_params.rbi +36 -14
- data/rbi/knockapi/models/object_delete_subscriptions_response.rbi +1 -1
- data/rbi/knockapi/models/object_get_channel_data_params.rbi +16 -5
- data/rbi/knockapi/models/object_get_params.rbi +13 -5
- data/rbi/knockapi/models/object_get_preferences_params.rbi +16 -5
- data/rbi/knockapi/models/object_list_messages_params.rbi +169 -60
- data/rbi/knockapi/models/object_list_params.rbi +43 -22
- data/rbi/knockapi/models/object_list_preferences_params.rbi +16 -5
- data/rbi/knockapi/models/object_list_preferences_response.rbi +1 -1
- data/rbi/knockapi/models/object_list_schedules_params.rbi +25 -16
- data/rbi/knockapi/models/object_list_subscriptions_params.rbi +150 -46
- data/rbi/knockapi/models/object_set_channel_data_params.rbi +16 -5
- data/rbi/knockapi/models/object_set_params.rbi +89 -33
- data/rbi/knockapi/models/object_set_preferences_params.rbi +16 -5
- data/rbi/knockapi/models/object_unset_channel_data_params.rbi +16 -5
- data/rbi/knockapi/models/object_unset_channel_data_response.rbi +7 -0
- data/rbi/knockapi/models/objects/bulk_add_subscriptions_params.rbi +77 -34
- data/rbi/knockapi/models/objects/bulk_delete_params.rbi +23 -6
- data/rbi/knockapi/models/objects/bulk_set_params.rbi +20 -11
- data/rbi/knockapi/models/page_info.rbi +22 -11
- data/rbi/knockapi/models/providers/ms_team_check_auth_params.rbi +23 -6
- data/rbi/knockapi/models/providers/ms_team_check_auth_response.rbi +53 -14
- data/rbi/knockapi/models/providers/ms_team_list_channels_params.rbi +53 -23
- data/rbi/knockapi/models/providers/ms_team_list_channels_response.rbi +57 -30
- data/rbi/knockapi/models/providers/ms_team_list_teams_params.rbi +62 -22
- data/rbi/knockapi/models/providers/ms_team_list_teams_response.rbi +23 -4
- data/rbi/knockapi/models/providers/ms_team_revoke_access_params.rbi +23 -6
- data/rbi/knockapi/models/providers/ms_team_revoke_access_response.rbi +14 -3
- data/rbi/knockapi/models/providers/slack_check_auth_params.rbi +23 -6
- data/rbi/knockapi/models/providers/slack_check_auth_response.rbi +53 -14
- data/rbi/knockapi/models/providers/slack_list_channels_params.rbi +58 -30
- data/rbi/knockapi/models/providers/slack_list_channels_response.rbi +29 -12
- data/rbi/knockapi/models/providers/slack_revoke_access_params.rbi +23 -6
- data/rbi/knockapi/models/providers/slack_revoke_access_response.rbi +14 -3
- data/rbi/knockapi/models/recipient.rbi +5 -2
- data/rbi/knockapi/models/recipient_reference.rbi +22 -5
- data/rbi/knockapi/models/recipient_request.rbi +11 -4
- data/rbi/knockapi/models/recipients/channel_data.rbi +123 -50
- data/rbi/knockapi/models/recipients/channel_data_request.rbi +54 -33
- data/rbi/knockapi/models/recipients/discord_channel_data.rbi +100 -53
- data/rbi/knockapi/models/recipients/inline_channel_data_request.rbi +29 -1
- data/rbi/knockapi/models/recipients/inline_preference_set_request.rbi +3 -1
- data/rbi/knockapi/models/recipients/ms_teams_channel_data.rbi +109 -64
- data/rbi/knockapi/models/recipients/one_signal_channel_data.rbi +14 -3
- data/rbi/knockapi/models/recipients/preference_set.rbi +159 -88
- data/rbi/knockapi/models/recipients/preference_set_channel_type_setting.rbi +18 -6
- data/rbi/knockapi/models/recipients/preference_set_channel_types.rbi +276 -105
- data/rbi/knockapi/models/recipients/preference_set_request.rbi +162 -87
- data/rbi/knockapi/models/recipients/push_channel_data.rbi +14 -3
- data/rbi/knockapi/models/recipients/slack_channel_data.rbi +107 -49
- data/rbi/knockapi/models/recipients/subscription.rbi +29 -20
- data/rbi/knockapi/models/schedule.rbi +32 -27
- data/rbi/knockapi/models/schedule_create_params.rbi +52 -35
- data/rbi/knockapi/models/schedule_create_response.rbi +4 -1
- data/rbi/knockapi/models/schedule_delete_params.rbi +20 -6
- data/rbi/knockapi/models/schedule_delete_response.rbi +4 -1
- data/rbi/knockapi/models/schedule_list_params.rbi +23 -17
- data/rbi/knockapi/models/schedule_repeat_rule.rbi +69 -39
- data/rbi/knockapi/models/schedule_update_params.rbi +48 -27
- data/rbi/knockapi/models/schedule_update_response.rbi +4 -1
- data/rbi/knockapi/models/schedules/bulk_create_params.rbi +102 -61
- data/rbi/knockapi/models/tenant.rbi +71 -45
- data/rbi/knockapi/models/tenant_delete_params.rbi +13 -5
- data/rbi/knockapi/models/tenant_delete_response.rbi +7 -0
- data/rbi/knockapi/models/tenant_get_params.rbi +13 -5
- data/rbi/knockapi/models/tenant_list_params.rbi +22 -16
- data/rbi/knockapi/models/tenant_request.rbi +132 -57
- data/rbi/knockapi/models/tenant_set_params.rbi +134 -59
- data/rbi/knockapi/models/tenants/bulk_delete_params.rbi +23 -6
- data/rbi/knockapi/models/tenants/bulk_set_params.rbi +20 -11
- data/rbi/knockapi/models/user.rbi +32 -28
- data/rbi/knockapi/models/user_delete_params.rbi +13 -5
- data/rbi/knockapi/models/user_delete_response.rbi +7 -0
- data/rbi/knockapi/models/user_get_channel_data_params.rbi +13 -5
- data/rbi/knockapi/models/user_get_params.rbi +13 -5
- data/rbi/knockapi/models/user_get_preferences_params.rbi +19 -5
- data/rbi/knockapi/models/user_list_messages_params.rbi +168 -59
- data/rbi/knockapi/models/user_list_params.rbi +43 -22
- data/rbi/knockapi/models/user_list_preferences_params.rbi +16 -5
- data/rbi/knockapi/models/user_list_preferences_response.rbi +1 -1
- data/rbi/knockapi/models/user_list_schedules_params.rbi +22 -16
- data/rbi/knockapi/models/user_list_subscriptions_params.rbi +61 -23
- data/rbi/knockapi/models/user_merge_params.rbi +17 -6
- data/rbi/knockapi/models/user_set_channel_data_params.rbi +13 -5
- data/rbi/knockapi/models/user_set_preferences_params.rbi +13 -5
- data/rbi/knockapi/models/user_unset_channel_data_params.rbi +16 -5
- data/rbi/knockapi/models/user_unset_channel_data_response.rbi +7 -0
- data/rbi/knockapi/models/user_update_params.rbi +13 -5
- data/rbi/knockapi/models/users/bulk_delete_params.rbi +23 -6
- data/rbi/knockapi/models/users/bulk_identify_params.rbi +23 -11
- data/rbi/knockapi/models/users/bulk_set_preferences_params.rbi +26 -18
- data/rbi/knockapi/models/users/feed_get_settings_params.rbi +16 -5
- data/rbi/knockapi/models/users/feed_get_settings_response.rbi +47 -14
- data/rbi/knockapi/models/users/feed_list_items_params.rbi +119 -41
- data/rbi/knockapi/models/users/feed_list_items_response.rbi +197 -100
- data/rbi/knockapi/models/users/guide_get_channel_params.rbi +15 -5
- data/rbi/knockapi/models/users/guide_get_channel_response.rbi +84 -25
- data/rbi/knockapi/models/users/guide_mark_message_as_archived_params.rbi +29 -20
- data/rbi/knockapi/models/users/guide_mark_message_as_archived_response.rbi +14 -3
- data/rbi/knockapi/models/users/guide_mark_message_as_interacted_params.rbi +29 -20
- data/rbi/knockapi/models/users/guide_mark_message_as_interacted_response.rbi +14 -3
- data/rbi/knockapi/models/users/guide_mark_message_as_seen_params.rbi +29 -20
- data/rbi/knockapi/models/users/guide_mark_message_as_seen_response.rbi +14 -3
- data/rbi/knockapi/models/workflow_cancel_params.rbi +42 -17
- data/rbi/knockapi/models/workflow_cancel_response.rbi +7 -0
- data/rbi/knockapi/models/workflow_trigger_params.rbi +65 -37
- data/rbi/knockapi/models/workflow_trigger_response.rbi +14 -3
- data/rbi/knockapi/models.rbi +179 -0
- data/rbi/knockapi/request_options.rbi +18 -7
- data/rbi/knockapi/resources/audiences.rbi +22 -14
- data/rbi/knockapi/resources/bulk_operations.rbi +11 -3
- data/rbi/knockapi/resources/channels/bulk.rbi +15 -9
- data/rbi/knockapi/resources/channels.rbi +2 -1
- data/rbi/knockapi/resources/integrations/census.rbi +8 -4
- data/rbi/knockapi/resources/integrations/hightouch.rbi +8 -4
- data/rbi/knockapi/resources/integrations.rbi +2 -1
- data/rbi/knockapi/resources/messages/batch.rbi +58 -26
- data/rbi/knockapi/resources/messages.rbi +102 -43
- data/rbi/knockapi/resources/objects/bulk.rbi +25 -14
- data/rbi/knockapi/resources/objects.rbi +177 -107
- data/rbi/knockapi/resources/providers/ms_teams.rbi +35 -16
- data/rbi/knockapi/resources/providers/slack.rbi +28 -11
- data/rbi/knockapi/resources/providers.rbi +2 -1
- data/rbi/knockapi/resources/recipients/channel_data.rbi +2 -1
- data/rbi/knockapi/resources/recipients/preferences.rbi +2 -1
- data/rbi/knockapi/resources/recipients/subscriptions.rbi +2 -1
- data/rbi/knockapi/resources/recipients.rbi +2 -1
- data/rbi/knockapi/resources/schedules/bulk.rbi +9 -6
- data/rbi/knockapi/resources/schedules.rbi +44 -33
- data/rbi/knockapi/resources/shared.rbi +2 -1
- data/rbi/knockapi/resources/tenants/bulk.rbi +15 -9
- data/rbi/knockapi/resources/tenants.rbi +51 -20
- data/rbi/knockapi/resources/users/bulk.rbi +21 -14
- data/rbi/knockapi/resources/users/feeds.rbi +20 -9
- data/rbi/knockapi/resources/users/guides.rbi +23 -16
- data/rbi/knockapi/resources/users.rbi +160 -91
- data/rbi/knockapi/resources/workflows.rbi +38 -29
- data/sig/knockapi/internal/entries_cursor.rbs +0 -2
- data/sig/knockapi/internal/items_cursor.rbs +0 -2
- data/sig/knockapi/internal/transport/base_client.rbs +16 -1
- data/sig/knockapi/internal/transport/pooled_net_requester.rbs +4 -0
- data/sig/knockapi/internal/type/base_model.rbs +11 -5
- data/sig/knockapi/internal/type/base_page.rbs +1 -1
- data/sig/knockapi/internal/type/converter.rbs +2 -0
- data/sig/knockapi/internal/type/enum.rbs +1 -0
- data/sig/knockapi/internal/type/request_parameters.rbs +3 -1
- data/sig/knockapi/internal/type/union.rbs +1 -0
- data/sig/knockapi/internal/util.rbs +15 -0
- data/sig/knockapi/internal.rbs +2 -0
- data/sig/knockapi/models/activity.rbs +0 -2
- data/sig/knockapi/models/audience_add_members_params.rbs +6 -12
- data/sig/knockapi/models/audience_add_members_response.rbs +5 -0
- data/sig/knockapi/models/audience_list_members_params.rbs +0 -2
- data/sig/knockapi/models/audience_list_members_response.rbs +6 -8
- data/sig/knockapi/models/audience_member.rbs +3 -5
- data/sig/knockapi/models/audience_remove_members_params.rbs +6 -14
- data/sig/knockapi/models/audience_remove_members_response.rbs +5 -0
- data/sig/knockapi/models/bulk_operation.rbs +9 -13
- data/sig/knockapi/models/bulk_operation_get_params.rbs +0 -2
- data/sig/knockapi/models/channels/bulk_update_message_status_params.rbs +0 -2
- data/sig/knockapi/models/condition.rbs +4 -6
- data/sig/knockapi/models/identify_user_request.rbs +0 -2
- data/sig/knockapi/models/inline_identify_user_request.rbs +26 -4
- data/sig/knockapi/models/inline_object_request.rbs +0 -2
- data/sig/knockapi/models/inline_tenant_request.rbs +2 -2
- data/sig/knockapi/models/integrations/census_custom_destination_params.rbs +0 -2
- data/sig/knockapi/models/integrations/census_custom_destination_response.rbs +0 -2
- data/sig/knockapi/models/integrations/hightouch_embedded_destination_params.rbs +0 -2
- data/sig/knockapi/models/integrations/hightouch_embedded_destination_response.rbs +0 -2
- data/sig/knockapi/models/message.rbs +15 -23
- data/sig/knockapi/models/message_archive_params.rbs +0 -2
- data/sig/knockapi/models/message_delivery_log.rbs +24 -30
- data/sig/knockapi/models/message_event.rbs +4 -6
- data/sig/knockapi/models/message_get_content_params.rbs +0 -2
- data/sig/knockapi/models/message_get_content_response.rbs +2 -24
- data/sig/knockapi/models/message_get_params.rbs +0 -2
- data/sig/knockapi/models/message_list_activities_params.rbs +0 -2
- data/sig/knockapi/models/message_list_delivery_logs_params.rbs +0 -2
- data/sig/knockapi/models/message_list_events_params.rbs +0 -2
- data/sig/knockapi/models/message_list_params.rbs +17 -21
- data/sig/knockapi/models/message_mark_as_interacted_params.rbs +0 -2
- data/sig/knockapi/models/message_mark_as_read_params.rbs +0 -2
- data/sig/knockapi/models/message_mark_as_seen_params.rbs +0 -2
- data/sig/knockapi/models/message_mark_as_unread_params.rbs +0 -2
- data/sig/knockapi/models/message_mark_as_unseen_params.rbs +0 -2
- data/sig/knockapi/models/message_unarchive_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_archive_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_archive_response.rbs +1 -1
- data/sig/knockapi/models/messages/batch_get_content_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_get_content_response.rbs +2 -24
- data/sig/knockapi/models/messages/batch_mark_as_interacted_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_mark_as_interacted_response.rbs +1 -2
- data/sig/knockapi/models/messages/batch_mark_as_read_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_mark_as_read_response.rbs +1 -1
- data/sig/knockapi/models/messages/batch_mark_as_seen_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_mark_as_seen_response.rbs +1 -1
- data/sig/knockapi/models/messages/batch_mark_as_unread_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_mark_as_unread_response.rbs +1 -1
- data/sig/knockapi/models/messages/batch_mark_as_unseen_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_mark_as_unseen_response.rbs +1 -1
- data/sig/knockapi/models/messages/batch_unarchive_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_unarchive_response.rbs +1 -1
- data/sig/knockapi/models/object.rbs +8 -4
- data/sig/knockapi/models/object_add_subscriptions_params.rbs +0 -2
- data/sig/knockapi/models/object_add_subscriptions_response.rbs +1 -1
- data/sig/knockapi/models/object_delete_params.rbs +0 -2
- data/sig/knockapi/models/object_delete_response.rbs +5 -0
- data/sig/knockapi/models/object_delete_subscriptions_params.rbs +0 -2
- data/sig/knockapi/models/object_delete_subscriptions_response.rbs +1 -1
- data/sig/knockapi/models/object_get_channel_data_params.rbs +0 -2
- data/sig/knockapi/models/object_get_params.rbs +0 -2
- data/sig/knockapi/models/object_get_preferences_params.rbs +0 -2
- data/sig/knockapi/models/object_list_messages_params.rbs +17 -21
- data/sig/knockapi/models/object_list_params.rbs +6 -8
- data/sig/knockapi/models/object_list_preferences_params.rbs +0 -2
- data/sig/knockapi/models/object_list_preferences_response.rbs +1 -1
- data/sig/knockapi/models/object_list_schedules_params.rbs +0 -2
- data/sig/knockapi/models/object_list_subscriptions_params.rbs +11 -15
- data/sig/knockapi/models/object_set_channel_data_params.rbs +0 -2
- data/sig/knockapi/models/object_set_params.rbs +0 -2
- data/sig/knockapi/models/object_set_preferences_params.rbs +0 -2
- data/sig/knockapi/models/object_unset_channel_data_params.rbs +0 -2
- data/sig/knockapi/models/object_unset_channel_data_response.rbs +5 -0
- data/sig/knockapi/models/objects/bulk_add_subscriptions_params.rbs +3 -7
- data/sig/knockapi/models/objects/bulk_delete_params.rbs +0 -2
- data/sig/knockapi/models/objects/bulk_set_params.rbs +3 -5
- data/sig/knockapi/models/page_info.rbs +0 -2
- data/sig/knockapi/models/providers/ms_team_check_auth_params.rbs +0 -2
- data/sig/knockapi/models/providers/ms_team_check_auth_response.rbs +0 -4
- data/sig/knockapi/models/providers/ms_team_list_channels_params.rbs +5 -9
- data/sig/knockapi/models/providers/ms_team_list_channels_response.rbs +0 -4
- data/sig/knockapi/models/providers/ms_team_list_teams_params.rbs +5 -9
- data/sig/knockapi/models/providers/ms_team_list_teams_response.rbs +0 -2
- data/sig/knockapi/models/providers/ms_team_revoke_access_params.rbs +0 -2
- data/sig/knockapi/models/providers/ms_team_revoke_access_response.rbs +0 -2
- data/sig/knockapi/models/providers/slack_check_auth_params.rbs +0 -2
- data/sig/knockapi/models/providers/slack_check_auth_response.rbs +0 -4
- data/sig/knockapi/models/providers/slack_list_channels_params.rbs +5 -9
- data/sig/knockapi/models/providers/slack_list_channels_response.rbs +0 -2
- data/sig/knockapi/models/providers/slack_revoke_access_params.rbs +0 -2
- data/sig/knockapi/models/providers/slack_revoke_access_response.rbs +0 -2
- data/sig/knockapi/models/recipient.rbs +2 -2
- data/sig/knockapi/models/recipient_reference.rbs +2 -4
- data/sig/knockapi/models/recipient_request.rbs +3 -3
- data/sig/knockapi/models/recipients/channel_data.rbs +15 -17
- data/sig/knockapi/models/recipients/channel_data_request.rbs +9 -11
- data/sig/knockapi/models/recipients/discord_channel_data.rbs +9 -17
- data/sig/knockapi/models/recipients/inline_channel_data_request.rbs +14 -1
- data/sig/knockapi/models/recipients/inline_preference_set_request.rbs +1 -1
- data/sig/knockapi/models/recipients/ms_teams_channel_data.rbs +9 -17
- data/sig/knockapi/models/recipients/one_signal_channel_data.rbs +0 -2
- data/sig/knockapi/models/recipients/preference_set.rbs +25 -31
- data/sig/knockapi/models/recipients/preference_set_channel_type_setting.rbs +3 -7
- data/sig/knockapi/models/recipients/preference_set_channel_types.rbs +42 -48
- data/sig/knockapi/models/recipients/preference_set_request.rbs +25 -31
- data/sig/knockapi/models/recipients/push_channel_data.rbs +0 -2
- data/sig/knockapi/models/recipients/slack_channel_data.rbs +9 -17
- data/sig/knockapi/models/recipients/subscription.rbs +3 -5
- data/sig/knockapi/models/schedule.rbs +3 -5
- data/sig/knockapi/models/schedule_create_params.rbs +3 -5
- data/sig/knockapi/models/schedule_create_response.rbs +1 -1
- data/sig/knockapi/models/schedule_delete_params.rbs +0 -2
- data/sig/knockapi/models/schedule_delete_response.rbs +1 -1
- data/sig/knockapi/models/schedule_list_params.rbs +0 -2
- data/sig/knockapi/models/schedule_repeat_rule.rbs +8 -10
- data/sig/knockapi/models/schedule_update_params.rbs +5 -7
- data/sig/knockapi/models/schedule_update_response.rbs +1 -1
- data/sig/knockapi/models/schedules/bulk_create_params.rbs +8 -14
- data/sig/knockapi/models/tenant.rbs +9 -15
- data/sig/knockapi/models/tenant_delete_params.rbs +0 -2
- data/sig/knockapi/models/tenant_delete_response.rbs +5 -0
- data/sig/knockapi/models/tenant_get_params.rbs +0 -2
- data/sig/knockapi/models/tenant_list_params.rbs +0 -2
- data/sig/knockapi/models/tenant_request.rbs +13 -19
- data/sig/knockapi/models/tenant_set_params.rbs +13 -19
- data/sig/knockapi/models/tenants/bulk_delete_params.rbs +0 -2
- data/sig/knockapi/models/tenants/bulk_set_params.rbs +0 -2
- data/sig/knockapi/models/user.rbs +0 -2
- data/sig/knockapi/models/user_delete_params.rbs +0 -2
- data/sig/knockapi/models/user_delete_response.rbs +5 -0
- data/sig/knockapi/models/user_get_channel_data_params.rbs +0 -2
- data/sig/knockapi/models/user_get_params.rbs +0 -2
- data/sig/knockapi/models/user_get_preferences_params.rbs +0 -2
- data/sig/knockapi/models/user_list_messages_params.rbs +17 -21
- data/sig/knockapi/models/user_list_params.rbs +6 -8
- data/sig/knockapi/models/user_list_preferences_params.rbs +0 -2
- data/sig/knockapi/models/user_list_preferences_response.rbs +1 -1
- data/sig/knockapi/models/user_list_schedules_params.rbs +0 -2
- data/sig/knockapi/models/user_list_subscriptions_params.rbs +6 -8
- data/sig/knockapi/models/user_merge_params.rbs +0 -2
- data/sig/knockapi/models/user_set_channel_data_params.rbs +0 -2
- data/sig/knockapi/models/user_set_preferences_params.rbs +0 -2
- data/sig/knockapi/models/user_unset_channel_data_params.rbs +0 -2
- data/sig/knockapi/models/user_unset_channel_data_response.rbs +5 -0
- data/sig/knockapi/models/user_update_params.rbs +0 -2
- data/sig/knockapi/models/users/bulk_delete_params.rbs +0 -2
- data/sig/knockapi/models/users/bulk_identify_params.rbs +3 -5
- data/sig/knockapi/models/users/bulk_set_preferences_params.rbs +3 -5
- data/sig/knockapi/models/users/feed_get_settings_params.rbs +0 -2
- data/sig/knockapi/models/users/feed_get_settings_response.rbs +0 -4
- data/sig/knockapi/models/users/feed_list_items_params.rbs +0 -2
- data/sig/knockapi/models/users/feed_list_items_response.rbs +4 -14
- data/sig/knockapi/models/users/guide_get_channel_params.rbs +0 -2
- data/sig/knockapi/models/users/guide_get_channel_response.rbs +0 -6
- data/sig/knockapi/models/users/guide_mark_message_as_archived_params.rbs +0 -2
- data/sig/knockapi/models/users/guide_mark_message_as_archived_response.rbs +0 -2
- data/sig/knockapi/models/users/guide_mark_message_as_interacted_params.rbs +0 -2
- data/sig/knockapi/models/users/guide_mark_message_as_interacted_response.rbs +0 -2
- data/sig/knockapi/models/users/guide_mark_message_as_seen_params.rbs +0 -2
- data/sig/knockapi/models/users/guide_mark_message_as_seen_response.rbs +0 -2
- data/sig/knockapi/models/workflow_cancel_params.rbs +0 -2
- data/sig/knockapi/models/workflow_cancel_response.rbs +5 -0
- data/sig/knockapi/models/workflow_trigger_params.rbs +0 -2
- data/sig/knockapi/models/workflow_trigger_response.rbs +0 -2
- data/sig/knockapi/models.rbs +173 -0
- data/sig/knockapi/request_options.rbs +1 -1
- data/sig/knockapi/resources/audiences.rbs +2 -2
- data/sig/knockapi/resources/bulk_operations.rbs +1 -1
- data/sig/knockapi/resources/channels/bulk.rbs +1 -1
- data/sig/knockapi/resources/messages.rbs +15 -17
- data/sig/knockapi/resources/objects/bulk.rbs +5 -5
- data/sig/knockapi/resources/objects.rbs +19 -19
- data/sig/knockapi/resources/providers/ms_teams.rbs +2 -2
- data/sig/knockapi/resources/providers/slack.rbs +1 -1
- data/sig/knockapi/resources/schedules/bulk.rbs +2 -2
- data/sig/knockapi/resources/schedules.rbs +3 -3
- data/sig/knockapi/resources/tenants/bulk.rbs +2 -2
- data/sig/knockapi/resources/tenants.rbs +4 -4
- data/sig/knockapi/resources/users/bulk.rbs +5 -5
- data/sig/knockapi/resources/users.rbs +19 -19
- metadata +29 -8
- data/lib/knockapi/models/messages/activity_list_params.rb +0 -48
- data/lib/knockapi/resources/messages/activities.rb +0 -47
- data/rbi/knockapi/models/messages/activity_list_params.rbi +0 -75
- data/rbi/knockapi/resources/messages/activities.rbi +0 -38
- data/sig/knockapi/models/messages/activity_list_params.rbs +0 -45
- data/sig/knockapi/resources/messages/activities.rbs +0 -18
@@ -19,14 +19,14 @@ module Knockapi
|
|
19
19
|
# @!attribute recipient
|
20
20
|
# A recipient of a notification, which is either a user or an object.
|
21
21
|
#
|
22
|
-
# @return [Knockapi::
|
23
|
-
required :recipient, union: -> { Knockapi::
|
22
|
+
# @return [Knockapi::User, Knockapi::Object]
|
23
|
+
required :recipient, union: -> { Knockapi::Recipient }
|
24
24
|
|
25
25
|
# @!attribute repeats
|
26
26
|
# The repeat rule for the schedule.
|
27
27
|
#
|
28
|
-
# @return [Array<Knockapi::
|
29
|
-
required :repeats, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::
|
28
|
+
# @return [Array<Knockapi::ScheduleRepeatRule>]
|
29
|
+
required :repeats, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::ScheduleRepeatRule] }
|
30
30
|
|
31
31
|
# @!attribute updated_at
|
32
32
|
# The timestamp when the resource was last updated.
|
@@ -49,8 +49,8 @@ module Knockapi
|
|
49
49
|
# @!attribute actor
|
50
50
|
# A recipient of a notification, which is either a user or an object.
|
51
51
|
#
|
52
|
-
# @return [Knockapi::
|
53
|
-
optional :actor, union: -> { Knockapi::
|
52
|
+
# @return [Knockapi::User, Knockapi::Object, nil]
|
53
|
+
optional :actor, union: -> { Knockapi::Recipient }, nil?: true
|
54
54
|
|
55
55
|
# @!attribute data
|
56
56
|
# An optional map of data to pass into the workflow execution.
|
@@ -79,8 +79,8 @@ module Knockapi
|
|
79
79
|
optional :tenant, String, nil?: true
|
80
80
|
|
81
81
|
# @!method initialize(id:, inserted_at:, recipient:, repeats:, updated_at:, workflow:, _typename: nil, actor: nil, data: nil, last_occurrence_at: nil, next_occurrence_at: nil, tenant: nil)
|
82
|
-
# Some parameter documentations has been truncated, see
|
83
|
-
#
|
82
|
+
# Some parameter documentations has been truncated, see {Knockapi::Schedule} for
|
83
|
+
# more details.
|
84
84
|
#
|
85
85
|
# A schedule represents a recurring workflow execution.
|
86
86
|
#
|
@@ -88,9 +88,9 @@ module Knockapi
|
|
88
88
|
#
|
89
89
|
# @param inserted_at [Time] Timestamp when the resource was created.
|
90
90
|
#
|
91
|
-
# @param recipient [Knockapi::
|
91
|
+
# @param recipient [Knockapi::User, Knockapi::Object] A recipient of a notification, which is either a user or an object.
|
92
92
|
#
|
93
|
-
# @param repeats [Array<Knockapi::
|
93
|
+
# @param repeats [Array<Knockapi::ScheduleRepeatRule>] The repeat rule for the schedule.
|
94
94
|
#
|
95
95
|
# @param updated_at [Time] The timestamp when the resource was last updated.
|
96
96
|
#
|
@@ -98,7 +98,7 @@ module Knockapi
|
|
98
98
|
#
|
99
99
|
# @param _typename [String] The typename of the schema.
|
100
100
|
#
|
101
|
-
# @param actor [Knockapi::
|
101
|
+
# @param actor [Knockapi::User, Knockapi::Object, nil] A recipient of a notification, which is either a user or an object.
|
102
102
|
#
|
103
103
|
# @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution.
|
104
104
|
#
|
@@ -107,7 +107,6 @@ module Knockapi
|
|
107
107
|
# @param next_occurrence_at [Time, nil] The next occurrence of the schedule.
|
108
108
|
#
|
109
109
|
# @param tenant [String, nil] The tenant to trigger the workflow for. Triggering with a tenant will use any te
|
110
|
-
# ...
|
111
110
|
end
|
112
111
|
end
|
113
112
|
end
|
@@ -8,17 +8,16 @@ module Knockapi
|
|
8
8
|
include Knockapi::Internal::Type::RequestParameters
|
9
9
|
|
10
10
|
# @!attribute recipients
|
11
|
-
# The recipients to
|
12
|
-
# or use a list of user IDs. Limited to 1,000 recipients.
|
11
|
+
# The recipients to set the schedule for. Limited to 100 recipients per request.
|
13
12
|
#
|
14
|
-
# @return [Array<String, Knockapi::
|
15
|
-
required :recipients, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::
|
13
|
+
# @return [Array<String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest>]
|
14
|
+
required :recipients, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientRequest] }
|
16
15
|
|
17
16
|
# @!attribute repeats
|
18
17
|
# The repeat rule for the schedule.
|
19
18
|
#
|
20
|
-
# @return [Array<Knockapi::
|
21
|
-
required :repeats, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::
|
19
|
+
# @return [Array<Knockapi::ScheduleRepeatRule>]
|
20
|
+
required :repeats, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::ScheduleRepeatRule] }
|
22
21
|
|
23
22
|
# @!attribute workflow
|
24
23
|
# The key of the workflow.
|
@@ -47,17 +46,13 @@ module Knockapi
|
|
47
46
|
# @!attribute tenant
|
48
47
|
# An request to set a tenant inline.
|
49
48
|
#
|
50
|
-
# @return [String, Knockapi::
|
51
|
-
optional :tenant, union: -> { Knockapi::
|
49
|
+
# @return [String, Knockapi::TenantRequest, nil]
|
50
|
+
optional :tenant, union: -> { Knockapi::InlineTenantRequest }, nil?: true
|
52
51
|
|
53
52
|
# @!method initialize(recipients:, repeats:, workflow:, data: nil, ending_at: nil, scheduled_at: nil, tenant: nil, request_options: {})
|
54
|
-
#
|
55
|
-
# {Knockapi::Models::ScheduleCreateParams} for more details.
|
53
|
+
# @param recipients [Array<String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest>] The recipients to set the schedule for. Limited to 100 recipients per request.
|
56
54
|
#
|
57
|
-
# @param
|
58
|
-
# ...
|
59
|
-
#
|
60
|
-
# @param repeats [Array<Knockapi::Models::ScheduleRepeatRule>] The repeat rule for the schedule.
|
55
|
+
# @param repeats [Array<Knockapi::ScheduleRepeatRule>] The repeat rule for the schedule.
|
61
56
|
#
|
62
57
|
# @param workflow [String] The key of the workflow.
|
63
58
|
#
|
@@ -67,7 +62,7 @@ module Knockapi
|
|
67
62
|
#
|
68
63
|
# @param scheduled_at [Time, nil] The starting date and time for the schedule.
|
69
64
|
#
|
70
|
-
# @param tenant [String, Knockapi::
|
65
|
+
# @param tenant [String, Knockapi::TenantRequest, nil] An request to set a tenant inline.
|
71
66
|
#
|
72
67
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
73
68
|
end
|
@@ -3,6 +3,6 @@
|
|
3
3
|
module Knockapi
|
4
4
|
module Models
|
5
5
|
# @type [Knockapi::Internal::Type::Converter]
|
6
|
-
ScheduleCreateResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::
|
6
|
+
ScheduleCreateResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Schedule }]
|
7
7
|
end
|
8
8
|
end
|
@@ -3,6 +3,6 @@
|
|
3
3
|
module Knockapi
|
4
4
|
module Models
|
5
5
|
# @type [Knockapi::Internal::Type::Converter]
|
6
|
-
ScheduleDeleteResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::
|
6
|
+
ScheduleDeleteResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Schedule }]
|
7
7
|
end
|
8
8
|
end
|
@@ -12,8 +12,8 @@ module Knockapi
|
|
12
12
|
# @!attribute frequency
|
13
13
|
# The frequency of the schedule.
|
14
14
|
#
|
15
|
-
# @return [Symbol, Knockapi::
|
16
|
-
required :frequency, enum: -> { Knockapi::
|
15
|
+
# @return [Symbol, Knockapi::ScheduleRepeatRule::Frequency]
|
16
|
+
required :frequency, enum: -> { Knockapi::ScheduleRepeatRule::Frequency }
|
17
17
|
|
18
18
|
# @!attribute day_of_month
|
19
19
|
# The day of the month to repeat the schedule.
|
@@ -24,9 +24,9 @@ module Knockapi
|
|
24
24
|
# @!attribute days
|
25
25
|
# The days of the week to repeat the schedule.
|
26
26
|
#
|
27
|
-
# @return [Array<Symbol, Knockapi::
|
27
|
+
# @return [Array<Symbol, Knockapi::ScheduleRepeatRule::Day>, nil]
|
28
28
|
optional :days,
|
29
|
-
-> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::
|
29
|
+
-> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::ScheduleRepeatRule::Day] },
|
30
30
|
nil?: true
|
31
31
|
|
32
32
|
# @!attribute hours
|
@@ -52,11 +52,11 @@ module Knockapi
|
|
52
52
|
#
|
53
53
|
# @param _typename [String] The typename of the schema.
|
54
54
|
#
|
55
|
-
# @param frequency [Symbol, Knockapi::
|
55
|
+
# @param frequency [Symbol, Knockapi::ScheduleRepeatRule::Frequency] The frequency of the schedule.
|
56
56
|
#
|
57
57
|
# @param day_of_month [Integer, nil] The day of the month to repeat the schedule.
|
58
58
|
#
|
59
|
-
# @param days [Array<Symbol, Knockapi::
|
59
|
+
# @param days [Array<Symbol, Knockapi::ScheduleRepeatRule::Day>, nil] The days of the week to repeat the schedule.
|
60
60
|
#
|
61
61
|
# @param hours [Integer, nil] The hour of the day to repeat the schedule.
|
62
62
|
#
|
@@ -66,7 +66,7 @@ module Knockapi
|
|
66
66
|
|
67
67
|
# The frequency of the schedule.
|
68
68
|
#
|
69
|
-
# @see Knockapi::
|
69
|
+
# @see Knockapi::ScheduleRepeatRule#frequency
|
70
70
|
module Frequency
|
71
71
|
extend Knockapi::Internal::Type::Enum
|
72
72
|
|
@@ -17,8 +17,8 @@ module Knockapi
|
|
17
17
|
# A reference to a recipient, either a user identifier (string) or an object
|
18
18
|
# reference (ID, collection).
|
19
19
|
#
|
20
|
-
# @return [String, Knockapi::
|
21
|
-
optional :actor, union: -> { Knockapi::
|
20
|
+
# @return [String, Knockapi::RecipientReference::ObjectReference, nil]
|
21
|
+
optional :actor, union: -> { Knockapi::RecipientReference }, nil?: true
|
22
22
|
|
23
23
|
# @!attribute data
|
24
24
|
# An optional map of data to pass into the workflow execution.
|
@@ -35,8 +35,8 @@ module Knockapi
|
|
35
35
|
# @!attribute repeats
|
36
36
|
# The repeat rule for the schedule.
|
37
37
|
#
|
38
|
-
# @return [Array<Knockapi::
|
39
|
-
optional :repeats, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::
|
38
|
+
# @return [Array<Knockapi::ScheduleRepeatRule>, nil]
|
39
|
+
optional :repeats, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::ScheduleRepeatRule] }
|
40
40
|
|
41
41
|
# @!attribute scheduled_at
|
42
42
|
# The starting date and time for the schedule.
|
@@ -47,8 +47,8 @@ module Knockapi
|
|
47
47
|
# @!attribute tenant
|
48
48
|
# An request to set a tenant inline.
|
49
49
|
#
|
50
|
-
# @return [String, Knockapi::
|
51
|
-
optional :tenant, union: -> { Knockapi::
|
50
|
+
# @return [String, Knockapi::TenantRequest, nil]
|
51
|
+
optional :tenant, union: -> { Knockapi::InlineTenantRequest }, nil?: true
|
52
52
|
|
53
53
|
# @!method initialize(schedule_ids:, actor: nil, data: nil, ending_at: nil, repeats: nil, scheduled_at: nil, tenant: nil, request_options: {})
|
54
54
|
# Some parameter documentations has been truncated, see
|
@@ -56,18 +56,17 @@ module Knockapi
|
|
56
56
|
#
|
57
57
|
# @param schedule_ids [Array<String>] A list of schedule IDs.
|
58
58
|
#
|
59
|
-
# @param actor [String, Knockapi::
|
60
|
-
# ...
|
59
|
+
# @param actor [String, Knockapi::RecipientReference::ObjectReference, nil] A reference to a recipient, either a user identifier (string) or an object refer
|
61
60
|
#
|
62
61
|
# @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution.
|
63
62
|
#
|
64
63
|
# @param ending_at [Time, nil] The ending date and time for the schedule.
|
65
64
|
#
|
66
|
-
# @param repeats [Array<Knockapi::
|
65
|
+
# @param repeats [Array<Knockapi::ScheduleRepeatRule>] The repeat rule for the schedule.
|
67
66
|
#
|
68
67
|
# @param scheduled_at [Time, nil] The starting date and time for the schedule.
|
69
68
|
#
|
70
|
-
# @param tenant [String, Knockapi::
|
69
|
+
# @param tenant [String, Knockapi::TenantRequest, nil] An request to set a tenant inline.
|
71
70
|
#
|
72
71
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
73
72
|
end
|
@@ -3,6 +3,6 @@
|
|
3
3
|
module Knockapi
|
4
4
|
module Models
|
5
5
|
# @type [Knockapi::Internal::Type::Converter]
|
6
|
-
ScheduleUpdateResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::
|
6
|
+
ScheduleUpdateResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Schedule }]
|
7
7
|
end
|
8
8
|
end
|
@@ -11,12 +11,12 @@ module Knockapi
|
|
11
11
|
# @!attribute schedules
|
12
12
|
# A list of schedules.
|
13
13
|
#
|
14
|
-
# @return [Array<Knockapi::
|
14
|
+
# @return [Array<Knockapi::Schedules::BulkCreateParams::Schedule>]
|
15
15
|
required :schedules,
|
16
|
-
-> { Knockapi::Internal::Type::ArrayOf[Knockapi::
|
16
|
+
-> { Knockapi::Internal::Type::ArrayOf[Knockapi::Schedules::BulkCreateParams::Schedule] }
|
17
17
|
|
18
18
|
# @!method initialize(schedules:, request_options: {})
|
19
|
-
# @param schedules [Array<Knockapi::
|
19
|
+
# @param schedules [Array<Knockapi::Schedules::BulkCreateParams::Schedule>] A list of schedules.
|
20
20
|
#
|
21
21
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
22
22
|
|
@@ -32,8 +32,8 @@ module Knockapi
|
|
32
32
|
# (string), an inline user request (object), or an inline object request, which is
|
33
33
|
# determined by the presence of a `collection` property.
|
34
34
|
#
|
35
|
-
# @return [String, Knockapi::
|
36
|
-
optional :actor, union: -> { Knockapi::
|
35
|
+
# @return [String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest, nil]
|
36
|
+
optional :actor, union: -> { Knockapi::RecipientRequest }, nil?: true
|
37
37
|
|
38
38
|
# @!attribute data
|
39
39
|
# An optional map of data to pass into the workflow execution.
|
@@ -52,14 +52,14 @@ module Knockapi
|
|
52
52
|
# (string), an inline user request (object), or an inline object request, which is
|
53
53
|
# determined by the presence of a `collection` property.
|
54
54
|
#
|
55
|
-
# @return [String, Knockapi::
|
56
|
-
optional :recipient, union: -> { Knockapi::
|
55
|
+
# @return [String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest, nil]
|
56
|
+
optional :recipient, union: -> { Knockapi::RecipientRequest }
|
57
57
|
|
58
58
|
# @!attribute repeats
|
59
59
|
# The repeat rule for the schedule.
|
60
60
|
#
|
61
|
-
# @return [Array<Knockapi::
|
62
|
-
optional :repeats, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::
|
61
|
+
# @return [Array<Knockapi::ScheduleRepeatRule>, nil]
|
62
|
+
optional :repeats, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::ScheduleRepeatRule] }
|
63
63
|
|
64
64
|
# @!attribute scheduled_at
|
65
65
|
# The starting date and time for the schedule.
|
@@ -70,32 +70,30 @@ module Knockapi
|
|
70
70
|
# @!attribute tenant
|
71
71
|
# An request to set a tenant inline.
|
72
72
|
#
|
73
|
-
# @return [String, Knockapi::
|
74
|
-
optional :tenant, union: -> { Knockapi::
|
73
|
+
# @return [String, Knockapi::TenantRequest, nil]
|
74
|
+
optional :tenant, union: -> { Knockapi::InlineTenantRequest }, nil?: true
|
75
75
|
|
76
76
|
# @!method initialize(workflow:, actor: nil, data: nil, ending_at: nil, recipient: nil, repeats: nil, scheduled_at: nil, tenant: nil)
|
77
77
|
# Some parameter documentations has been truncated, see
|
78
|
-
# {Knockapi::
|
78
|
+
# {Knockapi::Schedules::BulkCreateParams::Schedule} for more details.
|
79
79
|
#
|
80
80
|
# A schedule represents a recurring workflow execution.
|
81
81
|
#
|
82
82
|
# @param workflow [String] The key of the workflow.
|
83
83
|
#
|
84
|
-
# @param actor [String, Knockapi::
|
85
|
-
# ...
|
84
|
+
# @param actor [String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest, nil] Specifies a recipient in a request. This can either be a user identifier (string
|
86
85
|
#
|
87
86
|
# @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution.
|
88
87
|
#
|
89
88
|
# @param ending_at [Time, nil] The ending date and time for the schedule.
|
90
89
|
#
|
91
|
-
# @param recipient [String, Knockapi::
|
92
|
-
# ...
|
90
|
+
# @param recipient [String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest] Specifies a recipient in a request. This can either be a user identifier (string
|
93
91
|
#
|
94
|
-
# @param repeats [Array<Knockapi::
|
92
|
+
# @param repeats [Array<Knockapi::ScheduleRepeatRule>] The repeat rule for the schedule.
|
95
93
|
#
|
96
94
|
# @param scheduled_at [Time, nil] The starting date and time for the schedule.
|
97
95
|
#
|
98
|
-
# @param tenant [String, Knockapi::
|
96
|
+
# @param tenant [String, Knockapi::TenantRequest, nil] An request to set a tenant inline.
|
99
97
|
end
|
100
98
|
end
|
101
99
|
end
|
@@ -25,8 +25,8 @@ module Knockapi
|
|
25
25
|
# @!attribute settings
|
26
26
|
# The settings for the tenant. Includes branding and preference set.
|
27
27
|
#
|
28
|
-
# @return [Knockapi::
|
29
|
-
optional :settings, -> { Knockapi::
|
28
|
+
# @return [Knockapi::Tenant::Settings, nil]
|
29
|
+
optional :settings, -> { Knockapi::Tenant::Settings }, nil?: true
|
30
30
|
|
31
31
|
# @!method initialize(id:, _typename:, name: nil, settings: nil)
|
32
32
|
# A tenant entity.
|
@@ -37,35 +37,34 @@ module Knockapi
|
|
37
37
|
#
|
38
38
|
# @param name [String, nil] An optional name for the tenant.
|
39
39
|
#
|
40
|
-
# @param settings [Knockapi::
|
40
|
+
# @param settings [Knockapi::Tenant::Settings, nil] The settings for the tenant. Includes branding and preference set.
|
41
41
|
|
42
|
-
# @see Knockapi::
|
42
|
+
# @see Knockapi::Tenant#settings
|
43
43
|
class Settings < Knockapi::Internal::Type::BaseModel
|
44
44
|
# @!attribute branding
|
45
45
|
# The branding for the tenant.
|
46
46
|
#
|
47
|
-
# @return [Knockapi::
|
48
|
-
optional :branding, -> { Knockapi::
|
47
|
+
# @return [Knockapi::Tenant::Settings::Branding, nil]
|
48
|
+
optional :branding, -> { Knockapi::Tenant::Settings::Branding }, nil?: true
|
49
49
|
|
50
50
|
# @!attribute preference_set
|
51
51
|
# A preference set represents a specific set of notification preferences for a
|
52
52
|
# recipient. A recipient can have multiple preference sets.
|
53
53
|
#
|
54
|
-
# @return [Knockapi::
|
55
|
-
optional :preference_set, -> { Knockapi::
|
54
|
+
# @return [Knockapi::Recipients::PreferenceSet, nil]
|
55
|
+
optional :preference_set, -> { Knockapi::Recipients::PreferenceSet }, nil?: true
|
56
56
|
|
57
57
|
# @!method initialize(branding: nil, preference_set: nil)
|
58
58
|
# Some parameter documentations has been truncated, see
|
59
|
-
# {Knockapi::
|
59
|
+
# {Knockapi::Tenant::Settings} for more details.
|
60
60
|
#
|
61
61
|
# The settings for the tenant. Includes branding and preference set.
|
62
62
|
#
|
63
|
-
# @param branding [Knockapi::
|
63
|
+
# @param branding [Knockapi::Tenant::Settings::Branding, nil] The branding for the tenant.
|
64
64
|
#
|
65
|
-
# @param preference_set [Knockapi::
|
66
|
-
# ...
|
65
|
+
# @param preference_set [Knockapi::Recipients::PreferenceSet, nil] A preference set represents a specific set of notification preferences for a rec
|
67
66
|
|
68
|
-
# @see Knockapi::
|
67
|
+
# @see Knockapi::Tenant::Settings#branding
|
69
68
|
class Branding < Knockapi::Internal::Type::BaseModel
|
70
69
|
# @!attribute icon_url
|
71
70
|
# The icon URL for the tenant. Must point to a valid image with an image MIME
|
@@ -95,15 +94,13 @@ module Knockapi
|
|
95
94
|
|
96
95
|
# @!method initialize(icon_url: nil, logo_url: nil, primary_color: nil, primary_color_contrast: nil)
|
97
96
|
# Some parameter documentations has been truncated, see
|
98
|
-
# {Knockapi::
|
97
|
+
# {Knockapi::Tenant::Settings::Branding} for more details.
|
99
98
|
#
|
100
99
|
# The branding for the tenant.
|
101
100
|
#
|
102
101
|
# @param icon_url [String, nil] The icon URL for the tenant. Must point to a valid image with an image MIME type
|
103
|
-
# ...
|
104
102
|
#
|
105
103
|
# @param logo_url [String, nil] The logo URL for the tenant. Must point to a valid image with an image MIME type
|
106
|
-
# ...
|
107
104
|
#
|
108
105
|
# @param primary_color [String, nil] The primary color for the tenant, provided as a hex value.
|
109
106
|
#
|
@@ -12,24 +12,26 @@ module Knockapi
|
|
12
12
|
# @!attribute channel_data
|
13
13
|
# A request to set channel data for a type of channel inline.
|
14
14
|
#
|
15
|
-
# @return [Hash{Symbol=>Knockapi::
|
15
|
+
# @return [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil]
|
16
16
|
optional :channel_data,
|
17
|
-
-> {
|
17
|
+
-> {
|
18
|
+
Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
|
19
|
+
},
|
18
20
|
nil?: true
|
19
21
|
|
20
22
|
# @!attribute preferences
|
21
23
|
# Inline set preferences for a recipient, where the key is the preference set id.
|
22
24
|
#
|
23
|
-
# @return [Hash{Symbol=>Knockapi::
|
25
|
+
# @return [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil]
|
24
26
|
optional :preferences,
|
25
|
-
-> { Knockapi::Internal::Type::HashOf[Knockapi::
|
27
|
+
-> { Knockapi::Internal::Type::HashOf[Knockapi::Recipients::PreferenceSetRequest] },
|
26
28
|
nil?: true
|
27
29
|
|
28
30
|
# @!attribute settings
|
29
31
|
# The settings for the tenant. Includes branding and preference set.
|
30
32
|
#
|
31
|
-
# @return [Knockapi::
|
32
|
-
optional :settings, -> { Knockapi::
|
33
|
+
# @return [Knockapi::TenantRequest::Settings, nil]
|
34
|
+
optional :settings, -> { Knockapi::TenantRequest::Settings }
|
33
35
|
|
34
36
|
# @!method initialize(id:, channel_data: nil, preferences: nil, settings: nil)
|
35
37
|
# A tenant to be set in the system. You can supply any additional properties on
|
@@ -37,34 +39,34 @@ module Knockapi
|
|
37
39
|
#
|
38
40
|
# @param id [String] The unique identifier for the tenant.
|
39
41
|
#
|
40
|
-
# @param channel_data [Hash{Symbol=>Knockapi::
|
42
|
+
# @param channel_data [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
|
41
43
|
#
|
42
|
-
# @param preferences [Hash{Symbol=>Knockapi::
|
44
|
+
# @param preferences [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
|
43
45
|
#
|
44
|
-
# @param settings [Knockapi::
|
46
|
+
# @param settings [Knockapi::TenantRequest::Settings] The settings for the tenant. Includes branding and preference set.
|
45
47
|
|
46
|
-
# @see Knockapi::
|
48
|
+
# @see Knockapi::TenantRequest#settings
|
47
49
|
class Settings < Knockapi::Internal::Type::BaseModel
|
48
50
|
# @!attribute branding
|
49
51
|
# The branding for the tenant.
|
50
52
|
#
|
51
|
-
# @return [Knockapi::
|
52
|
-
optional :branding, -> { Knockapi::
|
53
|
+
# @return [Knockapi::TenantRequest::Settings::Branding, nil]
|
54
|
+
optional :branding, -> { Knockapi::TenantRequest::Settings::Branding }
|
53
55
|
|
54
56
|
# @!attribute preference_set
|
55
57
|
# A request to set a preference set for a recipient.
|
56
58
|
#
|
57
|
-
# @return [Knockapi::
|
58
|
-
optional :preference_set, -> { Knockapi::
|
59
|
+
# @return [Knockapi::Recipients::PreferenceSetRequest, nil]
|
60
|
+
optional :preference_set, -> { Knockapi::Recipients::PreferenceSetRequest }, nil?: true
|
59
61
|
|
60
62
|
# @!method initialize(branding: nil, preference_set: nil)
|
61
63
|
# The settings for the tenant. Includes branding and preference set.
|
62
64
|
#
|
63
|
-
# @param branding [Knockapi::
|
65
|
+
# @param branding [Knockapi::TenantRequest::Settings::Branding] The branding for the tenant.
|
64
66
|
#
|
65
|
-
# @param preference_set [Knockapi::
|
67
|
+
# @param preference_set [Knockapi::Recipients::PreferenceSetRequest, nil] A request to set a preference set for a recipient.
|
66
68
|
|
67
|
-
# @see Knockapi::
|
69
|
+
# @see Knockapi::TenantRequest::Settings#branding
|
68
70
|
class Branding < Knockapi::Internal::Type::BaseModel
|
69
71
|
# @!attribute icon_url
|
70
72
|
# The icon URL for the tenant. Must point to a valid image with an image MIME
|
@@ -94,15 +96,13 @@ module Knockapi
|
|
94
96
|
|
95
97
|
# @!method initialize(icon_url: nil, logo_url: nil, primary_color: nil, primary_color_contrast: nil)
|
96
98
|
# Some parameter documentations has been truncated, see
|
97
|
-
# {Knockapi::
|
99
|
+
# {Knockapi::TenantRequest::Settings::Branding} for more details.
|
98
100
|
#
|
99
101
|
# The branding for the tenant.
|
100
102
|
#
|
101
103
|
# @param icon_url [String, nil] The icon URL for the tenant. Must point to a valid image with an image MIME type
|
102
|
-
# ...
|
103
104
|
#
|
104
105
|
# @param logo_url [String, nil] The logo URL for the tenant. Must point to a valid image with an image MIME type
|
105
|
-
# ...
|
106
106
|
#
|
107
107
|
# @param primary_color [String, nil] The primary color for the tenant, provided as a hex value.
|
108
108
|
#
|
@@ -10,31 +10,33 @@ module Knockapi
|
|
10
10
|
# @!attribute channel_data
|
11
11
|
# A request to set channel data for a type of channel inline.
|
12
12
|
#
|
13
|
-
# @return [Hash{Symbol=>Knockapi::
|
13
|
+
# @return [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil]
|
14
14
|
optional :channel_data,
|
15
|
-
-> {
|
15
|
+
-> {
|
16
|
+
Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
|
17
|
+
},
|
16
18
|
nil?: true
|
17
19
|
|
18
20
|
# @!attribute preferences
|
19
21
|
# Inline set preferences for a recipient, where the key is the preference set id.
|
20
22
|
#
|
21
|
-
# @return [Hash{Symbol=>Knockapi::
|
23
|
+
# @return [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil]
|
22
24
|
optional :preferences,
|
23
|
-
-> { Knockapi::Internal::Type::HashOf[Knockapi::
|
25
|
+
-> { Knockapi::Internal::Type::HashOf[Knockapi::Recipients::PreferenceSetRequest] },
|
24
26
|
nil?: true
|
25
27
|
|
26
28
|
# @!attribute settings
|
27
29
|
# The settings for the tenant. Includes branding and preference set.
|
28
30
|
#
|
29
|
-
# @return [Knockapi::
|
30
|
-
optional :settings, -> { Knockapi::
|
31
|
+
# @return [Knockapi::TenantSetParams::Settings, nil]
|
32
|
+
optional :settings, -> { Knockapi::TenantSetParams::Settings }
|
31
33
|
|
32
34
|
# @!method initialize(channel_data: nil, preferences: nil, settings: nil, request_options: {})
|
33
|
-
# @param channel_data [Hash{Symbol=>Knockapi::
|
35
|
+
# @param channel_data [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
|
34
36
|
#
|
35
|
-
# @param preferences [Hash{Symbol=>Knockapi::
|
37
|
+
# @param preferences [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
|
36
38
|
#
|
37
|
-
# @param settings [Knockapi::
|
39
|
+
# @param settings [Knockapi::TenantSetParams::Settings] The settings for the tenant. Includes branding and preference set.
|
38
40
|
#
|
39
41
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
40
42
|
|
@@ -42,23 +44,23 @@ module Knockapi
|
|
42
44
|
# @!attribute branding
|
43
45
|
# The branding for the tenant.
|
44
46
|
#
|
45
|
-
# @return [Knockapi::
|
46
|
-
optional :branding, -> { Knockapi::
|
47
|
+
# @return [Knockapi::TenantSetParams::Settings::Branding, nil]
|
48
|
+
optional :branding, -> { Knockapi::TenantSetParams::Settings::Branding }
|
47
49
|
|
48
50
|
# @!attribute preference_set
|
49
51
|
# A request to set a preference set for a recipient.
|
50
52
|
#
|
51
|
-
# @return [Knockapi::
|
52
|
-
optional :preference_set, -> { Knockapi::
|
53
|
+
# @return [Knockapi::Recipients::PreferenceSetRequest, nil]
|
54
|
+
optional :preference_set, -> { Knockapi::Recipients::PreferenceSetRequest }, nil?: true
|
53
55
|
|
54
56
|
# @!method initialize(branding: nil, preference_set: nil)
|
55
57
|
# The settings for the tenant. Includes branding and preference set.
|
56
58
|
#
|
57
|
-
# @param branding [Knockapi::
|
59
|
+
# @param branding [Knockapi::TenantSetParams::Settings::Branding] The branding for the tenant.
|
58
60
|
#
|
59
|
-
# @param preference_set [Knockapi::
|
61
|
+
# @param preference_set [Knockapi::Recipients::PreferenceSetRequest, nil] A request to set a preference set for a recipient.
|
60
62
|
|
61
|
-
# @see Knockapi::
|
63
|
+
# @see Knockapi::TenantSetParams::Settings#branding
|
62
64
|
class Branding < Knockapi::Internal::Type::BaseModel
|
63
65
|
# @!attribute icon_url
|
64
66
|
# The icon URL for the tenant. Must point to a valid image with an image MIME
|
@@ -88,15 +90,13 @@ module Knockapi
|
|
88
90
|
|
89
91
|
# @!method initialize(icon_url: nil, logo_url: nil, primary_color: nil, primary_color_contrast: nil)
|
90
92
|
# Some parameter documentations has been truncated, see
|
91
|
-
# {Knockapi::
|
93
|
+
# {Knockapi::TenantSetParams::Settings::Branding} for more details.
|
92
94
|
#
|
93
95
|
# The branding for the tenant.
|
94
96
|
#
|
95
97
|
# @param icon_url [String, nil] The icon URL for the tenant. Must point to a valid image with an image MIME type
|
96
|
-
# ...
|
97
98
|
#
|
98
99
|
# @param logo_url [String, nil] The logo URL for the tenant. Must point to a valid image with an image MIME type
|
99
|
-
# ...
|
100
100
|
#
|
101
101
|
# @param primary_color [String, nil] The primary color for the tenant, provided as a hex value.
|
102
102
|
#
|
@@ -11,11 +11,11 @@ module Knockapi
|
|
11
11
|
# @!attribute tenants
|
12
12
|
# The tenants to be upserted.
|
13
13
|
#
|
14
|
-
# @return [Array<String, Knockapi::
|
15
|
-
required :tenants, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::
|
14
|
+
# @return [Array<String, Knockapi::TenantRequest>]
|
15
|
+
required :tenants, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::InlineTenantRequest] }
|
16
16
|
|
17
17
|
# @!method initialize(tenants:, request_options: {})
|
18
|
-
# @param tenants [Array<String, Knockapi::
|
18
|
+
# @param tenants [Array<String, Knockapi::TenantRequest>] The tenants to be upserted.
|
19
19
|
#
|
20
20
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
21
21
|
end
|