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
@@ -1,6 +1,8 @@
|
|
1
1
|
module Knockapi
|
2
2
|
module Internal
|
3
3
|
module Util
|
4
|
+
extend Knockapi::Internal::Util::SorbetRuntimeSupport
|
5
|
+
|
4
6
|
def self?.monotonic_secs: -> Float
|
5
7
|
|
6
8
|
def self?.arch: -> String
|
@@ -19,6 +21,8 @@ module Knockapi
|
|
19
21
|
|
20
22
|
def self?.coerce_hash: (top input) -> (::Hash[top, top] | top)
|
21
23
|
|
24
|
+
def self?.coerce_hash!: (top input) -> ::Hash[top, top]?
|
25
|
+
|
22
26
|
def self?.deep_merge_lr: (top lhs, top rhs, ?concat: bool) -> top
|
23
27
|
|
24
28
|
def self?.deep_merge: (
|
@@ -153,6 +157,17 @@ module Knockapi
|
|
153
157
|
def self?.decode_sse: (
|
154
158
|
Enumerable[String] lines
|
155
159
|
) -> Enumerable[Knockapi::Internal::Util::server_sent_event]
|
160
|
+
|
161
|
+
module SorbetRuntimeSupport
|
162
|
+
class MissingSorbetRuntimeError < ::RuntimeError
|
163
|
+
end
|
164
|
+
|
165
|
+
private def sorbet_runtime_constants: -> ::Hash[Symbol, top]
|
166
|
+
|
167
|
+
def const_missing: (Symbol name) -> void
|
168
|
+
|
169
|
+
def define_sorbet_constant!: (Symbol name) { -> top } -> void
|
170
|
+
end
|
156
171
|
end
|
157
172
|
end
|
158
173
|
end
|
data/sig/knockapi/internal.rbs
CHANGED
@@ -1,40 +1,36 @@
|
|
1
1
|
module Knockapi
|
2
2
|
module Models
|
3
3
|
type audience_add_members_params =
|
4
|
-
{ members: ::Array[Knockapi::
|
4
|
+
{ members: ::Array[Knockapi::AudienceAddMembersParams::Member] }
|
5
5
|
& Knockapi::Internal::Type::request_parameters
|
6
6
|
|
7
7
|
class AudienceAddMembersParams < Knockapi::Internal::Type::BaseModel
|
8
8
|
extend Knockapi::Internal::Type::RequestParameters::Converter
|
9
9
|
include Knockapi::Internal::Type::RequestParameters
|
10
10
|
|
11
|
-
attr_accessor members: ::Array[Knockapi::
|
11
|
+
attr_accessor members: ::Array[Knockapi::AudienceAddMembersParams::Member]
|
12
12
|
|
13
13
|
def initialize: (
|
14
|
-
members: ::Array[Knockapi::
|
14
|
+
members: ::Array[Knockapi::AudienceAddMembersParams::Member],
|
15
15
|
?request_options: Knockapi::request_opts
|
16
16
|
) -> void
|
17
17
|
|
18
|
-
def to_hash: -> Knockapi::Models::audience_add_members_params
|
19
|
-
|
20
18
|
type member =
|
21
19
|
{
|
22
|
-
user: Knockapi::
|
20
|
+
user: Knockapi::AudienceAddMembersParams::Member::User,
|
23
21
|
tenant: String?
|
24
22
|
}
|
25
23
|
|
26
24
|
class Member < Knockapi::Internal::Type::BaseModel
|
27
|
-
attr_accessor user: Knockapi::
|
25
|
+
attr_accessor user: Knockapi::AudienceAddMembersParams::Member::User
|
28
26
|
|
29
27
|
attr_accessor tenant: String?
|
30
28
|
|
31
29
|
def initialize: (
|
32
|
-
user: Knockapi::
|
30
|
+
user: Knockapi::AudienceAddMembersParams::Member::User,
|
33
31
|
?tenant: String?
|
34
32
|
) -> void
|
35
33
|
|
36
|
-
def to_hash: -> Knockapi::Models::AudienceAddMembersParams::member
|
37
|
-
|
38
34
|
type user = { id: String }
|
39
35
|
|
40
36
|
class User < Knockapi::Internal::Type::BaseModel
|
@@ -43,8 +39,6 @@ module Knockapi
|
|
43
39
|
def id=: (String) -> String
|
44
40
|
|
45
41
|
def initialize: (?id: String) -> void
|
46
|
-
|
47
|
-
def to_hash: -> Knockapi::Models::AudienceAddMembersParams::Member::user
|
48
42
|
end
|
49
43
|
end
|
50
44
|
end
|
@@ -2,21 +2,19 @@ module Knockapi
|
|
2
2
|
module Models
|
3
3
|
type audience_list_members_response =
|
4
4
|
{
|
5
|
-
entries: ::Array[Knockapi::
|
6
|
-
page_info: Knockapi::
|
5
|
+
entries: ::Array[Knockapi::AudienceMember],
|
6
|
+
page_info: Knockapi::PageInfo
|
7
7
|
}
|
8
8
|
|
9
9
|
class AudienceListMembersResponse < Knockapi::Internal::Type::BaseModel
|
10
|
-
attr_accessor entries: ::Array[Knockapi::
|
10
|
+
attr_accessor entries: ::Array[Knockapi::AudienceMember]
|
11
11
|
|
12
|
-
attr_accessor page_info: Knockapi::
|
12
|
+
attr_accessor page_info: Knockapi::PageInfo
|
13
13
|
|
14
14
|
def initialize: (
|
15
|
-
entries: ::Array[Knockapi::
|
16
|
-
page_info: Knockapi::
|
15
|
+
entries: ::Array[Knockapi::AudienceMember],
|
16
|
+
page_info: Knockapi::PageInfo
|
17
17
|
) -> void
|
18
|
-
|
19
|
-
def to_hash: -> Knockapi::Models::audience_list_members_response
|
20
18
|
end
|
21
19
|
end
|
22
20
|
end
|
@@ -4,7 +4,7 @@ module Knockapi
|
|
4
4
|
{
|
5
5
|
_typename: String,
|
6
6
|
added_at: Time,
|
7
|
-
user: Knockapi::
|
7
|
+
user: Knockapi::User,
|
8
8
|
user_id: String,
|
9
9
|
tenant: String?
|
10
10
|
}
|
@@ -14,7 +14,7 @@ module Knockapi
|
|
14
14
|
|
15
15
|
attr_accessor added_at: Time
|
16
16
|
|
17
|
-
attr_accessor user: Knockapi::
|
17
|
+
attr_accessor user: Knockapi::User
|
18
18
|
|
19
19
|
attr_accessor user_id: String
|
20
20
|
|
@@ -23,12 +23,10 @@ module Knockapi
|
|
23
23
|
def initialize: (
|
24
24
|
_typename: String,
|
25
25
|
added_at: Time,
|
26
|
-
user: Knockapi::
|
26
|
+
user: Knockapi::User,
|
27
27
|
user_id: String,
|
28
28
|
?tenant: String?
|
29
29
|
) -> void
|
30
|
-
|
31
|
-
def to_hash: -> Knockapi::Models::audience_member
|
32
30
|
end
|
33
31
|
end
|
34
32
|
end
|
@@ -1,42 +1,36 @@
|
|
1
1
|
module Knockapi
|
2
2
|
module Models
|
3
3
|
type audience_remove_members_params =
|
4
|
-
{
|
5
|
-
members: ::Array[Knockapi::Models::AudienceRemoveMembersParams::Member]
|
6
|
-
}
|
4
|
+
{ members: ::Array[Knockapi::AudienceRemoveMembersParams::Member] }
|
7
5
|
& Knockapi::Internal::Type::request_parameters
|
8
6
|
|
9
7
|
class AudienceRemoveMembersParams < Knockapi::Internal::Type::BaseModel
|
10
8
|
extend Knockapi::Internal::Type::RequestParameters::Converter
|
11
9
|
include Knockapi::Internal::Type::RequestParameters
|
12
10
|
|
13
|
-
attr_accessor members: ::Array[Knockapi::
|
11
|
+
attr_accessor members: ::Array[Knockapi::AudienceRemoveMembersParams::Member]
|
14
12
|
|
15
13
|
def initialize: (
|
16
|
-
members: ::Array[Knockapi::
|
14
|
+
members: ::Array[Knockapi::AudienceRemoveMembersParams::Member],
|
17
15
|
?request_options: Knockapi::request_opts
|
18
16
|
) -> void
|
19
17
|
|
20
|
-
def to_hash: -> Knockapi::Models::audience_remove_members_params
|
21
|
-
|
22
18
|
type member =
|
23
19
|
{
|
24
|
-
user: Knockapi::
|
20
|
+
user: Knockapi::AudienceRemoveMembersParams::Member::User,
|
25
21
|
tenant: String?
|
26
22
|
}
|
27
23
|
|
28
24
|
class Member < Knockapi::Internal::Type::BaseModel
|
29
|
-
attr_accessor user: Knockapi::
|
25
|
+
attr_accessor user: Knockapi::AudienceRemoveMembersParams::Member::User
|
30
26
|
|
31
27
|
attr_accessor tenant: String?
|
32
28
|
|
33
29
|
def initialize: (
|
34
|
-
user: Knockapi::
|
30
|
+
user: Knockapi::AudienceRemoveMembersParams::Member::User,
|
35
31
|
?tenant: String?
|
36
32
|
) -> void
|
37
33
|
|
38
|
-
def to_hash: -> Knockapi::Models::AudienceRemoveMembersParams::member
|
39
|
-
|
40
34
|
type user = { id: String }
|
41
35
|
|
42
36
|
class User < Knockapi::Internal::Type::BaseModel
|
@@ -45,8 +39,6 @@ module Knockapi
|
|
45
39
|
def id=: (String) -> String
|
46
40
|
|
47
41
|
def initialize: (?id: String) -> void
|
48
|
-
|
49
|
-
def to_hash: -> Knockapi::Models::AudienceRemoveMembersParams::Member::user
|
50
42
|
end
|
51
43
|
end
|
52
44
|
end
|
@@ -8,12 +8,12 @@ module Knockapi
|
|
8
8
|
inserted_at: Time,
|
9
9
|
name: String,
|
10
10
|
processed_rows: Integer,
|
11
|
-
status: Knockapi::
|
11
|
+
status: Knockapi::BulkOperation::status,
|
12
12
|
success_count: Integer,
|
13
13
|
updated_at: Time,
|
14
14
|
completed_at: Time?,
|
15
15
|
error_count: Integer,
|
16
|
-
error_items: ::Array[Knockapi::
|
16
|
+
error_items: ::Array[Knockapi::BulkOperation::ErrorItem],
|
17
17
|
failed_at: Time?,
|
18
18
|
progress_path: String,
|
19
19
|
started_at: Time?
|
@@ -32,7 +32,7 @@ module Knockapi
|
|
32
32
|
|
33
33
|
attr_accessor processed_rows: Integer
|
34
34
|
|
35
|
-
attr_accessor status: Knockapi::
|
35
|
+
attr_accessor status: Knockapi::BulkOperation::status
|
36
36
|
|
37
37
|
attr_accessor success_count: Integer
|
38
38
|
|
@@ -44,11 +44,11 @@ module Knockapi
|
|
44
44
|
|
45
45
|
def error_count=: (Integer) -> Integer
|
46
46
|
|
47
|
-
attr_reader error_items: ::Array[Knockapi::
|
47
|
+
attr_reader error_items: ::Array[Knockapi::BulkOperation::ErrorItem]?
|
48
48
|
|
49
49
|
def error_items=: (
|
50
|
-
::Array[Knockapi::
|
51
|
-
) -> ::Array[Knockapi::
|
50
|
+
::Array[Knockapi::BulkOperation::ErrorItem]
|
51
|
+
) -> ::Array[Knockapi::BulkOperation::ErrorItem]
|
52
52
|
|
53
53
|
attr_accessor failed_at: Time?
|
54
54
|
|
@@ -65,19 +65,17 @@ module Knockapi
|
|
65
65
|
inserted_at: Time,
|
66
66
|
name: String,
|
67
67
|
processed_rows: Integer,
|
68
|
-
status: Knockapi::
|
68
|
+
status: Knockapi::BulkOperation::status,
|
69
69
|
success_count: Integer,
|
70
70
|
updated_at: Time,
|
71
71
|
?completed_at: Time?,
|
72
72
|
?error_count: Integer,
|
73
|
-
?error_items: ::Array[Knockapi::
|
73
|
+
?error_items: ::Array[Knockapi::BulkOperation::ErrorItem],
|
74
74
|
?failed_at: Time?,
|
75
75
|
?progress_path: String,
|
76
76
|
?started_at: Time?
|
77
77
|
) -> void
|
78
78
|
|
79
|
-
def to_hash: -> Knockapi::Models::bulk_operation
|
80
|
-
|
81
79
|
type status = :queued | :processing | :completed | :failed
|
82
80
|
|
83
81
|
module Status
|
@@ -88,7 +86,7 @@ module Knockapi
|
|
88
86
|
COMPLETED: :completed
|
89
87
|
FAILED: :failed
|
90
88
|
|
91
|
-
def self?.values: -> ::Array[Knockapi::
|
89
|
+
def self?.values: -> ::Array[Knockapi::BulkOperation::status]
|
92
90
|
end
|
93
91
|
|
94
92
|
type error_item = { id: String, collection: String? }
|
@@ -99,8 +97,6 @@ module Knockapi
|
|
99
97
|
attr_accessor collection: String?
|
100
98
|
|
101
99
|
def initialize: (id: String, ?collection: String?) -> void
|
102
|
-
|
103
|
-
def to_hash: -> Knockapi::Models::BulkOperation::error_item
|
104
100
|
end
|
105
101
|
end
|
106
102
|
end
|
@@ -3,25 +3,23 @@ module Knockapi
|
|
3
3
|
type condition =
|
4
4
|
{
|
5
5
|
argument: String?,
|
6
|
-
operator: Knockapi::
|
6
|
+
operator: Knockapi::Condition::operator,
|
7
7
|
variable: String
|
8
8
|
}
|
9
9
|
|
10
10
|
class Condition < Knockapi::Internal::Type::BaseModel
|
11
11
|
attr_accessor argument: String?
|
12
12
|
|
13
|
-
attr_accessor operator: Knockapi::
|
13
|
+
attr_accessor operator: Knockapi::Condition::operator
|
14
14
|
|
15
15
|
attr_accessor variable: String
|
16
16
|
|
17
17
|
def initialize: (
|
18
18
|
argument: String?,
|
19
|
-
operator: Knockapi::
|
19
|
+
operator: Knockapi::Condition::operator,
|
20
20
|
variable: String
|
21
21
|
) -> void
|
22
22
|
|
23
|
-
def to_hash: -> Knockapi::Models::condition
|
24
|
-
|
25
23
|
type operator =
|
26
24
|
:equal_to
|
27
25
|
| :not_equal_to
|
@@ -64,7 +62,7 @@ module Knockapi
|
|
64
62
|
IS_AUDIENCE_MEMBER: :is_audience_member
|
65
63
|
IS_NOT_AUDIENCE_MEMBER: :is_not_audience_member
|
66
64
|
|
67
|
-
def self?.values: -> ::Array[Knockapi::
|
65
|
+
def self?.values: -> ::Array[Knockapi::Condition::operator]
|
68
66
|
end
|
69
67
|
end
|
70
68
|
end
|
@@ -3,28 +3,50 @@ module Knockapi
|
|
3
3
|
type inline_identify_user_request =
|
4
4
|
{
|
5
5
|
id: String,
|
6
|
+
avatar: String?,
|
6
7
|
channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
|
7
8
|
created_at: Time?,
|
8
|
-
|
9
|
+
email: String?,
|
10
|
+
locale: String?,
|
11
|
+
name: String?,
|
12
|
+
phone_number: String?,
|
13
|
+
preferences: Knockapi::Models::Recipients::inline_preference_set_request?,
|
14
|
+
timezone: String?
|
9
15
|
}
|
10
16
|
|
11
17
|
class InlineIdentifyUserRequest < Knockapi::Internal::Type::BaseModel
|
12
18
|
attr_accessor id: String
|
13
19
|
|
20
|
+
attr_accessor avatar: String?
|
21
|
+
|
14
22
|
attr_accessor channel_data: Knockapi::Models::Recipients::inline_channel_data_request?
|
15
23
|
|
16
24
|
attr_accessor created_at: Time?
|
17
25
|
|
26
|
+
attr_accessor email: String?
|
27
|
+
|
28
|
+
attr_accessor locale: String?
|
29
|
+
|
30
|
+
attr_accessor name: String?
|
31
|
+
|
32
|
+
attr_accessor phone_number: String?
|
33
|
+
|
18
34
|
attr_accessor preferences: Knockapi::Models::Recipients::inline_preference_set_request?
|
19
35
|
|
36
|
+
attr_accessor timezone: String?
|
37
|
+
|
20
38
|
def initialize: (
|
21
39
|
id: String,
|
40
|
+
?avatar: String?,
|
22
41
|
?channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
|
23
42
|
?created_at: Time?,
|
24
|
-
?
|
43
|
+
?email: String?,
|
44
|
+
?locale: String?,
|
45
|
+
?name: String?,
|
46
|
+
?phone_number: String?,
|
47
|
+
?preferences: Knockapi::Models::Recipients::inline_preference_set_request?,
|
48
|
+
?timezone: String?
|
25
49
|
) -> void
|
26
|
-
|
27
|
-
def to_hash: -> Knockapi::Models::inline_identify_user_request
|
28
50
|
end
|
29
51
|
end
|
30
52
|
end
|
@@ -1,11 +1,11 @@
|
|
1
1
|
module Knockapi
|
2
2
|
module Models
|
3
|
-
type inline_tenant_request = String | Knockapi::
|
3
|
+
type inline_tenant_request = String | Knockapi::TenantRequest
|
4
4
|
|
5
5
|
module InlineTenantRequest
|
6
6
|
extend Knockapi::Internal::Type::Union
|
7
7
|
|
8
|
-
def self?.variants: -> [
|
8
|
+
def self?.variants: -> ::Array[Knockapi::Models::inline_tenant_request]
|
9
9
|
end
|
10
10
|
end
|
11
11
|
end
|
@@ -14,8 +14,6 @@ module Knockapi
|
|
14
14
|
def result=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
|
15
15
|
|
16
16
|
def initialize: (?id: String, ?result: ::Hash[Symbol, top]) -> void
|
17
|
-
|
18
|
-
def to_hash: -> Knockapi::Models::Integrations::census_custom_destination_response
|
19
17
|
end
|
20
18
|
end
|
21
19
|
end
|
@@ -14,8 +14,6 @@ module Knockapi
|
|
14
14
|
def result=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
|
15
15
|
|
16
16
|
def initialize: (?id: String, ?result: ::Hash[Symbol, top]) -> void
|
17
|
-
|
18
|
-
def to_hash: -> Knockapi::Models::Integrations::hightouch_embedded_destination_response
|
19
17
|
end
|
20
18
|
end
|
21
19
|
end
|
@@ -9,7 +9,7 @@ module Knockapi
|
|
9
9
|
channel_id: String,
|
10
10
|
clicked_at: Time?,
|
11
11
|
data: ::Hash[Symbol, top]?,
|
12
|
-
engagement_statuses: ::Array[Knockapi::
|
12
|
+
engagement_statuses: ::Array[Knockapi::Message::engagement_status],
|
13
13
|
inserted_at: Time,
|
14
14
|
interacted_at: Time?,
|
15
15
|
link_clicked_at: Time?,
|
@@ -18,8 +18,8 @@ module Knockapi
|
|
18
18
|
recipient: Knockapi::Models::recipient_reference,
|
19
19
|
scheduled_at: Time?,
|
20
20
|
seen_at: Time?,
|
21
|
-
source: Knockapi::
|
22
|
-
status: Knockapi::
|
21
|
+
source: Knockapi::Message::Source,
|
22
|
+
status: Knockapi::Message::status,
|
23
23
|
tenant: String?,
|
24
24
|
updated_at: Time,
|
25
25
|
workflow: String?
|
@@ -50,11 +50,11 @@ module Knockapi
|
|
50
50
|
|
51
51
|
attr_accessor data: ::Hash[Symbol, top]?
|
52
52
|
|
53
|
-
attr_reader engagement_statuses: ::Array[Knockapi::
|
53
|
+
attr_reader engagement_statuses: ::Array[Knockapi::Message::engagement_status]?
|
54
54
|
|
55
55
|
def engagement_statuses=: (
|
56
|
-
::Array[Knockapi::
|
57
|
-
) -> ::Array[Knockapi::
|
56
|
+
::Array[Knockapi::Message::engagement_status]
|
57
|
+
) -> ::Array[Knockapi::Message::engagement_status]
|
58
58
|
|
59
59
|
attr_reader inserted_at: Time?
|
60
60
|
|
@@ -78,17 +78,13 @@ module Knockapi
|
|
78
78
|
|
79
79
|
attr_accessor seen_at: Time?
|
80
80
|
|
81
|
-
attr_reader source: Knockapi::
|
81
|
+
attr_reader source: Knockapi::Message::Source?
|
82
82
|
|
83
|
-
def source=: (
|
84
|
-
Knockapi::Models::Message::Source
|
85
|
-
) -> Knockapi::Models::Message::Source
|
83
|
+
def source=: (Knockapi::Message::Source) -> Knockapi::Message::Source
|
86
84
|
|
87
|
-
attr_reader status: Knockapi::
|
85
|
+
attr_reader status: Knockapi::Message::status?
|
88
86
|
|
89
|
-
def status=: (
|
90
|
-
Knockapi::Models::Message::status
|
91
|
-
) -> Knockapi::Models::Message::status
|
87
|
+
def status=: (Knockapi::Message::status) -> Knockapi::Message::status
|
92
88
|
|
93
89
|
attr_accessor tenant: String?
|
94
90
|
|
@@ -106,7 +102,7 @@ module Knockapi
|
|
106
102
|
?channel_id: String,
|
107
103
|
?clicked_at: Time?,
|
108
104
|
?data: ::Hash[Symbol, top]?,
|
109
|
-
?engagement_statuses: ::Array[Knockapi::
|
105
|
+
?engagement_statuses: ::Array[Knockapi::Message::engagement_status],
|
110
106
|
?inserted_at: Time,
|
111
107
|
?interacted_at: Time?,
|
112
108
|
?link_clicked_at: Time?,
|
@@ -115,15 +111,13 @@ module Knockapi
|
|
115
111
|
?recipient: Knockapi::Models::recipient_reference,
|
116
112
|
?scheduled_at: Time?,
|
117
113
|
?seen_at: Time?,
|
118
|
-
?source: Knockapi::
|
119
|
-
?status: Knockapi::
|
114
|
+
?source: Knockapi::Message::Source,
|
115
|
+
?status: Knockapi::Message::status,
|
120
116
|
?tenant: String?,
|
121
117
|
?updated_at: Time,
|
122
118
|
?workflow: String?
|
123
119
|
) -> void
|
124
120
|
|
125
|
-
def to_hash: -> Knockapi::Models::message
|
126
|
-
|
127
121
|
type engagement_status =
|
128
122
|
:seen | :read | :interacted | :link_clicked | :archived
|
129
123
|
|
@@ -136,7 +130,7 @@ module Knockapi
|
|
136
130
|
LINK_CLICKED: :link_clicked
|
137
131
|
ARCHIVED: :archived
|
138
132
|
|
139
|
-
def self?.values: -> ::Array[Knockapi::
|
133
|
+
def self?.values: -> ::Array[Knockapi::Message::engagement_status]
|
140
134
|
end
|
141
135
|
|
142
136
|
type source =
|
@@ -162,8 +156,6 @@ module Knockapi
|
|
162
156
|
key: String,
|
163
157
|
version_id: String
|
164
158
|
) -> void
|
165
|
-
|
166
|
-
def to_hash: -> Knockapi::Models::Message::source
|
167
159
|
end
|
168
160
|
|
169
161
|
type status =
|
@@ -186,7 +178,7 @@ module Knockapi
|
|
186
178
|
NOT_SENT: :not_sent
|
187
179
|
BOUNCED: :bounced
|
188
180
|
|
189
|
-
def self?.values: -> ::Array[Knockapi::
|
181
|
+
def self?.values: -> ::Array[Knockapi::Message::status]
|
190
182
|
end
|
191
183
|
end
|
192
184
|
end
|