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
@@ -4,36 +4,62 @@ module Knockapi
|
|
4
4
|
module Models
|
5
5
|
module Providers
|
6
6
|
class MsTeamListChannelsResponse < Knockapi::Internal::Type::BaseModel
|
7
|
+
OrHash =
|
8
|
+
T.type_alias do
|
9
|
+
T.any(
|
10
|
+
Knockapi::Models::Providers::MsTeamListChannelsResponse,
|
11
|
+
Knockapi::Internal::AnyHash
|
12
|
+
)
|
13
|
+
end
|
14
|
+
|
7
15
|
# List of Microsoft Teams channels.
|
8
|
-
sig
|
16
|
+
sig do
|
17
|
+
returns(
|
18
|
+
T::Array[
|
19
|
+
Knockapi::Models::Providers::MsTeamListChannelsResponse::MsTeamsChannel
|
20
|
+
]
|
21
|
+
)
|
22
|
+
end
|
9
23
|
attr_accessor :ms_teams_channels
|
10
24
|
|
11
25
|
# The response from a Microsoft Teams provider request, containing a list of
|
12
26
|
# channels.
|
13
27
|
sig do
|
14
28
|
params(
|
15
|
-
ms_teams_channels:
|
16
|
-
T
|
17
|
-
Knockapi::Models::Providers::MsTeamListChannelsResponse::MsTeamsChannel
|
18
|
-
|
19
|
-
|
20
|
-
]
|
21
|
-
)
|
22
|
-
.returns(T.attached_class)
|
29
|
+
ms_teams_channels:
|
30
|
+
T::Array[
|
31
|
+
Knockapi::Models::Providers::MsTeamListChannelsResponse::MsTeamsChannel::OrHash
|
32
|
+
]
|
33
|
+
).returns(T.attached_class)
|
23
34
|
end
|
24
35
|
def self.new(
|
25
36
|
# List of Microsoft Teams channels.
|
26
37
|
ms_teams_channels:
|
27
|
-
)
|
38
|
+
)
|
39
|
+
end
|
40
|
+
|
28
41
|
sig do
|
29
|
-
override
|
30
|
-
|
31
|
-
|
32
|
-
|
42
|
+
override.returns(
|
43
|
+
{
|
44
|
+
ms_teams_channels:
|
45
|
+
T::Array[
|
46
|
+
Knockapi::Models::Providers::MsTeamListChannelsResponse::MsTeamsChannel
|
47
|
+
]
|
48
|
+
}
|
49
|
+
)
|
50
|
+
end
|
51
|
+
def to_hash
|
33
52
|
end
|
34
|
-
def to_hash; end
|
35
53
|
|
36
54
|
class MsTeamsChannel < Knockapi::Internal::Type::BaseModel
|
55
|
+
OrHash =
|
56
|
+
T.type_alias do
|
57
|
+
T.any(
|
58
|
+
Knockapi::Models::Providers::MsTeamListChannelsResponse::MsTeamsChannel,
|
59
|
+
Knockapi::Internal::AnyHash
|
60
|
+
)
|
61
|
+
end
|
62
|
+
|
37
63
|
# Microsoft Teams channel ID.
|
38
64
|
sig { returns(String) }
|
39
65
|
attr_accessor :id
|
@@ -75,8 +101,7 @@ module Knockapi
|
|
75
101
|
description: T.nilable(String),
|
76
102
|
is_archived: T::Boolean,
|
77
103
|
membership_type: String
|
78
|
-
)
|
79
|
-
.returns(T.attached_class)
|
104
|
+
).returns(T.attached_class)
|
80
105
|
end
|
81
106
|
def self.new(
|
82
107
|
# Microsoft Teams channel ID.
|
@@ -91,21 +116,23 @@ module Knockapi
|
|
91
116
|
is_archived: nil,
|
92
117
|
# Microsoft Teams channel membership type.
|
93
118
|
membership_type: nil
|
94
|
-
)
|
119
|
+
)
|
120
|
+
end
|
121
|
+
|
95
122
|
sig do
|
96
|
-
override
|
97
|
-
|
98
|
-
|
99
|
-
|
100
|
-
|
101
|
-
|
102
|
-
|
103
|
-
|
104
|
-
|
105
|
-
|
106
|
-
|
123
|
+
override.returns(
|
124
|
+
{
|
125
|
+
id: String,
|
126
|
+
display_name: String,
|
127
|
+
created_date_time: String,
|
128
|
+
description: T.nilable(String),
|
129
|
+
is_archived: T::Boolean,
|
130
|
+
membership_type: String
|
131
|
+
}
|
132
|
+
)
|
133
|
+
end
|
134
|
+
def to_hash
|
107
135
|
end
|
108
|
-
def to_hash; end
|
109
136
|
end
|
110
137
|
end
|
111
138
|
end
|
@@ -7,48 +7,71 @@ module Knockapi
|
|
7
7
|
extend Knockapi::Internal::Type::RequestParameters::Converter
|
8
8
|
include Knockapi::Internal::Type::RequestParameters
|
9
9
|
|
10
|
+
OrHash =
|
11
|
+
T.type_alias do
|
12
|
+
T.any(
|
13
|
+
Knockapi::Providers::MsTeamListTeamsParams,
|
14
|
+
Knockapi::Internal::AnyHash
|
15
|
+
)
|
16
|
+
end
|
17
|
+
|
10
18
|
# A JSON encoded string containing the Microsoft Teams tenant object reference.
|
11
19
|
sig { returns(String) }
|
12
20
|
attr_accessor :ms_teams_tenant_object
|
13
21
|
|
14
|
-
sig
|
22
|
+
sig do
|
23
|
+
returns(
|
24
|
+
T.nilable(Knockapi::Providers::MsTeamListTeamsParams::QueryOptions)
|
25
|
+
)
|
26
|
+
end
|
15
27
|
attr_reader :query_options
|
16
28
|
|
17
29
|
sig do
|
18
30
|
params(
|
19
|
-
query_options:
|
20
|
-
|
21
|
-
|
31
|
+
query_options:
|
32
|
+
Knockapi::Providers::MsTeamListTeamsParams::QueryOptions::OrHash
|
33
|
+
).void
|
22
34
|
end
|
23
35
|
attr_writer :query_options
|
24
36
|
|
25
37
|
sig do
|
26
38
|
params(
|
27
39
|
ms_teams_tenant_object: String,
|
28
|
-
query_options:
|
29
|
-
|
30
|
-
|
31
|
-
|
40
|
+
query_options:
|
41
|
+
Knockapi::Providers::MsTeamListTeamsParams::QueryOptions::OrHash,
|
42
|
+
request_options: Knockapi::RequestOptions::OrHash
|
43
|
+
).returns(T.attached_class)
|
32
44
|
end
|
33
45
|
def self.new(
|
34
46
|
# A JSON encoded string containing the Microsoft Teams tenant object reference.
|
35
47
|
ms_teams_tenant_object:,
|
36
48
|
query_options: nil,
|
37
49
|
request_options: {}
|
38
|
-
)
|
50
|
+
)
|
51
|
+
end
|
52
|
+
|
39
53
|
sig do
|
40
|
-
override
|
41
|
-
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
54
|
+
override.returns(
|
55
|
+
{
|
56
|
+
ms_teams_tenant_object: String,
|
57
|
+
query_options:
|
58
|
+
Knockapi::Providers::MsTeamListTeamsParams::QueryOptions,
|
59
|
+
request_options: Knockapi::RequestOptions
|
60
|
+
}
|
61
|
+
)
|
62
|
+
end
|
63
|
+
def to_hash
|
48
64
|
end
|
49
|
-
def to_hash; end
|
50
65
|
|
51
66
|
class QueryOptions < Knockapi::Internal::Type::BaseModel
|
67
|
+
OrHash =
|
68
|
+
T.type_alias do
|
69
|
+
T.any(
|
70
|
+
Knockapi::Providers::MsTeamListTeamsParams::QueryOptions,
|
71
|
+
Knockapi::Internal::AnyHash
|
72
|
+
)
|
73
|
+
end
|
74
|
+
|
52
75
|
# [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed
|
53
76
|
# to the Microsoft Graph API to filter teams.
|
54
77
|
sig { returns(T.nilable(String)) }
|
@@ -82,7 +105,12 @@ module Knockapi
|
|
82
105
|
attr_writer :top
|
83
106
|
|
84
107
|
sig do
|
85
|
-
params(
|
108
|
+
params(
|
109
|
+
filter: String,
|
110
|
+
select_: String,
|
111
|
+
skiptoken: String,
|
112
|
+
top: Integer
|
113
|
+
).returns(T.attached_class)
|
86
114
|
end
|
87
115
|
def self.new(
|
88
116
|
# [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed
|
@@ -97,9 +125,21 @@ module Knockapi
|
|
97
125
|
# [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed
|
98
126
|
# to the Microsoft Graph API to limit the number of teams returned.
|
99
127
|
top: nil
|
100
|
-
)
|
101
|
-
|
102
|
-
|
128
|
+
)
|
129
|
+
end
|
130
|
+
|
131
|
+
sig do
|
132
|
+
override.returns(
|
133
|
+
{
|
134
|
+
filter: String,
|
135
|
+
select_: String,
|
136
|
+
skiptoken: String,
|
137
|
+
top: Integer
|
138
|
+
}
|
139
|
+
)
|
140
|
+
end
|
141
|
+
def to_hash
|
142
|
+
end
|
103
143
|
end
|
104
144
|
end
|
105
145
|
end
|
@@ -4,6 +4,14 @@ module Knockapi
|
|
4
4
|
module Models
|
5
5
|
module Providers
|
6
6
|
class MsTeamListTeamsResponse < Knockapi::Internal::Type::BaseModel
|
7
|
+
OrHash =
|
8
|
+
T.type_alias do
|
9
|
+
T.any(
|
10
|
+
Knockapi::Models::Providers::MsTeamListTeamsResponse,
|
11
|
+
Knockapi::Internal::AnyHash
|
12
|
+
)
|
13
|
+
end
|
14
|
+
|
7
15
|
# Microsoft Teams team ID.
|
8
16
|
sig { returns(String) }
|
9
17
|
attr_accessor :id
|
@@ -17,7 +25,11 @@ module Knockapi
|
|
17
25
|
attr_accessor :description
|
18
26
|
|
19
27
|
sig do
|
20
|
-
params(
|
28
|
+
params(
|
29
|
+
id: String,
|
30
|
+
display_name: String,
|
31
|
+
description: T.nilable(String)
|
32
|
+
).returns(T.attached_class)
|
21
33
|
end
|
22
34
|
def self.new(
|
23
35
|
# Microsoft Teams team ID.
|
@@ -26,9 +38,16 @@ module Knockapi
|
|
26
38
|
display_name:,
|
27
39
|
# Microsoft Teams team description.
|
28
40
|
description: nil
|
29
|
-
)
|
30
|
-
|
31
|
-
|
41
|
+
)
|
42
|
+
end
|
43
|
+
|
44
|
+
sig do
|
45
|
+
override.returns(
|
46
|
+
{ id: String, display_name: String, description: T.nilable(String) }
|
47
|
+
)
|
48
|
+
end
|
49
|
+
def to_hash
|
50
|
+
end
|
32
51
|
end
|
33
52
|
end
|
34
53
|
end
|
@@ -7,6 +7,14 @@ module Knockapi
|
|
7
7
|
extend Knockapi::Internal::Type::RequestParameters::Converter
|
8
8
|
include Knockapi::Internal::Type::RequestParameters
|
9
9
|
|
10
|
+
OrHash =
|
11
|
+
T.type_alias do
|
12
|
+
T.any(
|
13
|
+
Knockapi::Providers::MsTeamRevokeAccessParams,
|
14
|
+
Knockapi::Internal::AnyHash
|
15
|
+
)
|
16
|
+
end
|
17
|
+
|
10
18
|
# A JSON encoded string containing the Microsoft Teams tenant object reference.
|
11
19
|
sig { returns(String) }
|
12
20
|
attr_accessor :ms_teams_tenant_object
|
@@ -14,17 +22,26 @@ module Knockapi
|
|
14
22
|
sig do
|
15
23
|
params(
|
16
24
|
ms_teams_tenant_object: String,
|
17
|
-
request_options:
|
18
|
-
)
|
19
|
-
.returns(T.attached_class)
|
25
|
+
request_options: Knockapi::RequestOptions::OrHash
|
26
|
+
).returns(T.attached_class)
|
20
27
|
end
|
21
28
|
def self.new(
|
22
29
|
# A JSON encoded string containing the Microsoft Teams tenant object reference.
|
23
30
|
ms_teams_tenant_object:,
|
24
31
|
request_options: {}
|
25
|
-
)
|
26
|
-
|
27
|
-
|
32
|
+
)
|
33
|
+
end
|
34
|
+
|
35
|
+
sig do
|
36
|
+
override.returns(
|
37
|
+
{
|
38
|
+
ms_teams_tenant_object: String,
|
39
|
+
request_options: Knockapi::RequestOptions
|
40
|
+
}
|
41
|
+
)
|
42
|
+
end
|
43
|
+
def to_hash
|
44
|
+
end
|
28
45
|
end
|
29
46
|
end
|
30
47
|
end
|
@@ -4,6 +4,14 @@ module Knockapi
|
|
4
4
|
module Models
|
5
5
|
module Providers
|
6
6
|
class MsTeamRevokeAccessResponse < Knockapi::Internal::Type::BaseModel
|
7
|
+
OrHash =
|
8
|
+
T.type_alias do
|
9
|
+
T.any(
|
10
|
+
Knockapi::Models::Providers::MsTeamRevokeAccessResponse,
|
11
|
+
Knockapi::Internal::AnyHash
|
12
|
+
)
|
13
|
+
end
|
14
|
+
|
7
15
|
# OK response.
|
8
16
|
sig { returns(T.nilable(String)) }
|
9
17
|
attr_reader :ok
|
@@ -16,9 +24,12 @@ module Knockapi
|
|
16
24
|
def self.new(
|
17
25
|
# OK response.
|
18
26
|
ok: nil
|
19
|
-
)
|
20
|
-
|
21
|
-
|
27
|
+
)
|
28
|
+
end
|
29
|
+
|
30
|
+
sig { override.returns({ ok: String }) }
|
31
|
+
def to_hash
|
32
|
+
end
|
22
33
|
end
|
23
34
|
end
|
24
35
|
end
|
@@ -7,6 +7,14 @@ module Knockapi
|
|
7
7
|
extend Knockapi::Internal::Type::RequestParameters::Converter
|
8
8
|
include Knockapi::Internal::Type::RequestParameters
|
9
9
|
|
10
|
+
OrHash =
|
11
|
+
T.type_alias do
|
12
|
+
T.any(
|
13
|
+
Knockapi::Providers::SlackCheckAuthParams,
|
14
|
+
Knockapi::Internal::AnyHash
|
15
|
+
)
|
16
|
+
end
|
17
|
+
|
10
18
|
# A JSON encoded string containing the access token object reference.
|
11
19
|
sig { returns(String) }
|
12
20
|
attr_accessor :access_token_object
|
@@ -14,17 +22,26 @@ module Knockapi
|
|
14
22
|
sig do
|
15
23
|
params(
|
16
24
|
access_token_object: String,
|
17
|
-
request_options:
|
18
|
-
)
|
19
|
-
.returns(T.attached_class)
|
25
|
+
request_options: Knockapi::RequestOptions::OrHash
|
26
|
+
).returns(T.attached_class)
|
20
27
|
end
|
21
28
|
def self.new(
|
22
29
|
# A JSON encoded string containing the access token object reference.
|
23
30
|
access_token_object:,
|
24
31
|
request_options: {}
|
25
|
-
)
|
26
|
-
|
27
|
-
|
32
|
+
)
|
33
|
+
end
|
34
|
+
|
35
|
+
sig do
|
36
|
+
override.returns(
|
37
|
+
{
|
38
|
+
access_token_object: String,
|
39
|
+
request_options: Knockapi::RequestOptions
|
40
|
+
}
|
41
|
+
)
|
42
|
+
end
|
43
|
+
def to_hash
|
44
|
+
end
|
28
45
|
end
|
29
46
|
end
|
30
47
|
end
|
@@ -4,33 +4,63 @@ module Knockapi
|
|
4
4
|
module Models
|
5
5
|
module Providers
|
6
6
|
class SlackCheckAuthResponse < Knockapi::Internal::Type::BaseModel
|
7
|
+
OrHash =
|
8
|
+
T.type_alias do
|
9
|
+
T.any(
|
10
|
+
Knockapi::Models::Providers::SlackCheckAuthResponse,
|
11
|
+
Knockapi::Internal::AnyHash
|
12
|
+
)
|
13
|
+
end
|
14
|
+
|
7
15
|
# A Slack connection object.
|
8
|
-
sig
|
16
|
+
sig do
|
17
|
+
returns(
|
18
|
+
Knockapi::Models::Providers::SlackCheckAuthResponse::Connection
|
19
|
+
)
|
20
|
+
end
|
9
21
|
attr_reader :connection
|
10
22
|
|
11
23
|
sig do
|
12
24
|
params(
|
13
|
-
connection:
|
14
|
-
|
15
|
-
|
25
|
+
connection:
|
26
|
+
Knockapi::Models::Providers::SlackCheckAuthResponse::Connection::OrHash
|
27
|
+
).void
|
16
28
|
end
|
17
29
|
attr_writer :connection
|
18
30
|
|
19
31
|
# The response from a Slack auth check request.
|
20
32
|
sig do
|
21
33
|
params(
|
22
|
-
connection:
|
23
|
-
|
24
|
-
|
34
|
+
connection:
|
35
|
+
Knockapi::Models::Providers::SlackCheckAuthResponse::Connection::OrHash
|
36
|
+
).returns(T.attached_class)
|
25
37
|
end
|
26
38
|
def self.new(
|
27
39
|
# A Slack connection object.
|
28
40
|
connection:
|
29
|
-
)
|
30
|
-
|
31
|
-
|
41
|
+
)
|
42
|
+
end
|
43
|
+
|
44
|
+
sig do
|
45
|
+
override.returns(
|
46
|
+
{
|
47
|
+
connection:
|
48
|
+
Knockapi::Models::Providers::SlackCheckAuthResponse::Connection
|
49
|
+
}
|
50
|
+
)
|
51
|
+
end
|
52
|
+
def to_hash
|
53
|
+
end
|
32
54
|
|
33
55
|
class Connection < Knockapi::Internal::Type::BaseModel
|
56
|
+
OrHash =
|
57
|
+
T.type_alias do
|
58
|
+
T.any(
|
59
|
+
Knockapi::Models::Providers::SlackCheckAuthResponse::Connection,
|
60
|
+
Knockapi::Internal::AnyHash
|
61
|
+
)
|
62
|
+
end
|
63
|
+
|
34
64
|
# Whether the Slack connection is valid.
|
35
65
|
sig { returns(T::Boolean) }
|
36
66
|
attr_accessor :ok
|
@@ -40,15 +70,24 @@ module Knockapi
|
|
40
70
|
attr_accessor :reason
|
41
71
|
|
42
72
|
# A Slack connection object.
|
43
|
-
sig
|
73
|
+
sig do
|
74
|
+
params(ok: T::Boolean, reason: T.nilable(String)).returns(
|
75
|
+
T.attached_class
|
76
|
+
)
|
77
|
+
end
|
44
78
|
def self.new(
|
45
79
|
# Whether the Slack connection is valid.
|
46
80
|
ok:,
|
47
81
|
# The reason for the Slack connection if it is not valid.
|
48
82
|
reason: nil
|
49
|
-
)
|
50
|
-
|
51
|
-
|
83
|
+
)
|
84
|
+
end
|
85
|
+
|
86
|
+
sig do
|
87
|
+
override.returns({ ok: T::Boolean, reason: T.nilable(String) })
|
88
|
+
end
|
89
|
+
def to_hash
|
90
|
+
end
|
52
91
|
end
|
53
92
|
end
|
54
93
|
end
|
@@ -7,48 +7,73 @@ module Knockapi
|
|
7
7
|
extend Knockapi::Internal::Type::RequestParameters::Converter
|
8
8
|
include Knockapi::Internal::Type::RequestParameters
|
9
9
|
|
10
|
+
OrHash =
|
11
|
+
T.type_alias do
|
12
|
+
T.any(
|
13
|
+
Knockapi::Providers::SlackListChannelsParams,
|
14
|
+
Knockapi::Internal::AnyHash
|
15
|
+
)
|
16
|
+
end
|
17
|
+
|
10
18
|
# A JSON encoded string containing the access token object reference.
|
11
19
|
sig { returns(String) }
|
12
20
|
attr_accessor :access_token_object
|
13
21
|
|
14
|
-
sig
|
22
|
+
sig do
|
23
|
+
returns(
|
24
|
+
T.nilable(
|
25
|
+
Knockapi::Providers::SlackListChannelsParams::QueryOptions
|
26
|
+
)
|
27
|
+
)
|
28
|
+
end
|
15
29
|
attr_reader :query_options
|
16
30
|
|
17
31
|
sig do
|
18
32
|
params(
|
19
|
-
query_options:
|
20
|
-
|
21
|
-
|
33
|
+
query_options:
|
34
|
+
Knockapi::Providers::SlackListChannelsParams::QueryOptions::OrHash
|
35
|
+
).void
|
22
36
|
end
|
23
37
|
attr_writer :query_options
|
24
38
|
|
25
39
|
sig do
|
26
40
|
params(
|
27
41
|
access_token_object: String,
|
28
|
-
query_options:
|
29
|
-
|
30
|
-
|
31
|
-
|
42
|
+
query_options:
|
43
|
+
Knockapi::Providers::SlackListChannelsParams::QueryOptions::OrHash,
|
44
|
+
request_options: Knockapi::RequestOptions::OrHash
|
45
|
+
).returns(T.attached_class)
|
32
46
|
end
|
33
47
|
def self.new(
|
34
48
|
# A JSON encoded string containing the access token object reference.
|
35
49
|
access_token_object:,
|
36
50
|
query_options: nil,
|
37
51
|
request_options: {}
|
38
|
-
)
|
52
|
+
)
|
53
|
+
end
|
54
|
+
|
39
55
|
sig do
|
40
|
-
override
|
41
|
-
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
56
|
+
override.returns(
|
57
|
+
{
|
58
|
+
access_token_object: String,
|
59
|
+
query_options:
|
60
|
+
Knockapi::Providers::SlackListChannelsParams::QueryOptions,
|
61
|
+
request_options: Knockapi::RequestOptions
|
62
|
+
}
|
63
|
+
)
|
64
|
+
end
|
65
|
+
def to_hash
|
48
66
|
end
|
49
|
-
def to_hash; end
|
50
67
|
|
51
68
|
class QueryOptions < Knockapi::Internal::Type::BaseModel
|
69
|
+
OrHash =
|
70
|
+
T.type_alias do
|
71
|
+
T.any(
|
72
|
+
Knockapi::Providers::SlackListChannelsParams::QueryOptions,
|
73
|
+
Knockapi::Internal::AnyHash
|
74
|
+
)
|
75
|
+
end
|
76
|
+
|
52
77
|
# Paginate through collections of data by setting the cursor parameter to a
|
53
78
|
# next_cursor attribute returned by a previous request's response_metadata.
|
54
79
|
# Default value fetches the first "page" of the collection.
|
@@ -94,8 +119,7 @@ module Knockapi
|
|
94
119
|
limit: Integer,
|
95
120
|
team_id: String,
|
96
121
|
types: String
|
97
|
-
)
|
98
|
-
.returns(T.attached_class)
|
122
|
+
).returns(T.attached_class)
|
99
123
|
end
|
100
124
|
def self.new(
|
101
125
|
# Paginate through collections of data by setting the cursor parameter to a
|
@@ -111,18 +135,22 @@ module Knockapi
|
|
111
135
|
# Mix and match channel types by providing a comma-separated list of any
|
112
136
|
# combination of public_channel, private_channel, mpim, im.
|
113
137
|
types: nil
|
114
|
-
)
|
138
|
+
)
|
139
|
+
end
|
140
|
+
|
115
141
|
sig do
|
116
|
-
override
|
117
|
-
|
118
|
-
|
119
|
-
|
120
|
-
|
121
|
-
|
122
|
-
|
123
|
-
|
142
|
+
override.returns(
|
143
|
+
{
|
144
|
+
cursor: String,
|
145
|
+
exclude_archived: T::Boolean,
|
146
|
+
limit: Integer,
|
147
|
+
team_id: String,
|
148
|
+
types: String
|
149
|
+
}
|
150
|
+
)
|
151
|
+
end
|
152
|
+
def to_hash
|
124
153
|
end
|
125
|
-
def to_hash; end
|
126
154
|
end
|
127
155
|
end
|
128
156
|
end
|