From 519fcc0a2f35a1fd61e64362b5a2e7b2d8225232 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 12 Feb 2026 19:46:37 +0000 Subject: [PATCH 01/13] feat(api): remove brand field from ElementalContent model --- .stats.yml | 4 ++-- lib/courier/models/elemental_content.rb | 9 +-------- rbi/courier/models/elemental_content.rbi | 12 +++--------- sig/courier/models/elemental_content.rbs | 14 +++----------- 4 files changed, 9 insertions(+), 30 deletions(-) diff --git a/.stats.yml b/.stats.yml index 17749e26..290f28d8 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 81 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/courier%2Fcourier-3fc1c86b4a83a16393aaf17d1fb3ac6098d30dd057ba872973b57285a7a3f0d0.yml -openapi_spec_hash: 02a545d217b13399f311e99561f9de1d +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/courier%2Fcourier-b3852cdd1020811766572923d26a6c95f4a538bf4c7268462b6ba39f34480b3e.yml +openapi_spec_hash: b2e2f2357342e9a6b16a591d0b946e38 config_hash: 0789c3cddc625bb9712b3bded274ab6c diff --git a/lib/courier/models/elemental_content.rb b/lib/courier/models/elemental_content.rb index 3c37b02b..811745ef 100644 --- a/lib/courier/models/elemental_content.rb +++ b/lib/courier/models/elemental_content.rb @@ -14,17 +14,10 @@ class ElementalContent < Courier::Internal::Type::BaseModel # @return [String] required :version, String - # @!attribute brand - # - # @return [String, nil] - optional :brand, String, nil?: true - - # @!method initialize(elements:, version:, brand: nil) + # @!method initialize(elements:, version:) # @param elements [Array] # # @param version [String] For example, "2022-01-01" - # - # @param brand [String, nil] end end end diff --git a/rbi/courier/models/elemental_content.rbi b/rbi/courier/models/elemental_content.rbi index a90bf6b5..b37df9fc 100644 --- a/rbi/courier/models/elemental_content.rbi +++ b/rbi/courier/models/elemental_content.rbi @@ -29,9 +29,6 @@ module Courier sig { returns(String) } attr_accessor :version - sig { returns(T.nilable(String)) } - attr_accessor :brand - sig do params( elements: @@ -46,15 +43,13 @@ module Courier Courier::ElementalQuoteNodeWithType::OrHash ) ], - version: String, - brand: T.nilable(String) + version: String ).returns(T.attached_class) end def self.new( elements:, # For example, "2022-01-01" - version:, - brand: nil + version: ) end @@ -73,8 +68,7 @@ module Courier Courier::ElementalQuoteNodeWithType ) ], - version: String, - brand: T.nilable(String) + version: String } ) end diff --git a/sig/courier/models/elemental_content.rbs b/sig/courier/models/elemental_content.rbs index 8acc1c91..346fbafe 100644 --- a/sig/courier/models/elemental_content.rbs +++ b/sig/courier/models/elemental_content.rbs @@ -1,29 +1,21 @@ module Courier module Models type elemental_content = - { - elements: ::Array[Courier::Models::elemental_node], - version: String, - brand: String? - } + { elements: ::Array[Courier::Models::elemental_node], version: String } class ElementalContent < Courier::Internal::Type::BaseModel attr_accessor elements: ::Array[Courier::Models::elemental_node] attr_accessor version: String - attr_accessor brand: String? - def initialize: ( elements: ::Array[Courier::Models::elemental_node], - version: String, - ?brand: String? + version: String ) -> void def to_hash: -> { elements: ::Array[Courier::Models::elemental_node], - version: String, - brand: String? + version: String } end end From a81351a2fde27b8a785a79436394a991e9048d97 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 20 Feb 2026 04:50:21 +0000 Subject: [PATCH 02/13] chore(internal): remove mock server code --- scripts/mock | 41 ----------------------------------------- scripts/test | 46 ---------------------------------------------- 2 files changed, 87 deletions(-) delete mode 100755 scripts/mock diff --git a/scripts/mock b/scripts/mock deleted file mode 100755 index 0b28f6ea..00000000 --- a/scripts/mock +++ /dev/null @@ -1,41 +0,0 @@ -#!/usr/bin/env bash - -set -e - -cd "$(dirname "$0")/.." - -if [[ -n "$1" && "$1" != '--'* ]]; then - URL="$1" - shift -else - URL="$(grep 'openapi_spec_url' .stats.yml | cut -d' ' -f2)" -fi - -# Check if the URL is empty -if [ -z "$URL" ]; then - echo "Error: No OpenAPI spec path/url provided or found in .stats.yml" - exit 1 -fi - -echo "==> Starting mock server with URL ${URL}" - -# Run prism mock on the given spec -if [ "$1" == "--daemon" ]; then - npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism mock "$URL" &> .prism.log & - - # Wait for server to come online - echo -n "Waiting for server" - while ! grep -q "✖ fatal\|Prism is listening" ".prism.log" ; do - echo -n "." - sleep 0.1 - done - - if grep -q "✖ fatal" ".prism.log"; then - cat .prism.log - exit 1 - fi - - echo -else - npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism mock "$URL" -fi diff --git a/scripts/test b/scripts/test index e0dc1374..df8caf98 100755 --- a/scripts/test +++ b/scripts/test @@ -4,53 +4,7 @@ set -e cd -- "$(dirname -- "$0")/.." -RED='\033[0;31m' -GREEN='\033[0;32m' -YELLOW='\033[0;33m' -NC='\033[0m' # No Color -function prism_is_running() { - curl --silent "http://localhost:4010" >/dev/null 2>&1 -} - -kill_server_on_port() { - pids=$(lsof -t -i tcp:"$1" || echo "") - if [ "$pids" != "" ]; then - kill "$pids" - echo "Stopped $pids." - fi -} - -function is_overriding_api_base_url() { - [ -n "$TEST_API_BASE_URL" ] -} - -if ! is_overriding_api_base_url && ! prism_is_running ; then - # When we exit this script, make sure to kill the background mock server process - trap 'kill_server_on_port 4010' EXIT - - # Start the dev server - ./scripts/mock --daemon -fi - -if is_overriding_api_base_url ; then - echo -e "${GREEN}✔ Running tests against ${TEST_API_BASE_URL}${NC}" - echo -elif ! prism_is_running ; then - echo -e "${RED}ERROR:${NC} The test suite will not run without a mock Prism server" - echo -e "running against your OpenAPI spec." - echo - echo -e "To run the server, pass in the path or url of your OpenAPI" - echo -e "spec to the prism command:" - echo - echo -e " \$ ${YELLOW}npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism mock path/to/your.openapi.yml${NC}" - echo - - exit 1 -else - echo -e "${GREEN}✔ Mock prism server is running with your OpenAPI spec${NC}" - echo -fi echo "==> Running tests" bundle exec rake test "$@" From 62d69fc657babf8ff535e150d74a2283ddb64459 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 20 Feb 2026 04:51:31 +0000 Subject: [PATCH 03/13] chore: update mock server docs --- CONTRIBUTING.md | 6 ------ test/courier/resources/audiences_test.rb | 10 +++++----- test/courier/resources/audit_events_test.rb | 4 ++-- test/courier/resources/auth_test.rb | 2 +- test/courier/resources/automations/invoke_test.rb | 4 ++-- test/courier/resources/automations_test.rb | 2 +- test/courier/resources/brands_test.rb | 10 +++++----- test/courier/resources/bulk_test.rb | 10 +++++----- test/courier/resources/inbound_test.rb | 2 +- test/courier/resources/lists/subscriptions_test.rb | 10 +++++----- test/courier/resources/lists_test.rb | 10 +++++----- test/courier/resources/messages_test.rb | 10 +++++----- test/courier/resources/notifications/checks_test.rb | 6 +++--- test/courier/resources/notifications/draft_test.rb | 2 +- test/courier/resources/notifications_test.rb | 4 ++-- test/courier/resources/profiles/lists_test.rb | 6 +++--- test/courier/resources/profiles_test.rb | 10 +++++----- test/courier/resources/requests_test.rb | 2 +- test/courier/resources/send_test.rb | 2 +- .../resources/tenants/preferences/items_test.rb | 4 ++-- .../resources/tenants/templates/versions_test.rb | 2 +- test/courier/resources/tenants/templates_test.rb | 8 ++++---- test/courier/resources/tenants_test.rb | 10 +++++----- test/courier/resources/translations_test.rb | 4 ++-- test/courier/resources/users/preferences_test.rb | 6 +++--- test/courier/resources/users/tenants_test.rb | 10 +++++----- test/courier/resources/users/tokens_test.rb | 12 ++++++------ 27 files changed, 81 insertions(+), 87 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eb7201f4..007b5bab 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -66,12 +66,6 @@ $ bundle exec rake ## Running tests -Most tests require you to [set up a mock server](https://github.com/stoplightio/prism) against the OpenAPI spec to run the tests. - -```bash -$ npx prism mock path/to/your/openapi.yml -``` - ```bash $ bundle exec rake test ``` diff --git a/test/courier/resources/audiences_test.rb b/test/courier/resources/audiences_test.rb index f9733d89..5f74f772 100644 --- a/test/courier/resources/audiences_test.rb +++ b/test/courier/resources/audiences_test.rb @@ -4,7 +4,7 @@ class Courier::Test::Resources::AudiencesTest < Courier::Test::ResourceTest def test_retrieve - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.audiences.retrieve("audience_id") @@ -26,7 +26,7 @@ def test_retrieve end def test_update - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.audiences.update("audience_id") @@ -42,7 +42,7 @@ def test_update end def test_list - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.audiences.list @@ -59,7 +59,7 @@ def test_list end def test_delete - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.audiences.delete("audience_id") @@ -69,7 +69,7 @@ def test_delete end def test_list_members - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.audiences.list_members("audience_id") diff --git a/test/courier/resources/audit_events_test.rb b/test/courier/resources/audit_events_test.rb index 9695897a..04cda93f 100644 --- a/test/courier/resources/audit_events_test.rb +++ b/test/courier/resources/audit_events_test.rb @@ -4,7 +4,7 @@ class Courier::Test::Resources::AuditEventsTest < Courier::Test::ResourceTest def test_retrieve - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.audit_events.retrieve("audit-event-id") @@ -25,7 +25,7 @@ def test_retrieve end def test_list - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.audit_events.list diff --git a/test/courier/resources/auth_test.rb b/test/courier/resources/auth_test.rb index 1ce0da78..2f63f23e 100644 --- a/test/courier/resources/auth_test.rb +++ b/test/courier/resources/auth_test.rb @@ -4,7 +4,7 @@ class Courier::Test::Resources::AuthTest < Courier::Test::ResourceTest def test_issue_token_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.auth.issue_token( diff --git a/test/courier/resources/automations/invoke_test.rb b/test/courier/resources/automations/invoke_test.rb index 79dceb7a..fdef04d2 100644 --- a/test/courier/resources/automations/invoke_test.rb +++ b/test/courier/resources/automations/invoke_test.rb @@ -4,7 +4,7 @@ class Courier::Test::Resources::Automations::InvokeTest < Courier::Test::ResourceTest def test_invoke_ad_hoc_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.automations.invoke.invoke_ad_hoc(automation: {steps: [{action: :delay}, {action: :send}]}) @@ -21,7 +21,7 @@ def test_invoke_ad_hoc_required_params end def test_invoke_by_template_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.automations.invoke.invoke_by_template("templateId", recipient: "recipient") diff --git a/test/courier/resources/automations_test.rb b/test/courier/resources/automations_test.rb index bc7aed89..ffcec431 100644 --- a/test/courier/resources/automations_test.rb +++ b/test/courier/resources/automations_test.rb @@ -4,7 +4,7 @@ class Courier::Test::Resources::AutomationsTest < Courier::Test::ResourceTest def test_list - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.automations.list diff --git a/test/courier/resources/brands_test.rb b/test/courier/resources/brands_test.rb index 615e4c11..aa1ad134 100644 --- a/test/courier/resources/brands_test.rb +++ b/test/courier/resources/brands_test.rb @@ -4,7 +4,7 @@ class Courier::Test::Resources::BrandsTest < Courier::Test::ResourceTest def test_create_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.brands.create(name: "name") @@ -27,7 +27,7 @@ def test_create_required_params end def test_retrieve - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.brands.retrieve("brand_id") @@ -50,7 +50,7 @@ def test_retrieve end def test_update_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.brands.update("brand_id", name: "name") @@ -73,7 +73,7 @@ def test_update_required_params end def test_list - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.brands.list @@ -90,7 +90,7 @@ def test_list end def test_delete - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.brands.delete("brand_id") diff --git a/test/courier/resources/bulk_test.rb b/test/courier/resources/bulk_test.rb index 2637f1ae..d44686e1 100644 --- a/test/courier/resources/bulk_test.rb +++ b/test/courier/resources/bulk_test.rb @@ -4,7 +4,7 @@ class Courier::Test::Resources::BulkTest < Courier::Test::ResourceTest def test_add_users_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.bulk.add_users("job_id", users: [{}]) @@ -14,7 +14,7 @@ def test_add_users_required_params end def test_create_job_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.bulk.create_job(message: {event: "event"}) @@ -30,7 +30,7 @@ def test_create_job_required_params end def test_list_users - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.bulk.list_users("job_id") @@ -47,7 +47,7 @@ def test_list_users end def test_retrieve_job - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.bulk.retrieve_job("job_id") @@ -63,7 +63,7 @@ def test_retrieve_job end def test_run_job - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.bulk.run_job("job_id") diff --git a/test/courier/resources/inbound_test.rb b/test/courier/resources/inbound_test.rb index b60d0555..7ab21b21 100644 --- a/test/courier/resources/inbound_test.rb +++ b/test/courier/resources/inbound_test.rb @@ -4,7 +4,7 @@ class Courier::Test::Resources::InboundTest < Courier::Test::ResourceTest def test_track_event_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.inbound.track_event( diff --git a/test/courier/resources/lists/subscriptions_test.rb b/test/courier/resources/lists/subscriptions_test.rb index 07c87006..1705c8e1 100644 --- a/test/courier/resources/lists/subscriptions_test.rb +++ b/test/courier/resources/lists/subscriptions_test.rb @@ -4,7 +4,7 @@ class Courier::Test::Resources::Lists::SubscriptionsTest < Courier::Test::ResourceTest def test_list - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.lists.subscriptions.list("list_id") @@ -21,7 +21,7 @@ def test_list end def test_add_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.lists.subscriptions.add("list_id", recipients: [{recipientId: "recipientId"}]) @@ -31,7 +31,7 @@ def test_add_required_params end def test_subscribe_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.lists.subscriptions.subscribe("list_id", recipients: [{recipientId: "recipientId"}]) @@ -41,7 +41,7 @@ def test_subscribe_required_params end def test_subscribe_user_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.lists.subscriptions.subscribe_user("user_id", list_id: "list_id") @@ -51,7 +51,7 @@ def test_subscribe_user_required_params end def test_unsubscribe_user_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.lists.subscriptions.unsubscribe_user("user_id", list_id: "list_id") diff --git a/test/courier/resources/lists_test.rb b/test/courier/resources/lists_test.rb index a806d502..6f6b8937 100644 --- a/test/courier/resources/lists_test.rb +++ b/test/courier/resources/lists_test.rb @@ -4,7 +4,7 @@ class Courier::Test::Resources::ListsTest < Courier::Test::ResourceTest def test_retrieve - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.lists.retrieve("list_id") @@ -23,7 +23,7 @@ def test_retrieve end def test_update_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.lists.update("list_id", name: "name") @@ -33,7 +33,7 @@ def test_update_required_params end def test_list - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.lists.list @@ -50,7 +50,7 @@ def test_list end def test_delete - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.lists.delete("list_id") @@ -60,7 +60,7 @@ def test_delete end def test_restore - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.lists.restore("list_id") diff --git a/test/courier/resources/messages_test.rb b/test/courier/resources/messages_test.rb index bdfe8c0c..8782d555 100644 --- a/test/courier/resources/messages_test.rb +++ b/test/courier/resources/messages_test.rb @@ -4,7 +4,7 @@ class Courier::Test::Resources::MessagesTest < Courier::Test::ResourceTest def test_retrieve - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.messages.retrieve("message_id") @@ -14,7 +14,7 @@ def test_retrieve end def test_list - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.messages.list @@ -31,7 +31,7 @@ def test_list end def test_cancel - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.messages.cancel("message_id") @@ -58,7 +58,7 @@ def test_cancel end def test_content - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.messages.content("message_id") @@ -74,7 +74,7 @@ def test_content end def test_history - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.messages.history("message_id") diff --git a/test/courier/resources/notifications/checks_test.rb b/test/courier/resources/notifications/checks_test.rb index c4ea64fd..07ed9c3e 100644 --- a/test/courier/resources/notifications/checks_test.rb +++ b/test/courier/resources/notifications/checks_test.rb @@ -4,7 +4,7 @@ class Courier::Test::Resources::Notifications::ChecksTest < Courier::Test::ResourceTest def test_update_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.notifications.checks.update( @@ -25,7 +25,7 @@ def test_update_required_params end def test_list_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.notifications.checks.list("submissionId", id: "id") @@ -41,7 +41,7 @@ def test_list_required_params end def test_delete_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.notifications.checks.delete("submissionId", id: "id") diff --git a/test/courier/resources/notifications/draft_test.rb b/test/courier/resources/notifications/draft_test.rb index a59870b3..037b4e33 100644 --- a/test/courier/resources/notifications/draft_test.rb +++ b/test/courier/resources/notifications/draft_test.rb @@ -4,7 +4,7 @@ class Courier::Test::Resources::Notifications::DraftTest < Courier::Test::ResourceTest def test_retrieve_content - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.notifications.draft.retrieve_content("id") diff --git a/test/courier/resources/notifications_test.rb b/test/courier/resources/notifications_test.rb index 51e96970..f970a9e7 100644 --- a/test/courier/resources/notifications_test.rb +++ b/test/courier/resources/notifications_test.rb @@ -4,7 +4,7 @@ class Courier::Test::Resources::NotificationsTest < Courier::Test::ResourceTest def test_list - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.notifications.list @@ -21,7 +21,7 @@ def test_list end def test_retrieve_content - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.notifications.retrieve_content("id") diff --git a/test/courier/resources/profiles/lists_test.rb b/test/courier/resources/profiles/lists_test.rb index fbf13468..2f7e9b5b 100644 --- a/test/courier/resources/profiles/lists_test.rb +++ b/test/courier/resources/profiles/lists_test.rb @@ -4,7 +4,7 @@ class Courier::Test::Resources::Profiles::ListsTest < Courier::Test::ResourceTest def test_retrieve - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.profiles.lists.retrieve("user_id") @@ -21,7 +21,7 @@ def test_retrieve end def test_delete - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.profiles.lists.delete("user_id") @@ -37,7 +37,7 @@ def test_delete end def test_subscribe_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.profiles.lists.subscribe("user_id", lists: [{listId: "listId"}]) diff --git a/test/courier/resources/profiles_test.rb b/test/courier/resources/profiles_test.rb index 18d60f9b..178e84cd 100644 --- a/test/courier/resources/profiles_test.rb +++ b/test/courier/resources/profiles_test.rb @@ -4,7 +4,7 @@ class Courier::Test::Resources::ProfilesTest < Courier::Test::ResourceTest def test_create_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.profiles.create("user_id", profile: {foo: "bar"}) @@ -20,7 +20,7 @@ def test_create_required_params end def test_retrieve - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.profiles.retrieve("user_id") @@ -37,7 +37,7 @@ def test_retrieve end def test_update_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.profiles.update("user_id", patch: [{op: "op", path: "path", value: "value"}]) @@ -47,7 +47,7 @@ def test_update_required_params end def test_delete - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.profiles.delete("user_id") @@ -57,7 +57,7 @@ def test_delete end def test_replace_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.profiles.replace("user_id", profile: {foo: "bar"}) diff --git a/test/courier/resources/requests_test.rb b/test/courier/resources/requests_test.rb index 485d9367..6b308d1f 100644 --- a/test/courier/resources/requests_test.rb +++ b/test/courier/resources/requests_test.rb @@ -4,7 +4,7 @@ class Courier::Test::Resources::RequestsTest < Courier::Test::ResourceTest def test_archive - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.requests.archive("request_id") diff --git a/test/courier/resources/send_test.rb b/test/courier/resources/send_test.rb index 904e75ae..dd31e3af 100644 --- a/test/courier/resources/send_test.rb +++ b/test/courier/resources/send_test.rb @@ -4,7 +4,7 @@ class Courier::Test::Resources::SendTest < Courier::Test::ResourceTest def test_message_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.send_.message(message: {}) diff --git a/test/courier/resources/tenants/preferences/items_test.rb b/test/courier/resources/tenants/preferences/items_test.rb index 1a250e2d..48f0bf81 100644 --- a/test/courier/resources/tenants/preferences/items_test.rb +++ b/test/courier/resources/tenants/preferences/items_test.rb @@ -4,7 +4,7 @@ class Courier::Test::Resources::Tenants::Preferences::ItemsTest < Courier::Test::ResourceTest def test_update_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.tenants.preferences.items.update("topic_id", tenant_id: "tenant_id", status: :OPTED_IN) @@ -15,7 +15,7 @@ def test_update_required_params end def test_delete_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.tenants.preferences.items.delete("topic_id", tenant_id: "tenant_id") diff --git a/test/courier/resources/tenants/templates/versions_test.rb b/test/courier/resources/tenants/templates/versions_test.rb index 7ab8fa81..b5d02912 100644 --- a/test/courier/resources/tenants/templates/versions_test.rb +++ b/test/courier/resources/tenants/templates/versions_test.rb @@ -4,7 +4,7 @@ class Courier::Test::Resources::Tenants::Templates::VersionsTest < Courier::Test::ResourceTest def test_retrieve_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.tenants.templates.versions.retrieve( diff --git a/test/courier/resources/tenants/templates_test.rb b/test/courier/resources/tenants/templates_test.rb index 142b1c8c..8f017bcb 100644 --- a/test/courier/resources/tenants/templates_test.rb +++ b/test/courier/resources/tenants/templates_test.rb @@ -4,7 +4,7 @@ class Courier::Test::Resources::Tenants::TemplatesTest < Courier::Test::ResourceTest def test_retrieve_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.tenants.templates.retrieve("template_id", tenant_id: "tenant_id") @@ -24,7 +24,7 @@ def test_retrieve_required_params end def test_list - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.tenants.templates.list("tenant_id") @@ -45,7 +45,7 @@ def test_list end def test_publish_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.tenants.templates.publish("template_id", tenant_id: "tenant_id") @@ -63,7 +63,7 @@ def test_publish_required_params end def test_replace_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.tenants.templates.replace( diff --git a/test/courier/resources/tenants_test.rb b/test/courier/resources/tenants_test.rb index c8537c3c..91ca23e7 100644 --- a/test/courier/resources/tenants_test.rb +++ b/test/courier/resources/tenants_test.rb @@ -4,7 +4,7 @@ class Courier::Test::Resources::TenantsTest < Courier::Test::ResourceTest def test_retrieve - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.tenants.retrieve("tenant_id") @@ -26,7 +26,7 @@ def test_retrieve end def test_update_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.tenants.update("tenant_id", name: "name") @@ -48,7 +48,7 @@ def test_update_required_params end def test_list - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.tenants.list @@ -69,7 +69,7 @@ def test_list end def test_delete - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.tenants.delete("tenant_id") @@ -79,7 +79,7 @@ def test_delete end def test_list_users - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.tenants.list_users("tenant_id") diff --git a/test/courier/resources/translations_test.rb b/test/courier/resources/translations_test.rb index 59b5f062..8b88731b 100644 --- a/test/courier/resources/translations_test.rb +++ b/test/courier/resources/translations_test.rb @@ -4,7 +4,7 @@ class Courier::Test::Resources::TranslationsTest < Courier::Test::ResourceTest def test_retrieve_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.translations.retrieve("locale", domain: "domain") @@ -14,7 +14,7 @@ def test_retrieve_required_params end def test_update_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.translations.update("locale", domain: "domain", body: "body") diff --git a/test/courier/resources/users/preferences_test.rb b/test/courier/resources/users/preferences_test.rb index 9467d22d..51afea81 100644 --- a/test/courier/resources/users/preferences_test.rb +++ b/test/courier/resources/users/preferences_test.rb @@ -4,7 +4,7 @@ class Courier::Test::Resources::Users::PreferencesTest < Courier::Test::ResourceTest def test_retrieve - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.users.preferences.retrieve("user_id") @@ -21,7 +21,7 @@ def test_retrieve end def test_retrieve_topic_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.users.preferences.retrieve_topic("topic_id", user_id: "user_id") @@ -37,7 +37,7 @@ def test_retrieve_topic_required_params end def test_update_or_create_topic_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.users.preferences.update_or_create_topic( diff --git a/test/courier/resources/users/tenants_test.rb b/test/courier/resources/users/tenants_test.rb index 8408d3c2..5b324e94 100644 --- a/test/courier/resources/users/tenants_test.rb +++ b/test/courier/resources/users/tenants_test.rb @@ -4,7 +4,7 @@ class Courier::Test::Resources::Users::TenantsTest < Courier::Test::ResourceTest def test_list - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.users.tenants.list("user_id") @@ -25,7 +25,7 @@ def test_list end def test_add_multiple_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.users.tenants.add_multiple("user_id", tenants: [{tenant_id: "tenant_id"}]) @@ -35,7 +35,7 @@ def test_add_multiple_required_params end def test_add_single_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.users.tenants.add_single("tenant_id", user_id: "user_id") @@ -45,7 +45,7 @@ def test_add_single_required_params end def test_remove_all - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.users.tenants.remove_all("user_id") @@ -55,7 +55,7 @@ def test_remove_all end def test_remove_single_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.users.tenants.remove_single("tenant_id", user_id: "user_id") diff --git a/test/courier/resources/users/tokens_test.rb b/test/courier/resources/users/tokens_test.rb index cc7292e9..693a6b9d 100644 --- a/test/courier/resources/users/tokens_test.rb +++ b/test/courier/resources/users/tokens_test.rb @@ -4,7 +4,7 @@ class Courier::Test::Resources::Users::TokensTest < Courier::Test::ResourceTest def test_retrieve_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.users.tokens.retrieve("token", user_id: "user_id") @@ -14,7 +14,7 @@ def test_retrieve_required_params end def test_update_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.users.tokens.update("token", user_id: "user_id", patch: [{op: "op", path: "path"}]) @@ -24,7 +24,7 @@ def test_update_required_params end def test_list - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.users.tokens.list("user_id") @@ -40,7 +40,7 @@ def test_list end def test_delete_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.users.tokens.delete("token", user_id: "user_id") @@ -50,7 +50,7 @@ def test_delete_required_params end def test_add_multiple - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.users.tokens.add_multiple("user_id") @@ -60,7 +60,7 @@ def test_add_multiple end def test_add_single_required_params - skip("Prism tests are disabled") + skip("Mock server tests are disabled") response = @courier.users.tokens.add_single( From 3166d3fe17c7649892a770f8f19cac13a14a5bc8 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 20 Feb 2026 19:28:18 +0000 Subject: [PATCH 04/13] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index 290f28d8..f6897576 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 81 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/courier%2Fcourier-b3852cdd1020811766572923d26a6c95f4a538bf4c7268462b6ba39f34480b3e.yml openapi_spec_hash: b2e2f2357342e9a6b16a591d0b946e38 -config_hash: 0789c3cddc625bb9712b3bded274ab6c +config_hash: 6f072c60adb74a68d27be5a0e5ea3124 From e8ee27746f05690f36e67b91431e70678806224f Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 27 Feb 2026 15:25:03 +0000 Subject: [PATCH 05/13] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index f6897576..cf1029ba 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 81 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/courier%2Fcourier-b3852cdd1020811766572923d26a6c95f4a538bf4c7268462b6ba39f34480b3e.yml openapi_spec_hash: b2e2f2357342e9a6b16a591d0b946e38 -config_hash: 6f072c60adb74a68d27be5a0e5ea3124 +config_hash: 1e5350a5c77a04368f25acd83d8f64d1 From 1b49e220313d79efa6eb6a292c8a8afe7558c754 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Mon, 2 Mar 2026 17:42:24 +0000 Subject: [PATCH 06/13] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index cf1029ba..d3f2bfae 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 81 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/courier%2Fcourier-b3852cdd1020811766572923d26a6c95f4a538bf4c7268462b6ba39f34480b3e.yml openapi_spec_hash: b2e2f2357342e9a6b16a591d0b946e38 -config_hash: 1e5350a5c77a04368f25acd83d8f64d1 +config_hash: b6f3cbae8c9807a0197d575b2d09790d From 1cce4a8be23782aae7fb9185b8ac2efd06516842 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 3 Mar 2026 06:50:34 +0000 Subject: [PATCH 07/13] chore(internal): codegen related update --- lib/courier/internal/util.rb | 31 ++++++++++++++++++++ lib/courier/resources/audiences.rb | 6 ++-- lib/courier/resources/audit_events.rb | 3 +- lib/courier/resources/automations.rb | 3 +- lib/courier/resources/brands.rb | 3 +- lib/courier/resources/bulk.rb | 3 +- lib/courier/resources/lists.rb | 3 +- lib/courier/resources/lists/subscriptions.rb | 3 +- lib/courier/resources/messages.rb | 6 ++-- lib/courier/resources/notifications.rb | 3 +- lib/courier/resources/profiles/lists.rb | 3 +- lib/courier/resources/tenants.rb | 6 ++-- lib/courier/resources/tenants/templates.rb | 3 +- lib/courier/resources/users/preferences.rb | 11 ++++--- lib/courier/resources/users/tenants.rb | 3 +- rbi/courier/internal/util.rbi | 20 +++++++++++++ sig/courier/internal/util.rbs | 10 +++++++ test/courier/client_test.rb | 8 +++-- 18 files changed, 105 insertions(+), 23 deletions(-) diff --git a/lib/courier/internal/util.rb b/lib/courier/internal/util.rb index e49292ae..247d311c 100644 --- a/lib/courier/internal/util.rb +++ b/lib/courier/internal/util.rb @@ -490,6 +490,37 @@ def writable_enum(&blk) JSONL_CONTENT = %r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)} class << self + # @api private + # + # @param query [Hash{Symbol=>Object}] + # + # @return [Hash{Symbol=>Object}] + def encode_query_params(query) + out = {} + query.each { write_query_param_element!(out, _1, _2) } + out + end + + # @api private + # + # @param collection [Hash{Symbol=>Object}] + # @param key [String] + # @param element [Object] + # + # @return [nil] + private def write_query_param_element!(collection, key, element) + case element + in Hash + element.each do |name, value| + write_query_param_element!(collection, "#{key}[#{name}]", value) + end + in Array + collection[key] = element.map(&:to_s).join(",") + else + collection[key] = element.to_s + end + end + # @api private # # @param y [Enumerator::Yielder] diff --git a/lib/courier/resources/audiences.rb b/lib/courier/resources/audiences.rb index 87776464..de8b9c14 100644 --- a/lib/courier/resources/audiences.rb +++ b/lib/courier/resources/audiences.rb @@ -69,10 +69,11 @@ def update(audience_id, params = {}) # @see Courier::Models::AudienceListParams def list(params = {}) parsed, options = Courier::AudienceListParams.dump_request(params) + query = Courier::Internal::Util.encode_query_params(parsed) @client.request( method: :get, path: "audiences", - query: parsed, + query: query, model: Courier::Models::AudienceListResponse, options: options ) @@ -113,10 +114,11 @@ def delete(audience_id, params = {}) # @see Courier::Models::AudienceListMembersParams def list_members(audience_id, params = {}) parsed, options = Courier::AudienceListMembersParams.dump_request(params) + query = Courier::Internal::Util.encode_query_params(parsed) @client.request( method: :get, path: ["audiences/%1$s/members", audience_id], - query: parsed, + query: query, model: Courier::Models::AudienceListMembersResponse, options: options ) diff --git a/lib/courier/resources/audit_events.rb b/lib/courier/resources/audit_events.rb index 8c67606b..1fcb8c85 100644 --- a/lib/courier/resources/audit_events.rb +++ b/lib/courier/resources/audit_events.rb @@ -36,10 +36,11 @@ def retrieve(audit_event_id, params = {}) # @see Courier::Models::AuditEventListParams def list(params = {}) parsed, options = Courier::AuditEventListParams.dump_request(params) + query = Courier::Internal::Util.encode_query_params(parsed) @client.request( method: :get, path: "audit-events", - query: parsed, + query: query, model: Courier::Models::AuditEventListResponse, options: options ) diff --git a/lib/courier/resources/automations.rb b/lib/courier/resources/automations.rb index 17fdf1b0..738c4ac4 100644 --- a/lib/courier/resources/automations.rb +++ b/lib/courier/resources/automations.rb @@ -24,10 +24,11 @@ class Automations # @see Courier::Models::AutomationListParams def list(params = {}) parsed, options = Courier::AutomationListParams.dump_request(params) + query = Courier::Internal::Util.encode_query_params(parsed) @client.request( method: :get, path: "automations", - query: parsed, + query: query, model: Courier::AutomationTemplateListResponse, options: options ) diff --git a/lib/courier/resources/brands.rb b/lib/courier/resources/brands.rb index 5660603e..9fe7524b 100644 --- a/lib/courier/resources/brands.rb +++ b/lib/courier/resources/brands.rb @@ -82,10 +82,11 @@ def update(brand_id, params) # @see Courier::Models::BrandListParams def list(params = {}) parsed, options = Courier::BrandListParams.dump_request(params) + query = Courier::Internal::Util.encode_query_params(parsed) @client.request( method: :get, path: "brands", - query: parsed, + query: query, model: Courier::Models::BrandListResponse, options: options ) diff --git a/lib/courier/resources/bulk.rb b/lib/courier/resources/bulk.rb index 2e7bb8e6..b4031b1e 100644 --- a/lib/courier/resources/bulk.rb +++ b/lib/courier/resources/bulk.rb @@ -80,10 +80,11 @@ def create_job(params) # @see Courier::Models::BulkListUsersParams def list_users(job_id, params = {}) parsed, options = Courier::BulkListUsersParams.dump_request(params) + query = Courier::Internal::Util.encode_query_params(parsed) @client.request( method: :get, path: ["bulk/%1$s/users", job_id], - query: parsed, + query: query, model: Courier::Models::BulkListUsersResponse, options: options ) diff --git a/lib/courier/resources/lists.rb b/lib/courier/resources/lists.rb index 914fd4bb..81c52668 100644 --- a/lib/courier/resources/lists.rb +++ b/lib/courier/resources/lists.rb @@ -70,10 +70,11 @@ def update(list_id, params) # @see Courier::Models::ListListParams def list(params = {}) parsed, options = Courier::ListListParams.dump_request(params) + query = Courier::Internal::Util.encode_query_params(parsed) @client.request( method: :get, path: "lists", - query: parsed, + query: query, model: Courier::Models::ListListResponse, options: options ) diff --git a/lib/courier/resources/lists/subscriptions.rb b/lib/courier/resources/lists/subscriptions.rb index 7752efc1..c99377a9 100644 --- a/lib/courier/resources/lists/subscriptions.rb +++ b/lib/courier/resources/lists/subscriptions.rb @@ -19,10 +19,11 @@ class Subscriptions # @see Courier::Models::Lists::SubscriptionListParams def list(list_id, params = {}) parsed, options = Courier::Lists::SubscriptionListParams.dump_request(params) + query = Courier::Internal::Util.encode_query_params(parsed) @client.request( method: :get, path: ["lists/%1$s/subscriptions", list_id], - query: parsed, + query: query, model: Courier::Models::Lists::SubscriptionListResponse, options: options ) diff --git a/lib/courier/resources/messages.rb b/lib/courier/resources/messages.rb index 8eced45e..f84c4d3c 100644 --- a/lib/courier/resources/messages.rb +++ b/lib/courier/resources/messages.rb @@ -68,10 +68,11 @@ def retrieve(message_id, params = {}) # @see Courier::Models::MessageListParams def list(params = {}) parsed, options = Courier::MessageListParams.dump_request(params) + query = Courier::Internal::Util.encode_query_params(parsed) @client.request( method: :get, path: "messages", - query: parsed.transform_keys(message_id: "messageId", trace_id: "traceId"), + query: query.transform_keys(message_id: "messageId", trace_id: "traceId"), model: Courier::Models::MessageListResponse, options: options ) @@ -139,10 +140,11 @@ def content(message_id, params = {}) # @see Courier::Models::MessageHistoryParams def history(message_id, params = {}) parsed, options = Courier::MessageHistoryParams.dump_request(params) + query = Courier::Internal::Util.encode_query_params(parsed) @client.request( method: :get, path: ["messages/%1$s/history", message_id], - query: parsed, + query: query, model: Courier::Models::MessageHistoryResponse, options: options ) diff --git a/lib/courier/resources/notifications.rb b/lib/courier/resources/notifications.rb index 79cc3cad..b8c51ebb 100644 --- a/lib/courier/resources/notifications.rb +++ b/lib/courier/resources/notifications.rb @@ -22,10 +22,11 @@ class Notifications # @see Courier::Models::NotificationListParams def list(params = {}) parsed, options = Courier::NotificationListParams.dump_request(params) + query = Courier::Internal::Util.encode_query_params(parsed) @client.request( method: :get, path: "notifications", - query: parsed, + query: query, model: Courier::Models::NotificationListResponse, options: options ) diff --git a/lib/courier/resources/profiles/lists.rb b/lib/courier/resources/profiles/lists.rb index 7e5385d6..ea96c78b 100644 --- a/lib/courier/resources/profiles/lists.rb +++ b/lib/courier/resources/profiles/lists.rb @@ -22,10 +22,11 @@ class Lists # @see Courier::Models::Profiles::ListRetrieveParams def retrieve(user_id, params = {}) parsed, options = Courier::Profiles::ListRetrieveParams.dump_request(params) + query = Courier::Internal::Util.encode_query_params(parsed) @client.request( method: :get, path: ["profiles/%1$s/lists", user_id], - query: parsed, + query: query, model: Courier::Models::Profiles::ListRetrieveResponse, options: options ) diff --git a/lib/courier/resources/tenants.rb b/lib/courier/resources/tenants.rb index f30ab367..52be0202 100644 --- a/lib/courier/resources/tenants.rb +++ b/lib/courier/resources/tenants.rb @@ -86,10 +86,11 @@ def update(tenant_id, params) # @see Courier::Models::TenantListParams def list(params = {}) parsed, options = Courier::TenantListParams.dump_request(params) + query = Courier::Internal::Util.encode_query_params(parsed) @client.request( method: :get, path: "tenants", - query: parsed, + query: query, model: Courier::Models::TenantListResponse, options: options ) @@ -135,10 +136,11 @@ def delete(tenant_id, params = {}) # @see Courier::Models::TenantListUsersParams def list_users(tenant_id, params = {}) parsed, options = Courier::TenantListUsersParams.dump_request(params) + query = Courier::Internal::Util.encode_query_params(parsed) @client.request( method: :get, path: ["tenants/%1$s/users", tenant_id], - query: parsed, + query: query, model: Courier::Models::TenantListUsersResponse, options: options ) diff --git a/lib/courier/resources/tenants/templates.rb b/lib/courier/resources/tenants/templates.rb index 022a19a7..823e5ab3 100644 --- a/lib/courier/resources/tenants/templates.rb +++ b/lib/courier/resources/tenants/templates.rb @@ -51,10 +51,11 @@ def retrieve(template_id, params) # @see Courier::Models::Tenants::TemplateListParams def list(tenant_id, params = {}) parsed, options = Courier::Tenants::TemplateListParams.dump_request(params) + query = Courier::Internal::Util.encode_query_params(parsed) @client.request( method: :get, path: ["tenants/%1$s/templates", tenant_id], - query: parsed, + query: query, model: Courier::Models::Tenants::TemplateListResponse, options: options ) diff --git a/lib/courier/resources/users/preferences.rb b/lib/courier/resources/users/preferences.rb index ff5052d0..80b3bdaa 100644 --- a/lib/courier/resources/users/preferences.rb +++ b/lib/courier/resources/users/preferences.rb @@ -22,10 +22,11 @@ class Preferences # @see Courier::Models::Users::PreferenceRetrieveParams def retrieve(user_id, params = {}) parsed, options = Courier::Users::PreferenceRetrieveParams.dump_request(params) + query = Courier::Internal::Util.encode_query_params(parsed) @client.request( method: :get, path: ["users/%1$s/preferences", user_id], - query: parsed, + query: query, model: Courier::Models::Users::PreferenceRetrieveResponse, options: options ) @@ -51,6 +52,7 @@ def retrieve(user_id, params = {}) # @see Courier::Models::Users::PreferenceRetrieveTopicParams def retrieve_topic(topic_id, params) parsed, options = Courier::Users::PreferenceRetrieveTopicParams.dump_request(params) + query = Courier::Internal::Util.encode_query_params(parsed) user_id = parsed.delete(:user_id) do raise ArgumentError.new("missing required path argument #{_1}") @@ -58,7 +60,7 @@ def retrieve_topic(topic_id, params) @client.request( method: :get, path: ["users/%1$s/preferences/%2$s", user_id, topic_id], - query: parsed, + query: query, model: Courier::Models::Users::PreferenceRetrieveTopicResponse, options: options ) @@ -85,16 +87,17 @@ def retrieve_topic(topic_id, params) # # @see Courier::Models::Users::PreferenceUpdateOrCreateTopicParams def update_or_create_topic(topic_id, params) + query_params = [:tenant_id] parsed, options = Courier::Users::PreferenceUpdateOrCreateTopicParams.dump_request(params) + query = Courier::Internal::Util.encode_query_params(parsed.slice(*query_params)) user_id = parsed.delete(:user_id) do raise ArgumentError.new("missing required path argument #{_1}") end - query_params = [:tenant_id] @client.request( method: :put, path: ["users/%1$s/preferences/%2$s", user_id, topic_id], - query: parsed.slice(*query_params), + query: query, body: parsed.except(*query_params), model: Courier::Models::Users::PreferenceUpdateOrCreateTopicResponse, options: options diff --git a/lib/courier/resources/users/tenants.rb b/lib/courier/resources/users/tenants.rb index 17eb6747..5ea9251e 100644 --- a/lib/courier/resources/users/tenants.rb +++ b/lib/courier/resources/users/tenants.rb @@ -24,10 +24,11 @@ class Tenants # @see Courier::Models::Users::TenantListParams def list(user_id, params = {}) parsed, options = Courier::Users::TenantListParams.dump_request(params) + query = Courier::Internal::Util.encode_query_params(parsed) @client.request( method: :get, path: ["users/%1$s/tenants", user_id], - query: parsed, + query: query, model: Courier::Models::Users::TenantListResponse, options: options ) diff --git a/rbi/courier/internal/util.rbi b/rbi/courier/internal/util.rbi index 5d0a35f9..2ef4486a 100644 --- a/rbi/courier/internal/util.rbi +++ b/rbi/courier/internal/util.rbi @@ -301,6 +301,26 @@ module Courier T.let(%r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}, Regexp) class << self + # @api private + sig do + params(query: Courier::Internal::AnyHash).returns( + Courier::Internal::AnyHash + ) + end + def encode_query_params(query) + end + + # @api private + sig do + params( + collection: Courier::Internal::AnyHash, + key: String, + element: T.anything + ).void + end + private def write_query_param_element!(collection, key, element) + end + # @api private sig do params( diff --git a/sig/courier/internal/util.rbs b/sig/courier/internal/util.rbs index c0db0690..1ff515fc 100644 --- a/sig/courier/internal/util.rbs +++ b/sig/courier/internal/util.rbs @@ -106,6 +106,16 @@ module Courier JSON_CONTENT: Regexp JSONL_CONTENT: Regexp + def encode_query_params: ( + ::Hash[Symbol, top] query + ) -> ::Hash[Symbol, top] + + private def write_query_param_element!: ( + ::Hash[Symbol, top] collection, + String key, + top element + ) -> nil + def self?.write_multipart_content: ( Enumerator::Yielder y, val: top, diff --git a/test/courier/client_test.rb b/test/courier/client_test.rb index 19835d95..c11021b8 100644 --- a/test/courier/client_test.rb +++ b/test/courier/client_test.rb @@ -100,19 +100,21 @@ def test_client_retry_after_seconds end def test_client_retry_after_date + time_now = Time.now + stub_request(:post, "http://localhost/send").to_return_json( status: 500, - headers: {"retry-after" => (Time.now + 10).httpdate}, + headers: {"retry-after" => (time_now + 10).httpdate}, body: {} ) courier = Courier::Client.new(base_url: "http://localhost", api_key: "My API Key", max_retries: 1) + Thread.current.thread_variable_set(:time_now, time_now) assert_raises(Courier::Errors::InternalServerError) do - Thread.current.thread_variable_set(:time_now, Time.now) courier.send_.message(message: {}) - Thread.current.thread_variable_set(:time_now, nil) end + Thread.current.thread_variable_set(:time_now, nil) assert_requested(:any, /./, times: 2) assert_in_delta(10, Thread.current.thread_variable_get(:mock_sleep).last, 1.0) From d07ae3dc073f38ac30af1311f1d70153e441bf51 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 3 Mar 2026 07:35:40 +0000 Subject: [PATCH 08/13] chore(ci): add build step --- .github/workflows/ci.yml | 34 ++++++++++ scripts/utils/upload-artifact.sh | 113 +++++++++++++++++++++++++++++++ 2 files changed, 147 insertions(+) create mode 100755 scripts/utils/upload-artifact.sh diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index f7d7e873..d9653bed 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -13,6 +13,40 @@ on: - 'stl-preview-base/**' jobs: + build: + timeout-minutes: 10 + name: build + permissions: + contents: read + id-token: write + runs-on: ${{ github.repository == 'stainless-sdks/courier-ruby' && 'depot-ubuntu-24.04' || 'ubuntu-latest' }} + if: |- + github.repository == 'stainless-sdks/courier-ruby' && + (github.event_name == 'push' || github.event.pull_request.head.repo.fork) + steps: + - uses: actions/checkout@v6 + - name: Set up Ruby + uses: ruby/setup-ruby@v1 + with: + bundler-cache: false + - run: |- + bundle install + + - name: Get GitHub OIDC Token + if: github.repository == 'stainless-sdks/courier-ruby' + id: github-oidc + uses: actions/github-script@v8 + with: + script: core.setOutput('github_token', await core.getIDToken()); + + - name: Build and upload gem artifacts + if: github.repository == 'stainless-sdks/courier-ruby' + env: + URL: https://pkg.stainless.com/s + AUTH: ${{ steps.github-oidc.outputs.github_token }} + SHA: ${{ github.sha }} + PACKAGE_NAME: courier + run: ./scripts/utils/upload-artifact.sh lint: timeout-minutes: 10 name: lint diff --git a/scripts/utils/upload-artifact.sh b/scripts/utils/upload-artifact.sh new file mode 100755 index 00000000..517dfc07 --- /dev/null +++ b/scripts/utils/upload-artifact.sh @@ -0,0 +1,113 @@ +#!/usr/bin/env bash + +set -euo pipefail + +# ANSI Color Codes +GREEN='\033[32m' +RED='\033[31m' +NC='\033[0m' # No Color + +DIST_DIR="dist" + +log_error() { + local msg="$1" + local headers="$2" + local body="$3" + echo -e "${RED}${msg}${NC}" + [[ -f "$headers" ]] && echo -e "${RED}Headers:$(cat "$headers")${NC}" + echo -e "${RED}Body: ${body}${NC}" + exit 1 +} + +upload_file() { + local file_name="$1" + local tmp_headers + tmp_headers=$(mktemp) + + if [ -f "$file_name" ]; then + echo -e "${GREEN}Processing file: $file_name${NC}" + pkg_file_name="${file_name#"${DIST_DIR}/"}" + + # Get signed URL for uploading artifact file + signed_url_response=$(curl -X POST -G "$URL" \ + -sS --retry 5 \ + -D "$tmp_headers" \ + --data-urlencode "filename=$pkg_file_name" \ + -H "Authorization: Bearer $AUTH" \ + -H "Content-Type: application/json") + + # Validate JSON and extract URL + if ! signed_url=$(echo "$signed_url_response" | jq -e -r '.url' 2>/dev/null) || [[ "$signed_url" == "null" ]]; then + log_error "Failed to get valid signed URL" "$tmp_headers" "$signed_url_response" + fi + + # Set content-type based on file extension + local extension="${file_name##*.}" + local content_type + case "$extension" in + gem) content_type="application/octet-stream" ;; + gz) content_type="application/gzip" ;; + rz) content_type="application/octet-stream" ;; + html) content_type="text/html" ;; + *) content_type="application/octet-stream" ;; + esac + + # Upload file + upload_response=$(curl -v -X PUT \ + --retry 5 \ + --retry-all-errors \ + -D "$tmp_headers" \ + -H "Content-Type: $content_type" \ + --data-binary "@${file_name}" "$signed_url" 2>&1) + + if ! echo "$upload_response" | grep -q "HTTP/[0-9.]* 200"; then + log_error "Failed to upload artifact file" "$tmp_headers" "$upload_response" + fi + + # Insert small throttle to reduce rate limiting risk + sleep 0.1 + fi +} + +walk_tree() { + local current_dir="$1" + + for entry in "$current_dir"/*; do + # Check that entry is valid + [ -e "$entry" ] || [ -h "$entry" ] || continue + + if [ -d "$entry" ]; then + walk_tree "$entry" + else + upload_file "$entry" + fi + done +} + +cd "$(dirname "$0")/../.." + +echo "::group::Building gem" +VERSION_FILE="lib/${PACKAGE_NAME}/version.rb" +if [[ ! -f "$VERSION_FILE" ]]; then + echo -e "${RED}Version file not found: ${VERSION_FILE}${NC}" + exit 1 +fi +SHORT_SHA="${SHA:0:7}" +sed -i.bak -E "s/(VERSION = \"[^\"]+)\"/\1.beta.${SHORT_SHA}\"/" "$VERSION_FILE" +rm -f "${VERSION_FILE}.bak" + +gem build +mkdir -p "${DIST_DIR}/gems" +mv ./*.gem "${DIST_DIR}/gems/" +echo "::endgroup::" + +echo "::group::Generating gem index" +gem generate_index --directory "$DIST_DIR" +echo "::endgroup::" + +echo "::group::Uploading to pkg.stainless.com" +walk_tree "$DIST_DIR" +echo "::endgroup::" + +echo -e "${GREEN}Gem artifacts uploaded to Stainless storage.${NC}" +echo -e "\033[32mInstallation: bundle remove trycourier && bundle add trycourier --source 'https://pkg.stainless.com/s/courier-ruby/$SHA'\033[0m" From 854672e58be03af0b8851168bf5aab8f6cd486ed Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 3 Mar 2026 17:27:41 +0000 Subject: [PATCH 09/13] codegen metadata --- .stats.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.stats.yml b/.stats.yml index d3f2bfae..8eca4011 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 81 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/courier%2Fcourier-b3852cdd1020811766572923d26a6c95f4a538bf4c7268462b6ba39f34480b3e.yml openapi_spec_hash: b2e2f2357342e9a6b16a591d0b946e38 -config_hash: b6f3cbae8c9807a0197d575b2d09790d +config_hash: b1f6d0f43161b66d201043fcbe5c5695 From acb30313188a385e2ad39be4f4040e4e5836106d Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Tue, 3 Mar 2026 21:21:17 +0000 Subject: [PATCH 10/13] feat(api): add provider_key/device/tracking to token params, remove body_token --- .stats.yml | 4 +- .../models/users/token_add_single_params.rb | 163 +++++++++- lib/courier/resources/users/tokens.rb | 16 +- .../models/users/token_add_single_params.rbi | 287 +++++++++++++++++- rbi/courier/resources/users/tokens.rbi | 20 +- .../models/users/token_add_single_params.rbs | 126 +++++++- sig/courier/resources/users/tokens.rbs | 11 +- test/courier/resources/users/tokens_test.rb | 8 +- 8 files changed, 593 insertions(+), 42 deletions(-) diff --git a/.stats.yml b/.stats.yml index 8eca4011..bb69a634 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 81 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/courier%2Fcourier-b3852cdd1020811766572923d26a6c95f4a538bf4c7268462b6ba39f34480b3e.yml -openapi_spec_hash: b2e2f2357342e9a6b16a591d0b946e38 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/courier%2Fcourier-44c2e612f5d40e03f56712a4e123a193e6ea03cc64a91d0c34ee094563dafa1c.yml +openapi_spec_hash: 40bf6b3f7992d55f1bd543f32564ea86 config_hash: b1f6d0f43161b66d201043fcbe5c5695 diff --git a/lib/courier/models/users/token_add_single_params.rb b/lib/courier/models/users/token_add_single_params.rb index 3067f171..baf7697f 100644 --- a/lib/courier/models/users/token_add_single_params.rb +++ b/lib/courier/models/users/token_add_single_params.rb @@ -4,7 +4,7 @@ module Courier module Models module Users # @see Courier::Resources::Users::Tokens#add_single - class TokenAddSingleParams < Courier::Models::Users::UserToken + class TokenAddSingleParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters @@ -13,9 +13,168 @@ class TokenAddSingleParams < Courier::Models::Users::UserToken # @return [String] required :user_id, String - # @!method initialize(user_id:, request_options: {}) + # @!attribute provider_key + # + # @return [Symbol, Courier::Models::Users::TokenAddSingleParams::ProviderKey] + required :provider_key, enum: -> { Courier::Users::TokenAddSingleParams::ProviderKey } + + # @!attribute device + # Information about the device the token came from. + # + # @return [Courier::Models::Users::TokenAddSingleParams::Device, nil] + optional :device, -> { Courier::Users::TokenAddSingleParams::Device }, nil?: true + + # @!attribute expiry_date + # ISO 8601 formatted date the token expires. Defaults to 2 months. Set to false to + # disable expiration. + # + # @return [String, Boolean, nil] + optional :expiry_date, union: -> { Courier::Users::TokenAddSingleParams::ExpiryDate }, nil?: true + + # @!attribute properties + # Properties about the token. + # + # @return [Object, nil] + optional :properties, Courier::Internal::Type::Unknown + + # @!attribute tracking + # Tracking information about the device the token came from. + # + # @return [Courier::Models::Users::TokenAddSingleParams::Tracking, nil] + optional :tracking, -> { Courier::Users::TokenAddSingleParams::Tracking }, nil?: true + + # @!method initialize(user_id:, provider_key:, device: nil, expiry_date: nil, properties: nil, tracking: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Courier::Models::Users::TokenAddSingleParams} for more details. + # # @param user_id [String] + # + # @param provider_key [Symbol, Courier::Models::Users::TokenAddSingleParams::ProviderKey] + # + # @param device [Courier::Models::Users::TokenAddSingleParams::Device, nil] Information about the device the token came from. + # + # @param expiry_date [String, Boolean, nil] ISO 8601 formatted date the token expires. Defaults to 2 months. Set to false to + # + # @param properties [Object] Properties about the token. + # + # @param tracking [Courier::Models::Users::TokenAddSingleParams::Tracking, nil] Tracking information about the device the token came from. + # # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] + + module ProviderKey + extend Courier::Internal::Type::Enum + + FIREBASE_FCM = :"firebase-fcm" + APN = :apn + EXPO = :expo + ONESIGNAL = :onesignal + + # @!method self.values + # @return [Array] + end + + class Device < Courier::Internal::Type::BaseModel + # @!attribute ad_id + # Id of the advertising identifier + # + # @return [String, nil] + optional :ad_id, String, nil?: true + + # @!attribute app_id + # Id of the application the token is used for + # + # @return [String, nil] + optional :app_id, String, nil?: true + + # @!attribute device_id + # Id of the device the token is associated with + # + # @return [String, nil] + optional :device_id, String, nil?: true + + # @!attribute manufacturer + # The device manufacturer + # + # @return [String, nil] + optional :manufacturer, String, nil?: true + + # @!attribute model + # The device model + # + # @return [String, nil] + optional :model, String, nil?: true + + # @!attribute platform + # The device platform i.e. android, ios, web + # + # @return [String, nil] + optional :platform, String, nil?: true + + # @!method initialize(ad_id: nil, app_id: nil, device_id: nil, manufacturer: nil, model: nil, platform: nil) + # Information about the device the token came from. + # + # @param ad_id [String, nil] Id of the advertising identifier + # + # @param app_id [String, nil] Id of the application the token is used for + # + # @param device_id [String, nil] Id of the device the token is associated with + # + # @param manufacturer [String, nil] The device manufacturer + # + # @param model [String, nil] The device model + # + # @param platform [String, nil] The device platform i.e. android, ios, web + end + + # ISO 8601 formatted date the token expires. Defaults to 2 months. Set to false to + # disable expiration. + module ExpiryDate + extend Courier::Internal::Type::Union + + variant String + + variant Courier::Internal::Type::Boolean + + # @!method self.variants + # @return [Array(String, Boolean)] + end + + class Tracking < Courier::Internal::Type::BaseModel + # @!attribute ip + # The IP address of the device + # + # @return [String, nil] + optional :ip, String, nil?: true + + # @!attribute lat + # The latitude of the device + # + # @return [String, nil] + optional :lat, String, nil?: true + + # @!attribute long + # The longitude of the device + # + # @return [String, nil] + optional :long, String, nil?: true + + # @!attribute os_version + # The operating system version + # + # @return [String, nil] + optional :os_version, String, nil?: true + + # @!method initialize(ip: nil, lat: nil, long: nil, os_version: nil) + # Tracking information about the device the token came from. + # + # @param ip [String, nil] The IP address of the device + # + # @param lat [String, nil] The latitude of the device + # + # @param long [String, nil] The longitude of the device + # + # @param os_version [String, nil] The operating system version + end end end end diff --git a/lib/courier/resources/users/tokens.rb b/lib/courier/resources/users/tokens.rb index 73eb2127..61bf81a8 100644 --- a/lib/courier/resources/users/tokens.rb +++ b/lib/courier/resources/users/tokens.rb @@ -133,30 +133,28 @@ def add_multiple(user_id, params = {}) # # Adds a single token to a user and overwrites a matching existing token. # - # @overload add_single(path_token, user_id:, body_token:, provider_key:, device: nil, expiry_date: nil, properties: nil, tracking: nil, request_options: {}) + # @overload add_single(token, user_id:, provider_key:, device: nil, expiry_date: nil, properties: nil, tracking: nil, request_options: {}) # - # @param path_token [String] Path param: The full token string. + # @param token [String] Path param: The full token string. # # @param user_id [String] Path param: The user's ID. This can be any uniquely identifiable string. # - # @param body_token [String] Body param: Full body of the token. Must match token in URL path parameter. - # - # @param provider_key [Symbol, Courier::Models::Users::UserToken::ProviderKey] Body param + # @param provider_key [Symbol, Courier::Models::Users::TokenAddSingleParams::ProviderKey] Body param # - # @param device [Courier::Models::Users::UserToken::Device, nil] Body param: Information about the device the token came from. + # @param device [Courier::Models::Users::TokenAddSingleParams::Device, nil] Body param: Information about the device the token came from. # # @param expiry_date [String, Boolean, nil] Body param: ISO 8601 formatted date the token expires. Defaults to 2 months. Set # # @param properties [Object] Body param: Properties about the token. # - # @param tracking [Courier::Models::Users::UserToken::Tracking, nil] Body param: Tracking information about the device the token came from. + # @param tracking [Courier::Models::Users::TokenAddSingleParams::Tracking, nil] Body param: Tracking information about the device the token came from. # # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil] # # @return [nil] # # @see Courier::Models::Users::TokenAddSingleParams - def add_single(path_token, params) + def add_single(token, params) parsed, options = Courier::Users::TokenAddSingleParams.dump_request(params) user_id = parsed.delete(:user_id) do @@ -164,7 +162,7 @@ def add_single(path_token, params) end @client.request( method: :put, - path: ["users/%1$s/tokens/%2$s", user_id, path_token], + path: ["users/%1$s/tokens/%2$s", user_id, token], body: parsed, model: NilClass, options: options diff --git a/rbi/courier/models/users/token_add_single_params.rbi b/rbi/courier/models/users/token_add_single_params.rbi index 53ce6ac6..b726a86a 100644 --- a/rbi/courier/models/users/token_add_single_params.rbi +++ b/rbi/courier/models/users/token_add_single_params.rbi @@ -3,7 +3,7 @@ module Courier module Models module Users - class TokenAddSingleParams < Courier::Models::Users::UserToken + class TokenAddSingleParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters @@ -18,22 +18,303 @@ module Courier sig { returns(String) } attr_accessor :user_id + sig do + returns(Courier::Users::TokenAddSingleParams::ProviderKey::OrSymbol) + end + attr_accessor :provider_key + + # Information about the device the token came from. + sig { returns(T.nilable(Courier::Users::TokenAddSingleParams::Device)) } + attr_reader :device + + sig do + params( + device: + T.nilable(Courier::Users::TokenAddSingleParams::Device::OrHash) + ).void + end + attr_writer :device + + # ISO 8601 formatted date the token expires. Defaults to 2 months. Set to false to + # disable expiration. + sig do + returns( + T.nilable( + Courier::Users::TokenAddSingleParams::ExpiryDate::Variants + ) + ) + end + attr_accessor :expiry_date + + # Properties about the token. + sig { returns(T.nilable(T.anything)) } + attr_reader :properties + + sig { params(properties: T.anything).void } + attr_writer :properties + + # Tracking information about the device the token came from. + sig do + returns(T.nilable(Courier::Users::TokenAddSingleParams::Tracking)) + end + attr_reader :tracking + + sig do + params( + tracking: + T.nilable(Courier::Users::TokenAddSingleParams::Tracking::OrHash) + ).void + end + attr_writer :tracking + sig do params( user_id: String, + provider_key: + Courier::Users::TokenAddSingleParams::ProviderKey::OrSymbol, + device: + T.nilable(Courier::Users::TokenAddSingleParams::Device::OrHash), + expiry_date: + T.nilable( + Courier::Users::TokenAddSingleParams::ExpiryDate::Variants + ), + properties: T.anything, + tracking: + T.nilable(Courier::Users::TokenAddSingleParams::Tracking::OrHash), request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new(user_id:, request_options: {}) + def self.new( + user_id:, + provider_key:, + # Information about the device the token came from. + device: nil, + # ISO 8601 formatted date the token expires. Defaults to 2 months. Set to false to + # disable expiration. + expiry_date: nil, + # Properties about the token. + properties: nil, + # Tracking information about the device the token came from. + tracking: nil, + request_options: {} + ) end sig do override.returns( - { user_id: String, request_options: Courier::RequestOptions } + { + user_id: String, + provider_key: + Courier::Users::TokenAddSingleParams::ProviderKey::OrSymbol, + device: T.nilable(Courier::Users::TokenAddSingleParams::Device), + expiry_date: + T.nilable( + Courier::Users::TokenAddSingleParams::ExpiryDate::Variants + ), + properties: T.anything, + tracking: + T.nilable(Courier::Users::TokenAddSingleParams::Tracking), + request_options: Courier::RequestOptions + } ) end def to_hash end + + module ProviderKey + extend Courier::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Courier::Users::TokenAddSingleParams::ProviderKey) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + FIREBASE_FCM = + T.let( + :"firebase-fcm", + Courier::Users::TokenAddSingleParams::ProviderKey::TaggedSymbol + ) + APN = + T.let( + :apn, + Courier::Users::TokenAddSingleParams::ProviderKey::TaggedSymbol + ) + EXPO = + T.let( + :expo, + Courier::Users::TokenAddSingleParams::ProviderKey::TaggedSymbol + ) + ONESIGNAL = + T.let( + :onesignal, + Courier::Users::TokenAddSingleParams::ProviderKey::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Courier::Users::TokenAddSingleParams::ProviderKey::TaggedSymbol + ] + ) + end + def self.values + end + end + + class Device < Courier::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Courier::Users::TokenAddSingleParams::Device, + Courier::Internal::AnyHash + ) + end + + # Id of the advertising identifier + sig { returns(T.nilable(String)) } + attr_accessor :ad_id + + # Id of the application the token is used for + sig { returns(T.nilable(String)) } + attr_accessor :app_id + + # Id of the device the token is associated with + sig { returns(T.nilable(String)) } + attr_accessor :device_id + + # The device manufacturer + sig { returns(T.nilable(String)) } + attr_accessor :manufacturer + + # The device model + sig { returns(T.nilable(String)) } + attr_accessor :model + + # The device platform i.e. android, ios, web + sig { returns(T.nilable(String)) } + attr_accessor :platform + + # Information about the device the token came from. + sig do + params( + ad_id: T.nilable(String), + app_id: T.nilable(String), + device_id: T.nilable(String), + manufacturer: T.nilable(String), + model: T.nilable(String), + platform: T.nilable(String) + ).returns(T.attached_class) + end + def self.new( + # Id of the advertising identifier + ad_id: nil, + # Id of the application the token is used for + app_id: nil, + # Id of the device the token is associated with + device_id: nil, + # The device manufacturer + manufacturer: nil, + # The device model + model: nil, + # The device platform i.e. android, ios, web + platform: nil + ) + end + + sig do + override.returns( + { + ad_id: T.nilable(String), + app_id: T.nilable(String), + device_id: T.nilable(String), + manufacturer: T.nilable(String), + model: T.nilable(String), + platform: T.nilable(String) + } + ) + end + def to_hash + end + end + + # ISO 8601 formatted date the token expires. Defaults to 2 months. Set to false to + # disable expiration. + module ExpiryDate + extend Courier::Internal::Type::Union + + Variants = T.type_alias { T.any(String, T::Boolean) } + + sig do + override.returns( + T::Array[ + Courier::Users::TokenAddSingleParams::ExpiryDate::Variants + ] + ) + end + def self.variants + end + end + + class Tracking < Courier::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Courier::Users::TokenAddSingleParams::Tracking, + Courier::Internal::AnyHash + ) + end + + # The IP address of the device + sig { returns(T.nilable(String)) } + attr_accessor :ip + + # The latitude of the device + sig { returns(T.nilable(String)) } + attr_accessor :lat + + # The longitude of the device + sig { returns(T.nilable(String)) } + attr_accessor :long + + # The operating system version + sig { returns(T.nilable(String)) } + attr_accessor :os_version + + # Tracking information about the device the token came from. + sig do + params( + ip: T.nilable(String), + lat: T.nilable(String), + long: T.nilable(String), + os_version: T.nilable(String) + ).returns(T.attached_class) + end + def self.new( + # The IP address of the device + ip: nil, + # The latitude of the device + lat: nil, + # The longitude of the device + long: nil, + # The operating system version + os_version: nil + ) + end + + sig do + override.returns( + { + ip: T.nilable(String), + lat: T.nilable(String), + long: T.nilable(String), + os_version: T.nilable(String) + } + ) + end + def to_hash + end + end end end end diff --git a/rbi/courier/resources/users/tokens.rbi b/rbi/courier/resources/users/tokens.rbi index 1e7f1e40..ef582fd7 100644 --- a/rbi/courier/resources/users/tokens.rbi +++ b/rbi/courier/resources/users/tokens.rbi @@ -89,25 +89,27 @@ module Courier # Adds a single token to a user and overwrites a matching existing token. sig do params( - path_token: String, + token: String, user_id: String, - body_token: String, - provider_key: Courier::Users::UserToken::ProviderKey::OrSymbol, - device: T.nilable(Courier::Users::UserToken::Device::OrHash), + provider_key: + Courier::Users::TokenAddSingleParams::ProviderKey::OrSymbol, + device: + T.nilable(Courier::Users::TokenAddSingleParams::Device::OrHash), expiry_date: - T.nilable(Courier::Users::UserToken::ExpiryDate::Variants), + T.nilable( + Courier::Users::TokenAddSingleParams::ExpiryDate::Variants + ), properties: T.anything, - tracking: T.nilable(Courier::Users::UserToken::Tracking::OrHash), + tracking: + T.nilable(Courier::Users::TokenAddSingleParams::Tracking::OrHash), request_options: Courier::RequestOptions::OrHash ).void end def add_single( # Path param: The full token string. - path_token, + token, # Path param: The user's ID. This can be any uniquely identifiable string. user_id:, - # Body param: Full body of the token. Must match token in URL path parameter. - body_token:, # Body param provider_key:, # Body param: Information about the device the token came from. diff --git a/sig/courier/models/users/token_add_single_params.rbs b/sig/courier/models/users/token_add_single_params.rbs index 9e47ad7b..02fe3e16 100644 --- a/sig/courier/models/users/token_add_single_params.rbs +++ b/sig/courier/models/users/token_add_single_params.rbs @@ -2,25 +2,143 @@ module Courier module Models module Users type token_add_single_params = - { user_id: String } & Courier::Internal::Type::request_parameters + { + user_id: String, + provider_key: Courier::Models::Users::TokenAddSingleParams::provider_key, + device: Courier::Users::TokenAddSingleParams::Device?, + expiry_date: Courier::Models::Users::TokenAddSingleParams::expiry_date?, + properties: top, + tracking: Courier::Users::TokenAddSingleParams::Tracking? + } + & Courier::Internal::Type::request_parameters - class TokenAddSingleParams < Courier::Models::Users::UserToken + class TokenAddSingleParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - def user_id: -> String + attr_accessor user_id: String + + attr_accessor provider_key: Courier::Models::Users::TokenAddSingleParams::provider_key + + attr_accessor device: Courier::Users::TokenAddSingleParams::Device? - def user_id=: (String _) -> String + attr_accessor expiry_date: Courier::Models::Users::TokenAddSingleParams::expiry_date? + + attr_reader properties: top? + + def properties=: (top) -> top + + attr_accessor tracking: Courier::Users::TokenAddSingleParams::Tracking? def initialize: ( user_id: String, + provider_key: Courier::Models::Users::TokenAddSingleParams::provider_key, + ?device: Courier::Users::TokenAddSingleParams::Device?, + ?expiry_date: Courier::Models::Users::TokenAddSingleParams::expiry_date?, + ?properties: top, + ?tracking: Courier::Users::TokenAddSingleParams::Tracking?, ?request_options: Courier::request_opts ) -> void def to_hash: -> { user_id: String, + provider_key: Courier::Models::Users::TokenAddSingleParams::provider_key, + device: Courier::Users::TokenAddSingleParams::Device?, + expiry_date: Courier::Models::Users::TokenAddSingleParams::expiry_date?, + properties: top, + tracking: Courier::Users::TokenAddSingleParams::Tracking?, request_options: Courier::RequestOptions } + + type provider_key = :"firebase-fcm" | :apn | :expo | :onesignal + + module ProviderKey + extend Courier::Internal::Type::Enum + + FIREBASE_FCM: :"firebase-fcm" + APN: :apn + EXPO: :expo + ONESIGNAL: :onesignal + + def self?.values: -> ::Array[Courier::Models::Users::TokenAddSingleParams::provider_key] + end + + type device = + { + ad_id: String?, + app_id: String?, + device_id: String?, + manufacturer: String?, + model: String?, + platform: String? + } + + class Device < Courier::Internal::Type::BaseModel + attr_accessor ad_id: String? + + attr_accessor app_id: String? + + attr_accessor device_id: String? + + attr_accessor manufacturer: String? + + attr_accessor model: String? + + attr_accessor platform: String? + + def initialize: ( + ?ad_id: String?, + ?app_id: String?, + ?device_id: String?, + ?manufacturer: String?, + ?model: String?, + ?platform: String? + ) -> void + + def to_hash: -> { + ad_id: String?, + app_id: String?, + device_id: String?, + manufacturer: String?, + model: String?, + platform: String? + } + end + + type expiry_date = String | bool + + module ExpiryDate + extend Courier::Internal::Type::Union + + def self?.variants: -> ::Array[Courier::Models::Users::TokenAddSingleParams::expiry_date] + end + + type tracking = + { ip: String?, lat: String?, long: String?, os_version: String? } + + class Tracking < Courier::Internal::Type::BaseModel + attr_accessor ip: String? + + attr_accessor lat: String? + + attr_accessor long: String? + + attr_accessor os_version: String? + + def initialize: ( + ?ip: String?, + ?lat: String?, + ?long: String?, + ?os_version: String? + ) -> void + + def to_hash: -> { + ip: String?, + lat: String?, + long: String?, + os_version: String? + } + end end end end diff --git a/sig/courier/resources/users/tokens.rbs b/sig/courier/resources/users/tokens.rbs index fc78565d..4b7d1120 100644 --- a/sig/courier/resources/users/tokens.rbs +++ b/sig/courier/resources/users/tokens.rbs @@ -32,14 +32,13 @@ module Courier ) -> nil def add_single: ( - String path_token, + String token, user_id: String, - body_token: String, - provider_key: Courier::Models::Users::UserToken::provider_key, - ?device: Courier::Users::UserToken::Device?, - ?expiry_date: Courier::Models::Users::UserToken::expiry_date?, + provider_key: Courier::Models::Users::TokenAddSingleParams::provider_key, + ?device: Courier::Users::TokenAddSingleParams::Device?, + ?expiry_date: Courier::Models::Users::TokenAddSingleParams::expiry_date?, ?properties: top, - ?tracking: Courier::Users::UserToken::Tracking?, + ?tracking: Courier::Users::TokenAddSingleParams::Tracking?, ?request_options: Courier::request_opts ) -> nil diff --git a/test/courier/resources/users/tokens_test.rb b/test/courier/resources/users/tokens_test.rb index 693a6b9d..124eed96 100644 --- a/test/courier/resources/users/tokens_test.rb +++ b/test/courier/resources/users/tokens_test.rb @@ -62,13 +62,7 @@ def test_add_multiple def test_add_single_required_params skip("Mock server tests are disabled") - response = - @courier.users.tokens.add_single( - "token", - user_id: "user_id", - body_token: "token", - provider_key: :"firebase-fcm" - ) + response = @courier.users.tokens.add_single("token", user_id: "user_id", provider_key: :"firebase-fcm") assert_pattern do response => nil From 3a0f51e6a03c33097f1307ac7974a3c5ca72ac90 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 6 Mar 2026 06:45:31 +0000 Subject: [PATCH 11/13] chore(internal): codegen related update --- lib/courier/models/audience_delete_params.rb | 8 +++++++- .../models/audience_list_members_params.rb | 9 ++++++++- lib/courier/models/audience_retrieve_params.rb | 8 +++++++- lib/courier/models/audience_update_params.rb | 9 ++++++++- .../models/audit_event_retrieve_params.rb | 8 +++++++- .../invoke_invoke_by_template_params.rb | 8 +++++++- lib/courier/models/brand_delete_params.rb | 8 +++++++- lib/courier/models/brand_retrieve_params.rb | 8 +++++++- lib/courier/models/brand_update_params.rb | 9 ++++++++- lib/courier/models/bulk_add_users_params.rb | 8 +++++++- lib/courier/models/bulk_list_users_params.rb | 9 ++++++++- lib/courier/models/bulk_retrieve_job_params.rb | 8 +++++++- lib/courier/models/bulk_run_job_params.rb | 8 +++++++- lib/courier/models/list_delete_params.rb | 8 +++++++- lib/courier/models/list_restore_params.rb | 8 +++++++- lib/courier/models/list_retrieve_params.rb | 8 +++++++- lib/courier/models/list_update_params.rb | 8 +++++++- .../models/lists/subscription_add_params.rb | 8 +++++++- .../models/lists/subscription_list_params.rb | 9 ++++++++- .../lists/subscription_subscribe_params.rb | 8 +++++++- .../subscription_subscribe_user_params.rb | 8 +++++++- .../subscription_unsubscribe_user_params.rb | 8 +++++++- lib/courier/models/message_cancel_params.rb | 8 +++++++- lib/courier/models/message_content_params.rb | 8 +++++++- lib/courier/models/message_history_params.rb | 9 ++++++++- lib/courier/models/message_retrieve_params.rb | 8 +++++++- .../notification_retrieve_content_params.rb | 8 +++++++- .../notifications/check_delete_params.rb | 8 +++++++- .../models/notifications/check_list_params.rb | 8 +++++++- .../notifications/check_update_params.rb | 8 +++++++- .../draft_retrieve_content_params.rb | 8 +++++++- lib/courier/models/profile_create_params.rb | 8 +++++++- lib/courier/models/profile_delete_params.rb | 8 +++++++- lib/courier/models/profile_replace_params.rb | 8 +++++++- lib/courier/models/profile_retrieve_params.rb | 8 +++++++- lib/courier/models/profile_update_params.rb | 9 ++++++++- .../models/profiles/list_delete_params.rb | 8 +++++++- .../models/profiles/list_retrieve_params.rb | 9 ++++++++- .../models/profiles/list_subscribe_params.rb | 8 +++++++- lib/courier/models/request_archive_params.rb | 8 +++++++- lib/courier/models/tenant_delete_params.rb | 8 +++++++- lib/courier/models/tenant_list_users_params.rb | 9 ++++++++- lib/courier/models/tenant_retrieve_params.rb | 8 +++++++- lib/courier/models/tenant_update_params.rb | 9 ++++++++- .../tenants/preferences/item_delete_params.rb | 8 +++++++- .../tenants/preferences/item_update_params.rb | 8 +++++++- .../models/tenants/template_list_params.rb | 9 ++++++++- .../models/tenants/template_publish_params.rb | 8 +++++++- .../models/tenants/template_replace_params.rb | 8 +++++++- .../models/tenants/template_retrieve_params.rb | 8 +++++++- .../templates/version_retrieve_params.rb | 8 +++++++- .../models/translation_retrieve_params.rb | 8 +++++++- .../models/translation_update_params.rb | 8 +++++++- .../models/users/preference_retrieve_params.rb | 9 ++++++++- .../users/preference_retrieve_topic_params.rb | 9 ++++++++- ...preference_update_or_create_topic_params.rb | 9 ++++++++- .../models/users/tenant_add_multiple_params.rb | 8 +++++++- .../models/users/tenant_add_single_params.rb | 8 +++++++- lib/courier/models/users/tenant_list_params.rb | 9 ++++++++- .../models/users/tenant_remove_all_params.rb | 8 +++++++- .../users/tenant_remove_single_params.rb | 8 +++++++- .../models/users/token_add_multiple_params.rb | 8 +++++++- .../models/users/token_add_single_params.rb | 9 ++++++++- .../models/users/token_delete_params.rb | 8 +++++++- lib/courier/models/users/token_list_params.rb | 8 +++++++- .../models/users/token_retrieve_params.rb | 8 +++++++- .../models/users/token_update_params.rb | 8 +++++++- rbi/courier/models/audience_delete_params.rbi | 18 +++++++++++++----- .../models/audience_list_members_params.rbi | 6 ++++++ .../models/audience_retrieve_params.rbi | 18 +++++++++++++----- rbi/courier/models/audience_update_params.rbi | 6 ++++++ .../models/audit_event_retrieve_params.rbi | 18 +++++++++++++----- .../invoke_invoke_by_template_params.rbi | 6 ++++++ rbi/courier/models/brand_delete_params.rbi | 18 +++++++++++++----- rbi/courier/models/brand_retrieve_params.rbi | 18 +++++++++++++----- rbi/courier/models/brand_update_params.rbi | 6 ++++++ rbi/courier/models/bulk_add_users_params.rbi | 7 ++++++- rbi/courier/models/bulk_list_users_params.rbi | 6 ++++++ .../models/bulk_retrieve_job_params.rbi | 18 +++++++++++++----- rbi/courier/models/bulk_run_job_params.rbi | 18 +++++++++++++----- rbi/courier/models/list_delete_params.rbi | 18 +++++++++++++----- rbi/courier/models/list_restore_params.rbi | 18 +++++++++++++----- rbi/courier/models/list_retrieve_params.rbi | 18 +++++++++++++----- rbi/courier/models/list_update_params.rbi | 7 ++++++- .../models/lists/subscription_add_params.rbi | 7 ++++++- .../models/lists/subscription_list_params.rbi | 6 ++++++ .../lists/subscription_subscribe_params.rbi | 7 ++++++- .../subscription_subscribe_user_params.rbi | 7 ++++++- .../subscription_unsubscribe_user_params.rbi | 12 ++++++++++-- rbi/courier/models/message_cancel_params.rbi | 18 +++++++++++++----- rbi/courier/models/message_content_params.rbi | 18 +++++++++++++----- rbi/courier/models/message_history_params.rbi | 11 ++++++++++- rbi/courier/models/message_retrieve_params.rbi | 18 +++++++++++++----- .../notification_retrieve_content_params.rbi | 18 +++++++++++++----- .../notifications/check_delete_params.rbi | 12 ++++++++++-- .../models/notifications/check_list_params.rbi | 12 ++++++++++-- .../notifications/check_update_params.rbi | 7 ++++++- .../draft_retrieve_content_params.rbi | 18 +++++++++++++----- rbi/courier/models/profile_create_params.rbi | 7 ++++++- rbi/courier/models/profile_delete_params.rbi | 18 +++++++++++++----- rbi/courier/models/profile_replace_params.rbi | 7 ++++++- rbi/courier/models/profile_retrieve_params.rbi | 18 +++++++++++++----- rbi/courier/models/profile_update_params.rbi | 6 ++++++ .../models/profiles/list_delete_params.rbi | 18 +++++++++++++----- .../models/profiles/list_retrieve_params.rbi | 6 ++++++ .../models/profiles/list_subscribe_params.rbi | 7 ++++++- rbi/courier/models/request_archive_params.rbi | 18 +++++++++++++----- rbi/courier/models/tenant_delete_params.rbi | 18 +++++++++++++----- .../models/tenant_list_users_params.rbi | 6 ++++++ rbi/courier/models/tenant_retrieve_params.rbi | 18 +++++++++++++----- rbi/courier/models/tenant_update_params.rbi | 6 ++++++ .../tenants/preferences/item_delete_params.rbi | 12 ++++++++++-- .../tenants/preferences/item_update_params.rbi | 12 ++++++++++-- .../models/tenants/template_list_params.rbi | 6 ++++++ .../models/tenants/template_publish_params.rbi | 12 ++++++++++-- .../models/tenants/template_replace_params.rbi | 12 ++++++++++-- .../tenants/template_retrieve_params.rbi | 12 ++++++++++-- .../templates/version_retrieve_params.rbi | 7 ++++++- .../models/translation_retrieve_params.rbi | 12 ++++++++++-- .../models/translation_update_params.rbi | 7 ++++++- .../users/preference_retrieve_params.rbi | 6 ++++++ .../users/preference_retrieve_topic_params.rbi | 6 ++++++ ...reference_update_or_create_topic_params.rbi | 6 ++++++ .../users/tenant_add_multiple_params.rbi | 7 ++++++- .../models/users/tenant_add_single_params.rbi | 7 ++++++- .../models/users/tenant_list_params.rbi | 6 ++++++ .../models/users/tenant_remove_all_params.rbi | 18 +++++++++++++----- .../users/tenant_remove_single_params.rbi | 12 ++++++++++-- .../models/users/token_add_multiple_params.rbi | 18 +++++++++++++----- .../models/users/token_add_single_params.rbi | 6 ++++++ .../models/users/token_delete_params.rbi | 12 ++++++++++-- rbi/courier/models/users/token_list_params.rbi | 18 +++++++++++++----- .../models/users/token_retrieve_params.rbi | 12 ++++++++++-- .../models/users/token_update_params.rbi | 7 ++++++- sig/courier/models/audience_delete_params.rbs | 14 +++++++++++--- .../models/audience_list_members_params.rbs | 7 ++++++- .../models/audience_retrieve_params.rbs | 14 +++++++++++--- sig/courier/models/audience_update_params.rbs | 5 +++++ .../models/audit_event_retrieve_params.rbs | 14 +++++++++++--- .../invoke_invoke_by_template_params.rbs | 5 +++++ sig/courier/models/brand_delete_params.rbs | 14 +++++++++++--- sig/courier/models/brand_retrieve_params.rbs | 14 +++++++++++--- sig/courier/models/brand_update_params.rbs | 5 +++++ sig/courier/models/bulk_add_users_params.rbs | 6 +++++- sig/courier/models/bulk_list_users_params.rbs | 7 ++++++- .../models/bulk_retrieve_job_params.rbs | 14 +++++++++++--- sig/courier/models/bulk_run_job_params.rbs | 14 +++++++++++--- sig/courier/models/list_delete_params.rbs | 15 ++++++++++++--- sig/courier/models/list_restore_params.rbs | 14 +++++++++++--- sig/courier/models/list_retrieve_params.rbs | 14 +++++++++++--- sig/courier/models/list_update_params.rbs | 10 +++++++++- .../models/lists/subscription_add_params.rbs | 9 ++++++++- .../models/lists/subscription_list_params.rbs | 7 ++++++- .../lists/subscription_subscribe_params.rbs | 9 ++++++++- .../subscription_subscribe_user_params.rbs | 10 +++++++++- .../subscription_unsubscribe_user_params.rbs | 7 ++++++- sig/courier/models/message_cancel_params.rbs | 14 +++++++++++--- sig/courier/models/message_content_params.rbs | 14 +++++++++++--- sig/courier/models/message_history_params.rbs | 7 ++++++- sig/courier/models/message_retrieve_params.rbs | 14 +++++++++++--- .../notification_retrieve_content_params.rbs | 11 ++++++++--- .../notifications/check_delete_params.rbs | 12 ++++++++++-- .../models/notifications/check_list_params.rbs | 12 ++++++++++-- .../notifications/check_update_params.rbs | 10 +++++++++- .../draft_retrieve_content_params.rbs | 11 ++++++++--- sig/courier/models/profile_create_params.rbs | 6 +++++- sig/courier/models/profile_delete_params.rbs | 14 +++++++++++--- sig/courier/models/profile_replace_params.rbs | 6 +++++- sig/courier/models/profile_retrieve_params.rbs | 14 +++++++++++--- sig/courier/models/profile_update_params.rbs | 6 +++++- .../models/profiles/list_delete_params.rbs | 14 +++++++++++--- .../models/profiles/list_retrieve_params.rbs | 7 ++++++- .../models/profiles/list_subscribe_params.rbs | 9 ++++++++- sig/courier/models/request_archive_params.rbs | 14 +++++++++++--- sig/courier/models/tenant_delete_params.rbs | 14 +++++++++++--- .../models/tenant_list_users_params.rbs | 6 +++++- sig/courier/models/tenant_retrieve_params.rbs | 14 +++++++++++--- sig/courier/models/tenant_update_params.rbs | 5 +++++ .../tenants/preferences/item_delete_params.rbs | 7 ++++++- .../tenants/preferences/item_update_params.rbs | 9 ++++++++- .../models/tenants/template_list_params.rbs | 6 +++++- .../models/tenants/template_publish_params.rbs | 9 ++++++++- .../models/tenants/template_replace_params.rbs | 9 ++++++++- .../tenants/template_retrieve_params.rbs | 7 ++++++- .../templates/version_retrieve_params.rbs | 6 +++++- .../models/translation_retrieve_params.rbs | 7 ++++++- .../models/translation_update_params.rbs | 6 +++++- .../users/preference_retrieve_params.rbs | 7 ++++++- .../users/preference_retrieve_topic_params.rbs | 6 +++++- ...reference_update_or_create_topic_params.rbs | 5 +++++ .../users/tenant_add_multiple_params.rbs | 6 +++++- .../models/users/tenant_add_single_params.rbs | 6 +++++- .../models/users/tenant_list_params.rbs | 6 +++++- .../models/users/tenant_remove_all_params.rbs | 14 +++++++++++--- .../users/tenant_remove_single_params.rbs | 7 ++++++- .../models/users/token_add_multiple_params.rbs | 14 +++++++++++--- .../models/users/token_add_single_params.rbs | 5 +++++ .../models/users/token_delete_params.rbs | 7 ++++++- sig/courier/models/users/token_list_params.rbs | 14 +++++++++++--- .../models/users/token_retrieve_params.rbs | 7 ++++++- .../models/users/token_update_params.rbs | 5 +++++ 201 files changed, 1634 insertions(+), 336 deletions(-) diff --git a/lib/courier/models/audience_delete_params.rb b/lib/courier/models/audience_delete_params.rb index c1a44401..6b0b942c 100644 --- a/lib/courier/models/audience_delete_params.rb +++ b/lib/courier/models/audience_delete_params.rb @@ -7,7 +7,13 @@ class AudienceDeleteParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - # @!method initialize(request_options: {}) + # @!attribute audience_id + # + # @return [String] + required :audience_id, String + + # @!method initialize(audience_id:, request_options: {}) + # @param audience_id [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/audience_list_members_params.rb b/lib/courier/models/audience_list_members_params.rb index 7ce6d654..7b7b9b05 100644 --- a/lib/courier/models/audience_list_members_params.rb +++ b/lib/courier/models/audience_list_members_params.rb @@ -7,13 +7,20 @@ class AudienceListMembersParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + # @!attribute audience_id + # + # @return [String] + required :audience_id, String + # @!attribute cursor # A unique identifier that allows for fetching the next set of members # # @return [String, nil] optional :cursor, String, nil?: true - # @!method initialize(cursor: nil, request_options: {}) + # @!method initialize(audience_id:, cursor: nil, request_options: {}) + # @param audience_id [String] + # # @param cursor [String, nil] A unique identifier that allows for fetching the next set of members # # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] diff --git a/lib/courier/models/audience_retrieve_params.rb b/lib/courier/models/audience_retrieve_params.rb index d4b20274..14541627 100644 --- a/lib/courier/models/audience_retrieve_params.rb +++ b/lib/courier/models/audience_retrieve_params.rb @@ -7,7 +7,13 @@ class AudienceRetrieveParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - # @!method initialize(request_options: {}) + # @!attribute audience_id + # + # @return [String] + required :audience_id, String + + # @!method initialize(audience_id:, request_options: {}) + # @param audience_id [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/audience_update_params.rb b/lib/courier/models/audience_update_params.rb index 34c603cf..7b00c47a 100644 --- a/lib/courier/models/audience_update_params.rb +++ b/lib/courier/models/audience_update_params.rb @@ -7,6 +7,11 @@ class AudienceUpdateParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + # @!attribute audience_id + # + # @return [String] + required :audience_id, String + # @!attribute description # A description of the audience # @@ -31,10 +36,12 @@ class AudienceUpdateParams < Courier::Internal::Type::BaseModel # @return [Symbol, Courier::Models::AudienceUpdateParams::Operator, nil] optional :operator, enum: -> { Courier::AudienceUpdateParams::Operator }, nil?: true - # @!method initialize(description: nil, filter: nil, name: nil, operator: nil, request_options: {}) + # @!method initialize(audience_id:, description: nil, filter: nil, name: nil, operator: nil, request_options: {}) # Some parameter documentations has been truncated, see # {Courier::Models::AudienceUpdateParams} for more details. # + # @param audience_id [String] + # # @param description [String, nil] A description of the audience # # @param filter [Courier::Models::AudienceFilterConfig, nil] Filter configuration for audience membership containing an array of filter rules diff --git a/lib/courier/models/audit_event_retrieve_params.rb b/lib/courier/models/audit_event_retrieve_params.rb index 73c55955..bb75c9cf 100644 --- a/lib/courier/models/audit_event_retrieve_params.rb +++ b/lib/courier/models/audit_event_retrieve_params.rb @@ -7,7 +7,13 @@ class AuditEventRetrieveParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - # @!method initialize(request_options: {}) + # @!attribute audit_event_id + # + # @return [String] + required :audit_event_id, String + + # @!method initialize(audit_event_id:, request_options: {}) + # @param audit_event_id [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/automations/invoke_invoke_by_template_params.rb b/lib/courier/models/automations/invoke_invoke_by_template_params.rb index efb7f9d0..9be2cd2c 100644 --- a/lib/courier/models/automations/invoke_invoke_by_template_params.rb +++ b/lib/courier/models/automations/invoke_invoke_by_template_params.rb @@ -8,6 +8,11 @@ class InvokeInvokeByTemplateParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + # @!attribute template_id + # + # @return [String] + required :template_id, String + # @!attribute recipient # # @return [String, nil] @@ -33,7 +38,8 @@ class InvokeInvokeByTemplateParams < Courier::Internal::Type::BaseModel # @return [String, nil] optional :template, String, nil?: true - # @!method initialize(recipient:, brand: nil, data: nil, profile: nil, template: nil, request_options: {}) + # @!method initialize(template_id:, recipient:, brand: nil, data: nil, profile: nil, template: nil, request_options: {}) + # @param template_id [String] # @param recipient [String, nil] # @param brand [String, nil] # @param data [Hash{Symbol=>Object}, nil] diff --git a/lib/courier/models/brand_delete_params.rb b/lib/courier/models/brand_delete_params.rb index 51f13c9f..3c0d29df 100644 --- a/lib/courier/models/brand_delete_params.rb +++ b/lib/courier/models/brand_delete_params.rb @@ -7,7 +7,13 @@ class BrandDeleteParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - # @!method initialize(request_options: {}) + # @!attribute brand_id + # + # @return [String] + required :brand_id, String + + # @!method initialize(brand_id:, request_options: {}) + # @param brand_id [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/brand_retrieve_params.rb b/lib/courier/models/brand_retrieve_params.rb index 2be8414c..50dc1333 100644 --- a/lib/courier/models/brand_retrieve_params.rb +++ b/lib/courier/models/brand_retrieve_params.rb @@ -7,7 +7,13 @@ class BrandRetrieveParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - # @!method initialize(request_options: {}) + # @!attribute brand_id + # + # @return [String] + required :brand_id, String + + # @!method initialize(brand_id:, request_options: {}) + # @param brand_id [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/brand_update_params.rb b/lib/courier/models/brand_update_params.rb index 4de76a86..dfc3899d 100644 --- a/lib/courier/models/brand_update_params.rb +++ b/lib/courier/models/brand_update_params.rb @@ -7,6 +7,11 @@ class BrandUpdateParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + # @!attribute brand_id + # + # @return [String] + required :brand_id, String + # @!attribute name # The name of the brand. # @@ -23,7 +28,9 @@ class BrandUpdateParams < Courier::Internal::Type::BaseModel # @return [Courier::Models::BrandSnippets, nil] optional :snippets, -> { Courier::BrandSnippets }, nil?: true - # @!method initialize(name:, settings: nil, snippets: nil, request_options: {}) + # @!method initialize(brand_id:, name:, settings: nil, snippets: nil, request_options: {}) + # @param brand_id [String] + # # @param name [String] The name of the brand. # # @param settings [Courier::Models::BrandSettings, nil] diff --git a/lib/courier/models/bulk_add_users_params.rb b/lib/courier/models/bulk_add_users_params.rb index 79ae7d5a..82ca75cd 100644 --- a/lib/courier/models/bulk_add_users_params.rb +++ b/lib/courier/models/bulk_add_users_params.rb @@ -7,12 +7,18 @@ class BulkAddUsersParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + # @!attribute job_id + # + # @return [String] + required :job_id, String + # @!attribute users # # @return [Array] required :users, -> { Courier::Internal::Type::ArrayOf[Courier::InboundBulkMessageUser] } - # @!method initialize(users:, request_options: {}) + # @!method initialize(job_id:, users:, request_options: {}) + # @param job_id [String] # @param users [Array] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end diff --git a/lib/courier/models/bulk_list_users_params.rb b/lib/courier/models/bulk_list_users_params.rb index 1fd3f565..c6fad1c5 100644 --- a/lib/courier/models/bulk_list_users_params.rb +++ b/lib/courier/models/bulk_list_users_params.rb @@ -7,6 +7,11 @@ class BulkListUsersParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + # @!attribute job_id + # + # @return [String] + required :job_id, String + # @!attribute cursor # A unique identifier that allows for fetching the next set of users added to the # bulk job @@ -14,10 +19,12 @@ class BulkListUsersParams < Courier::Internal::Type::BaseModel # @return [String, nil] optional :cursor, String, nil?: true - # @!method initialize(cursor: nil, request_options: {}) + # @!method initialize(job_id:, cursor: nil, request_options: {}) # Some parameter documentations has been truncated, see # {Courier::Models::BulkListUsersParams} for more details. # + # @param job_id [String] + # # @param cursor [String, nil] A unique identifier that allows for fetching the next set of users added to the # # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] diff --git a/lib/courier/models/bulk_retrieve_job_params.rb b/lib/courier/models/bulk_retrieve_job_params.rb index 5a8ea2c0..72b80c60 100644 --- a/lib/courier/models/bulk_retrieve_job_params.rb +++ b/lib/courier/models/bulk_retrieve_job_params.rb @@ -7,7 +7,13 @@ class BulkRetrieveJobParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - # @!method initialize(request_options: {}) + # @!attribute job_id + # + # @return [String] + required :job_id, String + + # @!method initialize(job_id:, request_options: {}) + # @param job_id [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/bulk_run_job_params.rb b/lib/courier/models/bulk_run_job_params.rb index 7d1e465a..12b7e75b 100644 --- a/lib/courier/models/bulk_run_job_params.rb +++ b/lib/courier/models/bulk_run_job_params.rb @@ -7,7 +7,13 @@ class BulkRunJobParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - # @!method initialize(request_options: {}) + # @!attribute job_id + # + # @return [String] + required :job_id, String + + # @!method initialize(job_id:, request_options: {}) + # @param job_id [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/list_delete_params.rb b/lib/courier/models/list_delete_params.rb index d51974c9..3f3e2dcf 100644 --- a/lib/courier/models/list_delete_params.rb +++ b/lib/courier/models/list_delete_params.rb @@ -7,7 +7,13 @@ class ListDeleteParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - # @!method initialize(request_options: {}) + # @!attribute list_id + # + # @return [String] + required :list_id, String + + # @!method initialize(list_id:, request_options: {}) + # @param list_id [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/list_restore_params.rb b/lib/courier/models/list_restore_params.rb index d330fb7a..4fbefa97 100644 --- a/lib/courier/models/list_restore_params.rb +++ b/lib/courier/models/list_restore_params.rb @@ -7,7 +7,13 @@ class ListRestoreParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - # @!method initialize(request_options: {}) + # @!attribute list_id + # + # @return [String] + required :list_id, String + + # @!method initialize(list_id:, request_options: {}) + # @param list_id [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/list_retrieve_params.rb b/lib/courier/models/list_retrieve_params.rb index df65db09..9c1d6fc7 100644 --- a/lib/courier/models/list_retrieve_params.rb +++ b/lib/courier/models/list_retrieve_params.rb @@ -7,7 +7,13 @@ class ListRetrieveParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - # @!method initialize(request_options: {}) + # @!attribute list_id + # + # @return [String] + required :list_id, String + + # @!method initialize(list_id:, request_options: {}) + # @param list_id [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/list_update_params.rb b/lib/courier/models/list_update_params.rb index c169be48..9a0e231e 100644 --- a/lib/courier/models/list_update_params.rb +++ b/lib/courier/models/list_update_params.rb @@ -7,6 +7,11 @@ class ListUpdateParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + # @!attribute list_id + # + # @return [String] + required :list_id, String + # @!attribute name # # @return [String] @@ -17,7 +22,8 @@ class ListUpdateParams < Courier::Internal::Type::BaseModel # @return [Courier::Models::RecipientPreferences, nil] optional :preferences, -> { Courier::RecipientPreferences }, nil?: true - # @!method initialize(name:, preferences: nil, request_options: {}) + # @!method initialize(list_id:, name:, preferences: nil, request_options: {}) + # @param list_id [String] # @param name [String] # @param preferences [Courier::Models::RecipientPreferences, nil] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] diff --git a/lib/courier/models/lists/subscription_add_params.rb b/lib/courier/models/lists/subscription_add_params.rb index 6411af7f..2d7ac968 100644 --- a/lib/courier/models/lists/subscription_add_params.rb +++ b/lib/courier/models/lists/subscription_add_params.rb @@ -8,12 +8,18 @@ class SubscriptionAddParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + # @!attribute list_id + # + # @return [String] + required :list_id, String + # @!attribute recipients # # @return [Array] required :recipients, -> { Courier::Internal::Type::ArrayOf[Courier::PutSubscriptionsRecipient] } - # @!method initialize(recipients:, request_options: {}) + # @!method initialize(list_id:, recipients:, request_options: {}) + # @param list_id [String] # @param recipients [Array] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end diff --git a/lib/courier/models/lists/subscription_list_params.rb b/lib/courier/models/lists/subscription_list_params.rb index 1c1f2515..980e3ae6 100644 --- a/lib/courier/models/lists/subscription_list_params.rb +++ b/lib/courier/models/lists/subscription_list_params.rb @@ -8,13 +8,20 @@ class SubscriptionListParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + # @!attribute list_id + # + # @return [String] + required :list_id, String + # @!attribute cursor # A unique identifier that allows for fetching the next set of list subscriptions # # @return [String, nil] optional :cursor, String, nil?: true - # @!method initialize(cursor: nil, request_options: {}) + # @!method initialize(list_id:, cursor: nil, request_options: {}) + # @param list_id [String] + # # @param cursor [String, nil] A unique identifier that allows for fetching the next set of list subscriptions # # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] diff --git a/lib/courier/models/lists/subscription_subscribe_params.rb b/lib/courier/models/lists/subscription_subscribe_params.rb index 7916356b..13702b92 100644 --- a/lib/courier/models/lists/subscription_subscribe_params.rb +++ b/lib/courier/models/lists/subscription_subscribe_params.rb @@ -8,12 +8,18 @@ class SubscriptionSubscribeParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + # @!attribute list_id + # + # @return [String] + required :list_id, String + # @!attribute recipients # # @return [Array] required :recipients, -> { Courier::Internal::Type::ArrayOf[Courier::PutSubscriptionsRecipient] } - # @!method initialize(recipients:, request_options: {}) + # @!method initialize(list_id:, recipients:, request_options: {}) + # @param list_id [String] # @param recipients [Array] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end diff --git a/lib/courier/models/lists/subscription_subscribe_user_params.rb b/lib/courier/models/lists/subscription_subscribe_user_params.rb index b45dc7c3..d0207f1f 100644 --- a/lib/courier/models/lists/subscription_subscribe_user_params.rb +++ b/lib/courier/models/lists/subscription_subscribe_user_params.rb @@ -13,13 +13,19 @@ class SubscriptionSubscribeUserParams < Courier::Internal::Type::BaseModel # @return [String] required :list_id, String + # @!attribute user_id + # + # @return [String] + required :user_id, String + # @!attribute preferences # # @return [Courier::Models::RecipientPreferences, nil] optional :preferences, -> { Courier::RecipientPreferences }, nil?: true - # @!method initialize(list_id:, preferences: nil, request_options: {}) + # @!method initialize(list_id:, user_id:, preferences: nil, request_options: {}) # @param list_id [String] + # @param user_id [String] # @param preferences [Courier::Models::RecipientPreferences, nil] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end diff --git a/lib/courier/models/lists/subscription_unsubscribe_user_params.rb b/lib/courier/models/lists/subscription_unsubscribe_user_params.rb index a83f7478..59b7d01d 100644 --- a/lib/courier/models/lists/subscription_unsubscribe_user_params.rb +++ b/lib/courier/models/lists/subscription_unsubscribe_user_params.rb @@ -13,8 +13,14 @@ class SubscriptionUnsubscribeUserParams < Courier::Internal::Type::BaseModel # @return [String] required :list_id, String - # @!method initialize(list_id:, request_options: {}) + # @!attribute user_id + # + # @return [String] + required :user_id, String + + # @!method initialize(list_id:, user_id:, request_options: {}) # @param list_id [String] + # @param user_id [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/message_cancel_params.rb b/lib/courier/models/message_cancel_params.rb index d91edf5f..237ebdd3 100644 --- a/lib/courier/models/message_cancel_params.rb +++ b/lib/courier/models/message_cancel_params.rb @@ -7,7 +7,13 @@ class MessageCancelParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - # @!method initialize(request_options: {}) + # @!attribute message_id + # + # @return [String] + required :message_id, String + + # @!method initialize(message_id:, request_options: {}) + # @param message_id [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/message_content_params.rb b/lib/courier/models/message_content_params.rb index c5f94a20..a15abd04 100644 --- a/lib/courier/models/message_content_params.rb +++ b/lib/courier/models/message_content_params.rb @@ -7,7 +7,13 @@ class MessageContentParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - # @!method initialize(request_options: {}) + # @!attribute message_id + # + # @return [String] + required :message_id, String + + # @!method initialize(message_id:, request_options: {}) + # @param message_id [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/message_history_params.rb b/lib/courier/models/message_history_params.rb index 9cc2c9a6..a95ac5a0 100644 --- a/lib/courier/models/message_history_params.rb +++ b/lib/courier/models/message_history_params.rb @@ -7,13 +7,20 @@ class MessageHistoryParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + # @!attribute message_id + # + # @return [String] + required :message_id, String + # @!attribute type # A supported Message History type that will filter the events returned. # # @return [String, nil] optional :type, String, nil?: true - # @!method initialize(type: nil, request_options: {}) + # @!method initialize(message_id:, type: nil, request_options: {}) + # @param message_id [String] + # # @param type [String, nil] A supported Message History type that will filter the events returned. # # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] diff --git a/lib/courier/models/message_retrieve_params.rb b/lib/courier/models/message_retrieve_params.rb index 195f7780..adb66f98 100644 --- a/lib/courier/models/message_retrieve_params.rb +++ b/lib/courier/models/message_retrieve_params.rb @@ -7,7 +7,13 @@ class MessageRetrieveParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - # @!method initialize(request_options: {}) + # @!attribute message_id + # + # @return [String] + required :message_id, String + + # @!method initialize(message_id:, request_options: {}) + # @param message_id [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/notification_retrieve_content_params.rb b/lib/courier/models/notification_retrieve_content_params.rb index 75b01412..5a788c22 100644 --- a/lib/courier/models/notification_retrieve_content_params.rb +++ b/lib/courier/models/notification_retrieve_content_params.rb @@ -7,7 +7,13 @@ class NotificationRetrieveContentParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - # @!method initialize(request_options: {}) + # @!attribute id + # + # @return [String] + required :id, String + + # @!method initialize(id:, request_options: {}) + # @param id [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/notifications/check_delete_params.rb b/lib/courier/models/notifications/check_delete_params.rb index 2b3e9272..ab8b1d10 100644 --- a/lib/courier/models/notifications/check_delete_params.rb +++ b/lib/courier/models/notifications/check_delete_params.rb @@ -13,8 +13,14 @@ class CheckDeleteParams < Courier::Internal::Type::BaseModel # @return [String] required :id, String - # @!method initialize(id:, request_options: {}) + # @!attribute submission_id + # + # @return [String] + required :submission_id, String + + # @!method initialize(id:, submission_id:, request_options: {}) # @param id [String] + # @param submission_id [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/notifications/check_list_params.rb b/lib/courier/models/notifications/check_list_params.rb index d31fbfd4..ad37af2d 100644 --- a/lib/courier/models/notifications/check_list_params.rb +++ b/lib/courier/models/notifications/check_list_params.rb @@ -13,8 +13,14 @@ class CheckListParams < Courier::Internal::Type::BaseModel # @return [String] required :id, String - # @!method initialize(id:, request_options: {}) + # @!attribute submission_id + # + # @return [String] + required :submission_id, String + + # @!method initialize(id:, submission_id:, request_options: {}) # @param id [String] + # @param submission_id [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/notifications/check_update_params.rb b/lib/courier/models/notifications/check_update_params.rb index 69f31d7a..69a1aa22 100644 --- a/lib/courier/models/notifications/check_update_params.rb +++ b/lib/courier/models/notifications/check_update_params.rb @@ -13,13 +13,19 @@ class CheckUpdateParams < Courier::Internal::Type::BaseModel # @return [String] required :id, String + # @!attribute submission_id + # + # @return [String] + required :submission_id, String + # @!attribute checks # # @return [Array] required :checks, -> { Courier::Internal::Type::ArrayOf[Courier::BaseCheck] } - # @!method initialize(id:, checks:, request_options: {}) + # @!method initialize(id:, submission_id:, checks:, request_options: {}) # @param id [String] + # @param submission_id [String] # @param checks [Array] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end diff --git a/lib/courier/models/notifications/draft_retrieve_content_params.rb b/lib/courier/models/notifications/draft_retrieve_content_params.rb index 62b6d99c..014f5fba 100644 --- a/lib/courier/models/notifications/draft_retrieve_content_params.rb +++ b/lib/courier/models/notifications/draft_retrieve_content_params.rb @@ -8,7 +8,13 @@ class DraftRetrieveContentParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - # @!method initialize(request_options: {}) + # @!attribute id + # + # @return [String] + required :id, String + + # @!method initialize(id:, request_options: {}) + # @param id [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/profile_create_params.rb b/lib/courier/models/profile_create_params.rb index a00f5a6e..d1be11a0 100644 --- a/lib/courier/models/profile_create_params.rb +++ b/lib/courier/models/profile_create_params.rb @@ -7,12 +7,18 @@ class ProfileCreateParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + # @!attribute user_id + # + # @return [String] + required :user_id, String + # @!attribute profile # # @return [Hash{Symbol=>Object}] required :profile, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown] - # @!method initialize(profile:, request_options: {}) + # @!method initialize(user_id:, profile:, request_options: {}) + # @param user_id [String] # @param profile [Hash{Symbol=>Object}] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end diff --git a/lib/courier/models/profile_delete_params.rb b/lib/courier/models/profile_delete_params.rb index 39ef692b..d6f4a4ba 100644 --- a/lib/courier/models/profile_delete_params.rb +++ b/lib/courier/models/profile_delete_params.rb @@ -7,7 +7,13 @@ class ProfileDeleteParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - # @!method initialize(request_options: {}) + # @!attribute user_id + # + # @return [String] + required :user_id, String + + # @!method initialize(user_id:, request_options: {}) + # @param user_id [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/profile_replace_params.rb b/lib/courier/models/profile_replace_params.rb index 9db891fd..f7a01c09 100644 --- a/lib/courier/models/profile_replace_params.rb +++ b/lib/courier/models/profile_replace_params.rb @@ -7,12 +7,18 @@ class ProfileReplaceParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + # @!attribute user_id + # + # @return [String] + required :user_id, String + # @!attribute profile # # @return [Hash{Symbol=>Object}] required :profile, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown] - # @!method initialize(profile:, request_options: {}) + # @!method initialize(user_id:, profile:, request_options: {}) + # @param user_id [String] # @param profile [Hash{Symbol=>Object}] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end diff --git a/lib/courier/models/profile_retrieve_params.rb b/lib/courier/models/profile_retrieve_params.rb index 811944c0..8049c408 100644 --- a/lib/courier/models/profile_retrieve_params.rb +++ b/lib/courier/models/profile_retrieve_params.rb @@ -7,7 +7,13 @@ class ProfileRetrieveParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - # @!method initialize(request_options: {}) + # @!attribute user_id + # + # @return [String] + required :user_id, String + + # @!method initialize(user_id:, request_options: {}) + # @param user_id [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/profile_update_params.rb b/lib/courier/models/profile_update_params.rb index 2f92e7f0..5a0d0c14 100644 --- a/lib/courier/models/profile_update_params.rb +++ b/lib/courier/models/profile_update_params.rb @@ -7,13 +7,20 @@ class ProfileUpdateParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + # @!attribute user_id + # + # @return [String] + required :user_id, String + # @!attribute patch # List of patch operations to apply to the profile. # # @return [Array] required :patch, -> { Courier::Internal::Type::ArrayOf[Courier::ProfileUpdateParams::Patch] } - # @!method initialize(patch:, request_options: {}) + # @!method initialize(user_id:, patch:, request_options: {}) + # @param user_id [String] + # # @param patch [Array] List of patch operations to apply to the profile. # # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] diff --git a/lib/courier/models/profiles/list_delete_params.rb b/lib/courier/models/profiles/list_delete_params.rb index 0687d23c..83737305 100644 --- a/lib/courier/models/profiles/list_delete_params.rb +++ b/lib/courier/models/profiles/list_delete_params.rb @@ -8,7 +8,13 @@ class ListDeleteParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - # @!method initialize(request_options: {}) + # @!attribute user_id + # + # @return [String] + required :user_id, String + + # @!method initialize(user_id:, request_options: {}) + # @param user_id [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/profiles/list_retrieve_params.rb b/lib/courier/models/profiles/list_retrieve_params.rb index 29c9391f..4348393a 100644 --- a/lib/courier/models/profiles/list_retrieve_params.rb +++ b/lib/courier/models/profiles/list_retrieve_params.rb @@ -8,13 +8,20 @@ class ListRetrieveParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + # @!attribute user_id + # + # @return [String] + required :user_id, String + # @!attribute cursor # A unique identifier that allows for fetching the next set of message statuses. # # @return [String, nil] optional :cursor, String, nil?: true - # @!method initialize(cursor: nil, request_options: {}) + # @!method initialize(user_id:, cursor: nil, request_options: {}) + # @param user_id [String] + # # @param cursor [String, nil] A unique identifier that allows for fetching the next set of message statuses. # # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] diff --git a/lib/courier/models/profiles/list_subscribe_params.rb b/lib/courier/models/profiles/list_subscribe_params.rb index 5047be35..e16199f7 100644 --- a/lib/courier/models/profiles/list_subscribe_params.rb +++ b/lib/courier/models/profiles/list_subscribe_params.rb @@ -8,12 +8,18 @@ class ListSubscribeParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + # @!attribute user_id + # + # @return [String] + required :user_id, String + # @!attribute lists # # @return [Array] required :lists, -> { Courier::Internal::Type::ArrayOf[Courier::SubscribeToListsRequestItem] } - # @!method initialize(lists:, request_options: {}) + # @!method initialize(user_id:, lists:, request_options: {}) + # @param user_id [String] # @param lists [Array] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end diff --git a/lib/courier/models/request_archive_params.rb b/lib/courier/models/request_archive_params.rb index 06a421cd..c46ff6e9 100644 --- a/lib/courier/models/request_archive_params.rb +++ b/lib/courier/models/request_archive_params.rb @@ -7,7 +7,13 @@ class RequestArchiveParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - # @!method initialize(request_options: {}) + # @!attribute request_id + # + # @return [String] + required :request_id, String + + # @!method initialize(request_id:, request_options: {}) + # @param request_id [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/tenant_delete_params.rb b/lib/courier/models/tenant_delete_params.rb index 6d38947a..ee70ec8d 100644 --- a/lib/courier/models/tenant_delete_params.rb +++ b/lib/courier/models/tenant_delete_params.rb @@ -7,7 +7,13 @@ class TenantDeleteParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - # @!method initialize(request_options: {}) + # @!attribute tenant_id + # + # @return [String] + required :tenant_id, String + + # @!method initialize(tenant_id:, request_options: {}) + # @param tenant_id [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/tenant_list_users_params.rb b/lib/courier/models/tenant_list_users_params.rb index 1174984a..e6e8ddc1 100644 --- a/lib/courier/models/tenant_list_users_params.rb +++ b/lib/courier/models/tenant_list_users_params.rb @@ -7,6 +7,11 @@ class TenantListUsersParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + # @!attribute tenant_id + # + # @return [String] + required :tenant_id, String + # @!attribute cursor # Continue the pagination with the next cursor # @@ -19,10 +24,12 @@ class TenantListUsersParams < Courier::Internal::Type::BaseModel # @return [Integer, nil] optional :limit, Integer, nil?: true - # @!method initialize(cursor: nil, limit: nil, request_options: {}) + # @!method initialize(tenant_id:, cursor: nil, limit: nil, request_options: {}) # Some parameter documentations has been truncated, see # {Courier::Models::TenantListUsersParams} for more details. # + # @param tenant_id [String] + # # @param cursor [String, nil] Continue the pagination with the next cursor # # @param limit [Integer, nil] The number of accounts to return diff --git a/lib/courier/models/tenant_retrieve_params.rb b/lib/courier/models/tenant_retrieve_params.rb index d1c72b78..cc846e60 100644 --- a/lib/courier/models/tenant_retrieve_params.rb +++ b/lib/courier/models/tenant_retrieve_params.rb @@ -7,7 +7,13 @@ class TenantRetrieveParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - # @!method initialize(request_options: {}) + # @!attribute tenant_id + # + # @return [String] + required :tenant_id, String + + # @!method initialize(tenant_id:, request_options: {}) + # @param tenant_id [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/tenant_update_params.rb b/lib/courier/models/tenant_update_params.rb index 5931d424..d11a35b8 100644 --- a/lib/courier/models/tenant_update_params.rb +++ b/lib/courier/models/tenant_update_params.rb @@ -7,6 +7,11 @@ class TenantUpdateParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + # @!attribute tenant_id + # + # @return [String] + required :tenant_id, String + # @!attribute name # Name of the tenant. # @@ -44,10 +49,12 @@ class TenantUpdateParams < Courier::Internal::Type::BaseModel # @return [Hash{Symbol=>Object}, nil] optional :user_profile, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown], nil?: true - # @!method initialize(name:, brand_id: nil, default_preferences: nil, parent_tenant_id: nil, properties: nil, user_profile: nil, request_options: {}) + # @!method initialize(tenant_id:, name:, brand_id: nil, default_preferences: nil, parent_tenant_id: nil, properties: nil, user_profile: nil, request_options: {}) # Some parameter documentations has been truncated, see # {Courier::Models::TenantUpdateParams} for more details. # + # @param tenant_id [String] + # # @param name [String] Name of the tenant. # # @param brand_id [String, nil] Brand to be used for the account when one is not specified by the send call. diff --git a/lib/courier/models/tenants/preferences/item_delete_params.rb b/lib/courier/models/tenants/preferences/item_delete_params.rb index 914ce623..652f9088 100644 --- a/lib/courier/models/tenants/preferences/item_delete_params.rb +++ b/lib/courier/models/tenants/preferences/item_delete_params.rb @@ -14,8 +14,14 @@ class ItemDeleteParams < Courier::Internal::Type::BaseModel # @return [String] required :tenant_id, String - # @!method initialize(tenant_id:, request_options: {}) + # @!attribute topic_id + # + # @return [String] + required :topic_id, String + + # @!method initialize(tenant_id:, topic_id:, request_options: {}) # @param tenant_id [String] + # @param topic_id [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/tenants/preferences/item_update_params.rb b/lib/courier/models/tenants/preferences/item_update_params.rb index 3b31fa88..76c919db 100644 --- a/lib/courier/models/tenants/preferences/item_update_params.rb +++ b/lib/courier/models/tenants/preferences/item_update_params.rb @@ -14,8 +14,14 @@ class ItemUpdateParams < Courier::Models::SubscriptionTopicNew # @return [String] required :tenant_id, String - # @!method initialize(tenant_id:, request_options: {}) + # @!attribute topic_id + # + # @return [String] + required :topic_id, String + + # @!method initialize(tenant_id:, topic_id:, request_options: {}) # @param tenant_id [String] + # @param topic_id [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/tenants/template_list_params.rb b/lib/courier/models/tenants/template_list_params.rb index b1bd84d0..3e61ff9b 100644 --- a/lib/courier/models/tenants/template_list_params.rb +++ b/lib/courier/models/tenants/template_list_params.rb @@ -8,6 +8,11 @@ class TemplateListParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + # @!attribute tenant_id + # + # @return [String] + required :tenant_id, String + # @!attribute cursor # Continue the pagination with the next cursor # @@ -20,7 +25,9 @@ class TemplateListParams < Courier::Internal::Type::BaseModel # @return [Integer, nil] optional :limit, Integer, nil?: true - # @!method initialize(cursor: nil, limit: nil, request_options: {}) + # @!method initialize(tenant_id:, cursor: nil, limit: nil, request_options: {}) + # @param tenant_id [String] + # # @param cursor [String, nil] Continue the pagination with the next cursor # # @param limit [Integer, nil] The number of templates to return (defaults to 20, maximum value of 100) diff --git a/lib/courier/models/tenants/template_publish_params.rb b/lib/courier/models/tenants/template_publish_params.rb index 535efd50..547370e4 100644 --- a/lib/courier/models/tenants/template_publish_params.rb +++ b/lib/courier/models/tenants/template_publish_params.rb @@ -13,8 +13,14 @@ class TemplatePublishParams < Courier::Models::PostTenantTemplatePublishRequest # @return [String] required :tenant_id, String - # @!method initialize(tenant_id:, request_options: {}) + # @!attribute template_id + # + # @return [String] + required :template_id, String + + # @!method initialize(tenant_id:, template_id:, request_options: {}) # @param tenant_id [String] + # @param template_id [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/tenants/template_replace_params.rb b/lib/courier/models/tenants/template_replace_params.rb index a35d81eb..e7086e1b 100644 --- a/lib/courier/models/tenants/template_replace_params.rb +++ b/lib/courier/models/tenants/template_replace_params.rb @@ -13,8 +13,14 @@ class TemplateReplaceParams < Courier::Models::PutTenantTemplateRequest # @return [String] required :tenant_id, String - # @!method initialize(tenant_id:, request_options: {}) + # @!attribute template_id + # + # @return [String] + required :template_id, String + + # @!method initialize(tenant_id:, template_id:, request_options: {}) # @param tenant_id [String] + # @param template_id [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/tenants/template_retrieve_params.rb b/lib/courier/models/tenants/template_retrieve_params.rb index 8f4812c4..42e29da5 100644 --- a/lib/courier/models/tenants/template_retrieve_params.rb +++ b/lib/courier/models/tenants/template_retrieve_params.rb @@ -13,8 +13,14 @@ class TemplateRetrieveParams < Courier::Internal::Type::BaseModel # @return [String] required :tenant_id, String - # @!method initialize(tenant_id:, request_options: {}) + # @!attribute template_id + # + # @return [String] + required :template_id, String + + # @!method initialize(tenant_id:, template_id:, request_options: {}) # @param tenant_id [String] + # @param template_id [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/tenants/templates/version_retrieve_params.rb b/lib/courier/models/tenants/templates/version_retrieve_params.rb index 22dfa0fd..d0da63ab 100644 --- a/lib/courier/models/tenants/templates/version_retrieve_params.rb +++ b/lib/courier/models/tenants/templates/version_retrieve_params.rb @@ -19,9 +19,15 @@ class VersionRetrieveParams < Courier::Internal::Type::BaseModel # @return [String] required :template_id, String - # @!method initialize(tenant_id:, template_id:, request_options: {}) + # @!attribute version + # + # @return [String] + required :version, String + + # @!method initialize(tenant_id:, template_id:, version:, request_options: {}) # @param tenant_id [String] # @param template_id [String] + # @param version [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/translation_retrieve_params.rb b/lib/courier/models/translation_retrieve_params.rb index 2db69517..8e1bc5bf 100644 --- a/lib/courier/models/translation_retrieve_params.rb +++ b/lib/courier/models/translation_retrieve_params.rb @@ -12,8 +12,14 @@ class TranslationRetrieveParams < Courier::Internal::Type::BaseModel # @return [String] required :domain, String - # @!method initialize(domain:, request_options: {}) + # @!attribute locale + # + # @return [String] + required :locale, String + + # @!method initialize(domain:, locale:, request_options: {}) # @param domain [String] + # @param locale [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/translation_update_params.rb b/lib/courier/models/translation_update_params.rb index 14716446..e6363f27 100644 --- a/lib/courier/models/translation_update_params.rb +++ b/lib/courier/models/translation_update_params.rb @@ -12,13 +12,19 @@ class TranslationUpdateParams < Courier::Internal::Type::BaseModel # @return [String] required :domain, String + # @!attribute locale + # + # @return [String] + required :locale, String + # @!attribute body # # @return [String] required :body, String - # @!method initialize(domain:, body:, request_options: {}) + # @!method initialize(domain:, locale:, body:, request_options: {}) # @param domain [String] + # @param locale [String] # @param body [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end diff --git a/lib/courier/models/users/preference_retrieve_params.rb b/lib/courier/models/users/preference_retrieve_params.rb index 947c6963..dc235113 100644 --- a/lib/courier/models/users/preference_retrieve_params.rb +++ b/lib/courier/models/users/preference_retrieve_params.rb @@ -8,13 +8,20 @@ class PreferenceRetrieveParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + # @!attribute user_id + # + # @return [String] + required :user_id, String + # @!attribute tenant_id # Query the preferences of a user for this specific tenant context. # # @return [String, nil] optional :tenant_id, String, nil?: true - # @!method initialize(tenant_id: nil, request_options: {}) + # @!method initialize(user_id:, tenant_id: nil, request_options: {}) + # @param user_id [String] + # # @param tenant_id [String, nil] Query the preferences of a user for this specific tenant context. # # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] diff --git a/lib/courier/models/users/preference_retrieve_topic_params.rb b/lib/courier/models/users/preference_retrieve_topic_params.rb index 0a4cb651..36dc8419 100644 --- a/lib/courier/models/users/preference_retrieve_topic_params.rb +++ b/lib/courier/models/users/preference_retrieve_topic_params.rb @@ -13,15 +13,22 @@ class PreferenceRetrieveTopicParams < Courier::Internal::Type::BaseModel # @return [String] required :user_id, String + # @!attribute topic_id + # + # @return [String] + required :topic_id, String + # @!attribute tenant_id # Query the preferences of a user for this specific tenant context. # # @return [String, nil] optional :tenant_id, String, nil?: true - # @!method initialize(user_id:, tenant_id: nil, request_options: {}) + # @!method initialize(user_id:, topic_id:, tenant_id: nil, request_options: {}) # @param user_id [String] # + # @param topic_id [String] + # # @param tenant_id [String, nil] Query the preferences of a user for this specific tenant context. # # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] diff --git a/lib/courier/models/users/preference_update_or_create_topic_params.rb b/lib/courier/models/users/preference_update_or_create_topic_params.rb index 75f4922c..4b1a26e5 100644 --- a/lib/courier/models/users/preference_update_or_create_topic_params.rb +++ b/lib/courier/models/users/preference_update_or_create_topic_params.rb @@ -13,6 +13,11 @@ class PreferenceUpdateOrCreateTopicParams < Courier::Internal::Type::BaseModel # @return [String] required :user_id, String + # @!attribute topic_id + # + # @return [String] + required :topic_id, String + # @!attribute topic # # @return [Courier::Models::Users::PreferenceUpdateOrCreateTopicParams::Topic] @@ -24,9 +29,11 @@ class PreferenceUpdateOrCreateTopicParams < Courier::Internal::Type::BaseModel # @return [String, nil] optional :tenant_id, String, nil?: true - # @!method initialize(user_id:, topic:, tenant_id: nil, request_options: {}) + # @!method initialize(user_id:, topic_id:, topic:, tenant_id: nil, request_options: {}) # @param user_id [String] # + # @param topic_id [String] + # # @param topic [Courier::Models::Users::PreferenceUpdateOrCreateTopicParams::Topic] # # @param tenant_id [String, nil] Update the preferences of a user for this specific tenant context. diff --git a/lib/courier/models/users/tenant_add_multiple_params.rb b/lib/courier/models/users/tenant_add_multiple_params.rb index 10f90572..82163d6e 100644 --- a/lib/courier/models/users/tenant_add_multiple_params.rb +++ b/lib/courier/models/users/tenant_add_multiple_params.rb @@ -8,12 +8,18 @@ class TenantAddMultipleParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + # @!attribute user_id + # + # @return [String] + required :user_id, String + # @!attribute tenants # # @return [Array] required :tenants, -> { Courier::Internal::Type::ArrayOf[Courier::TenantAssociation] } - # @!method initialize(tenants:, request_options: {}) + # @!method initialize(user_id:, tenants:, request_options: {}) + # @param user_id [String] # @param tenants [Array] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end diff --git a/lib/courier/models/users/tenant_add_single_params.rb b/lib/courier/models/users/tenant_add_single_params.rb index 2077a7cb..363b7447 100644 --- a/lib/courier/models/users/tenant_add_single_params.rb +++ b/lib/courier/models/users/tenant_add_single_params.rb @@ -13,13 +13,19 @@ class TenantAddSingleParams < Courier::Internal::Type::BaseModel # @return [String] required :user_id, String + # @!attribute tenant_id + # + # @return [String] + required :tenant_id, String + # @!attribute profile # # @return [Hash{Symbol=>Object}, nil] optional :profile, Courier::Internal::Type::HashOf[Courier::Internal::Type::Unknown], nil?: true - # @!method initialize(user_id:, profile: nil, request_options: {}) + # @!method initialize(user_id:, tenant_id:, profile: nil, request_options: {}) # @param user_id [String] + # @param tenant_id [String] # @param profile [Hash{Symbol=>Object}, nil] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end diff --git a/lib/courier/models/users/tenant_list_params.rb b/lib/courier/models/users/tenant_list_params.rb index dc2cd8f9..10fc7e11 100644 --- a/lib/courier/models/users/tenant_list_params.rb +++ b/lib/courier/models/users/tenant_list_params.rb @@ -8,6 +8,11 @@ class TenantListParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + # @!attribute user_id + # + # @return [String] + required :user_id, String + # @!attribute cursor # Continue the pagination with the next cursor # @@ -20,10 +25,12 @@ class TenantListParams < Courier::Internal::Type::BaseModel # @return [Integer, nil] optional :limit, Integer, nil?: true - # @!method initialize(cursor: nil, limit: nil, request_options: {}) + # @!method initialize(user_id:, cursor: nil, limit: nil, request_options: {}) # Some parameter documentations has been truncated, see # {Courier::Models::Users::TenantListParams} for more details. # + # @param user_id [String] + # # @param cursor [String, nil] Continue the pagination with the next cursor # # @param limit [Integer, nil] The number of accounts to return diff --git a/lib/courier/models/users/tenant_remove_all_params.rb b/lib/courier/models/users/tenant_remove_all_params.rb index 260451bb..8a5d9b05 100644 --- a/lib/courier/models/users/tenant_remove_all_params.rb +++ b/lib/courier/models/users/tenant_remove_all_params.rb @@ -8,7 +8,13 @@ class TenantRemoveAllParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - # @!method initialize(request_options: {}) + # @!attribute user_id + # + # @return [String] + required :user_id, String + + # @!method initialize(user_id:, request_options: {}) + # @param user_id [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/users/tenant_remove_single_params.rb b/lib/courier/models/users/tenant_remove_single_params.rb index 67b086ad..456c24ac 100644 --- a/lib/courier/models/users/tenant_remove_single_params.rb +++ b/lib/courier/models/users/tenant_remove_single_params.rb @@ -13,8 +13,14 @@ class TenantRemoveSingleParams < Courier::Internal::Type::BaseModel # @return [String] required :user_id, String - # @!method initialize(user_id:, request_options: {}) + # @!attribute tenant_id + # + # @return [String] + required :tenant_id, String + + # @!method initialize(user_id:, tenant_id:, request_options: {}) # @param user_id [String] + # @param tenant_id [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/users/token_add_multiple_params.rb b/lib/courier/models/users/token_add_multiple_params.rb index 03b064fa..14afbc8a 100644 --- a/lib/courier/models/users/token_add_multiple_params.rb +++ b/lib/courier/models/users/token_add_multiple_params.rb @@ -8,7 +8,13 @@ class TokenAddMultipleParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - # @!method initialize(request_options: {}) + # @!attribute user_id + # + # @return [String] + required :user_id, String + + # @!method initialize(user_id:, request_options: {}) + # @param user_id [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/users/token_add_single_params.rb b/lib/courier/models/users/token_add_single_params.rb index baf7697f..c7bd3d10 100644 --- a/lib/courier/models/users/token_add_single_params.rb +++ b/lib/courier/models/users/token_add_single_params.rb @@ -13,6 +13,11 @@ class TokenAddSingleParams < Courier::Internal::Type::BaseModel # @return [String] required :user_id, String + # @!attribute token + # + # @return [String] + required :token, String + # @!attribute provider_key # # @return [Symbol, Courier::Models::Users::TokenAddSingleParams::ProviderKey] @@ -43,12 +48,14 @@ class TokenAddSingleParams < Courier::Internal::Type::BaseModel # @return [Courier::Models::Users::TokenAddSingleParams::Tracking, nil] optional :tracking, -> { Courier::Users::TokenAddSingleParams::Tracking }, nil?: true - # @!method initialize(user_id:, provider_key:, device: nil, expiry_date: nil, properties: nil, tracking: nil, request_options: {}) + # @!method initialize(user_id:, token:, provider_key:, device: nil, expiry_date: nil, properties: nil, tracking: nil, request_options: {}) # Some parameter documentations has been truncated, see # {Courier::Models::Users::TokenAddSingleParams} for more details. # # @param user_id [String] # + # @param token [String] + # # @param provider_key [Symbol, Courier::Models::Users::TokenAddSingleParams::ProviderKey] # # @param device [Courier::Models::Users::TokenAddSingleParams::Device, nil] Information about the device the token came from. diff --git a/lib/courier/models/users/token_delete_params.rb b/lib/courier/models/users/token_delete_params.rb index 3b2caf9c..5a2d5e0c 100644 --- a/lib/courier/models/users/token_delete_params.rb +++ b/lib/courier/models/users/token_delete_params.rb @@ -13,8 +13,14 @@ class TokenDeleteParams < Courier::Internal::Type::BaseModel # @return [String] required :user_id, String - # @!method initialize(user_id:, request_options: {}) + # @!attribute token + # + # @return [String] + required :token, String + + # @!method initialize(user_id:, token:, request_options: {}) # @param user_id [String] + # @param token [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/users/token_list_params.rb b/lib/courier/models/users/token_list_params.rb index eb6cc41c..f4a7f8dc 100644 --- a/lib/courier/models/users/token_list_params.rb +++ b/lib/courier/models/users/token_list_params.rb @@ -8,7 +8,13 @@ class TokenListParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - # @!method initialize(request_options: {}) + # @!attribute user_id + # + # @return [String] + required :user_id, String + + # @!method initialize(user_id:, request_options: {}) + # @param user_id [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/users/token_retrieve_params.rb b/lib/courier/models/users/token_retrieve_params.rb index d60f2cdf..1ac5d9a7 100644 --- a/lib/courier/models/users/token_retrieve_params.rb +++ b/lib/courier/models/users/token_retrieve_params.rb @@ -13,8 +13,14 @@ class TokenRetrieveParams < Courier::Internal::Type::BaseModel # @return [String] required :user_id, String - # @!method initialize(user_id:, request_options: {}) + # @!attribute token + # + # @return [String] + required :token, String + + # @!method initialize(user_id:, token:, request_options: {}) # @param user_id [String] + # @param token [String] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] end end diff --git a/lib/courier/models/users/token_update_params.rb b/lib/courier/models/users/token_update_params.rb index 6756e3c3..b4ad5b76 100644 --- a/lib/courier/models/users/token_update_params.rb +++ b/lib/courier/models/users/token_update_params.rb @@ -13,13 +13,19 @@ class TokenUpdateParams < Courier::Internal::Type::BaseModel # @return [String] required :user_id, String + # @!attribute token + # + # @return [String] + required :token, String + # @!attribute patch # # @return [Array] required :patch, -> { Courier::Internal::Type::ArrayOf[Courier::Users::TokenUpdateParams::Patch] } - # @!method initialize(user_id:, patch:, request_options: {}) + # @!method initialize(user_id:, token:, patch:, request_options: {}) # @param user_id [String] + # @param token [String] # @param patch [Array] # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}] diff --git a/rbi/courier/models/audience_delete_params.rbi b/rbi/courier/models/audience_delete_params.rbi index 6f5fe1ad..5b2d7652 100644 --- a/rbi/courier/models/audience_delete_params.rbi +++ b/rbi/courier/models/audience_delete_params.rbi @@ -11,15 +11,23 @@ module Courier T.any(Courier::AudienceDeleteParams, Courier::Internal::AnyHash) end + sig { returns(String) } + attr_accessor :audience_id + sig do - params(request_options: Courier::RequestOptions::OrHash).returns( - T.attached_class - ) + params( + audience_id: String, + request_options: Courier::RequestOptions::OrHash + ).returns(T.attached_class) end - def self.new(request_options: {}) + def self.new(audience_id:, request_options: {}) end - sig { override.returns({ request_options: Courier::RequestOptions }) } + sig do + override.returns( + { audience_id: String, request_options: Courier::RequestOptions } + ) + end def to_hash end end diff --git a/rbi/courier/models/audience_list_members_params.rbi b/rbi/courier/models/audience_list_members_params.rbi index 93b0cc77..908a83bd 100644 --- a/rbi/courier/models/audience_list_members_params.rbi +++ b/rbi/courier/models/audience_list_members_params.rbi @@ -11,17 +11,22 @@ module Courier T.any(Courier::AudienceListMembersParams, Courier::Internal::AnyHash) end + sig { returns(String) } + attr_accessor :audience_id + # A unique identifier that allows for fetching the next set of members sig { returns(T.nilable(String)) } attr_accessor :cursor sig do params( + audience_id: String, cursor: T.nilable(String), request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( + audience_id:, # A unique identifier that allows for fetching the next set of members cursor: nil, request_options: {} @@ -31,6 +36,7 @@ module Courier sig do override.returns( { + audience_id: String, cursor: T.nilable(String), request_options: Courier::RequestOptions } diff --git a/rbi/courier/models/audience_retrieve_params.rbi b/rbi/courier/models/audience_retrieve_params.rbi index 99bb9f16..e99a591c 100644 --- a/rbi/courier/models/audience_retrieve_params.rbi +++ b/rbi/courier/models/audience_retrieve_params.rbi @@ -11,15 +11,23 @@ module Courier T.any(Courier::AudienceRetrieveParams, Courier::Internal::AnyHash) end + sig { returns(String) } + attr_accessor :audience_id + sig do - params(request_options: Courier::RequestOptions::OrHash).returns( - T.attached_class - ) + params( + audience_id: String, + request_options: Courier::RequestOptions::OrHash + ).returns(T.attached_class) end - def self.new(request_options: {}) + def self.new(audience_id:, request_options: {}) end - sig { override.returns({ request_options: Courier::RequestOptions }) } + sig do + override.returns( + { audience_id: String, request_options: Courier::RequestOptions } + ) + end def to_hash end end diff --git a/rbi/courier/models/audience_update_params.rbi b/rbi/courier/models/audience_update_params.rbi index 334f7921..5b8b5958 100644 --- a/rbi/courier/models/audience_update_params.rbi +++ b/rbi/courier/models/audience_update_params.rbi @@ -11,6 +11,9 @@ module Courier T.any(Courier::AudienceUpdateParams, Courier::Internal::AnyHash) end + sig { returns(String) } + attr_accessor :audience_id + # A description of the audience sig { returns(T.nilable(String)) } attr_accessor :description @@ -36,6 +39,7 @@ module Courier sig do params( + audience_id: String, description: T.nilable(String), filter: T.nilable(Courier::AudienceFilterConfig::OrHash), name: T.nilable(String), @@ -45,6 +49,7 @@ module Courier ).returns(T.attached_class) end def self.new( + audience_id:, # A description of the audience description: nil, # Filter configuration for audience membership containing an array of filter rules @@ -60,6 +65,7 @@ module Courier sig do override.returns( { + audience_id: String, description: T.nilable(String), filter: T.nilable(Courier::AudienceFilterConfig), name: T.nilable(String), diff --git a/rbi/courier/models/audit_event_retrieve_params.rbi b/rbi/courier/models/audit_event_retrieve_params.rbi index 44cd5853..d76b39b4 100644 --- a/rbi/courier/models/audit_event_retrieve_params.rbi +++ b/rbi/courier/models/audit_event_retrieve_params.rbi @@ -11,15 +11,23 @@ module Courier T.any(Courier::AuditEventRetrieveParams, Courier::Internal::AnyHash) end + sig { returns(String) } + attr_accessor :audit_event_id + sig do - params(request_options: Courier::RequestOptions::OrHash).returns( - T.attached_class - ) + params( + audit_event_id: String, + request_options: Courier::RequestOptions::OrHash + ).returns(T.attached_class) end - def self.new(request_options: {}) + def self.new(audit_event_id:, request_options: {}) end - sig { override.returns({ request_options: Courier::RequestOptions }) } + sig do + override.returns( + { audit_event_id: String, request_options: Courier::RequestOptions } + ) + end def to_hash end end diff --git a/rbi/courier/models/automations/invoke_invoke_by_template_params.rbi b/rbi/courier/models/automations/invoke_invoke_by_template_params.rbi index 70fd95ea..726039b0 100644 --- a/rbi/courier/models/automations/invoke_invoke_by_template_params.rbi +++ b/rbi/courier/models/automations/invoke_invoke_by_template_params.rbi @@ -15,6 +15,9 @@ module Courier ) end + sig { returns(String) } + attr_accessor :template_id + sig { returns(T.nilable(String)) } attr_accessor :recipient @@ -32,6 +35,7 @@ module Courier sig do params( + template_id: String, recipient: T.nilable(String), brand: T.nilable(String), data: T.nilable(T::Hash[Symbol, T.anything]), @@ -41,6 +45,7 @@ module Courier ).returns(T.attached_class) end def self.new( + template_id:, recipient:, brand: nil, data: nil, @@ -53,6 +58,7 @@ module Courier sig do override.returns( { + template_id: String, recipient: T.nilable(String), brand: T.nilable(String), data: T.nilable(T::Hash[Symbol, T.anything]), diff --git a/rbi/courier/models/brand_delete_params.rbi b/rbi/courier/models/brand_delete_params.rbi index 807bfd59..76aa3fdc 100644 --- a/rbi/courier/models/brand_delete_params.rbi +++ b/rbi/courier/models/brand_delete_params.rbi @@ -11,15 +11,23 @@ module Courier T.any(Courier::BrandDeleteParams, Courier::Internal::AnyHash) end + sig { returns(String) } + attr_accessor :brand_id + sig do - params(request_options: Courier::RequestOptions::OrHash).returns( - T.attached_class - ) + params( + brand_id: String, + request_options: Courier::RequestOptions::OrHash + ).returns(T.attached_class) end - def self.new(request_options: {}) + def self.new(brand_id:, request_options: {}) end - sig { override.returns({ request_options: Courier::RequestOptions }) } + sig do + override.returns( + { brand_id: String, request_options: Courier::RequestOptions } + ) + end def to_hash end end diff --git a/rbi/courier/models/brand_retrieve_params.rbi b/rbi/courier/models/brand_retrieve_params.rbi index ed6dd3b6..28cea371 100644 --- a/rbi/courier/models/brand_retrieve_params.rbi +++ b/rbi/courier/models/brand_retrieve_params.rbi @@ -11,15 +11,23 @@ module Courier T.any(Courier::BrandRetrieveParams, Courier::Internal::AnyHash) end + sig { returns(String) } + attr_accessor :brand_id + sig do - params(request_options: Courier::RequestOptions::OrHash).returns( - T.attached_class - ) + params( + brand_id: String, + request_options: Courier::RequestOptions::OrHash + ).returns(T.attached_class) end - def self.new(request_options: {}) + def self.new(brand_id:, request_options: {}) end - sig { override.returns({ request_options: Courier::RequestOptions }) } + sig do + override.returns( + { brand_id: String, request_options: Courier::RequestOptions } + ) + end def to_hash end end diff --git a/rbi/courier/models/brand_update_params.rbi b/rbi/courier/models/brand_update_params.rbi index 92d90c7f..b02bb3be 100644 --- a/rbi/courier/models/brand_update_params.rbi +++ b/rbi/courier/models/brand_update_params.rbi @@ -11,6 +11,9 @@ module Courier T.any(Courier::BrandUpdateParams, Courier::Internal::AnyHash) end + sig { returns(String) } + attr_accessor :brand_id + # The name of the brand. sig { returns(String) } attr_accessor :name @@ -29,6 +32,7 @@ module Courier sig do params( + brand_id: String, name: String, settings: T.nilable(Courier::BrandSettings::OrHash), snippets: T.nilable(Courier::BrandSnippets::OrHash), @@ -36,6 +40,7 @@ module Courier ).returns(T.attached_class) end def self.new( + brand_id:, # The name of the brand. name:, settings: nil, @@ -47,6 +52,7 @@ module Courier sig do override.returns( { + brand_id: String, name: String, settings: T.nilable(Courier::BrandSettings), snippets: T.nilable(Courier::BrandSnippets), diff --git a/rbi/courier/models/bulk_add_users_params.rbi b/rbi/courier/models/bulk_add_users_params.rbi index f4be6df3..491d120b 100644 --- a/rbi/courier/models/bulk_add_users_params.rbi +++ b/rbi/courier/models/bulk_add_users_params.rbi @@ -11,21 +11,26 @@ module Courier T.any(Courier::BulkAddUsersParams, Courier::Internal::AnyHash) end + sig { returns(String) } + attr_accessor :job_id + sig { returns(T::Array[Courier::InboundBulkMessageUser]) } attr_accessor :users sig do params( + job_id: String, users: T::Array[Courier::InboundBulkMessageUser::OrHash], request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new(users:, request_options: {}) + def self.new(job_id:, users:, request_options: {}) end sig do override.returns( { + job_id: String, users: T::Array[Courier::InboundBulkMessageUser], request_options: Courier::RequestOptions } diff --git a/rbi/courier/models/bulk_list_users_params.rbi b/rbi/courier/models/bulk_list_users_params.rbi index 9cb074b2..6b1cbec5 100644 --- a/rbi/courier/models/bulk_list_users_params.rbi +++ b/rbi/courier/models/bulk_list_users_params.rbi @@ -11,6 +11,9 @@ module Courier T.any(Courier::BulkListUsersParams, Courier::Internal::AnyHash) end + sig { returns(String) } + attr_accessor :job_id + # A unique identifier that allows for fetching the next set of users added to the # bulk job sig { returns(T.nilable(String)) } @@ -18,11 +21,13 @@ module Courier sig do params( + job_id: String, cursor: T.nilable(String), request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( + job_id:, # A unique identifier that allows for fetching the next set of users added to the # bulk job cursor: nil, @@ -33,6 +38,7 @@ module Courier sig do override.returns( { + job_id: String, cursor: T.nilable(String), request_options: Courier::RequestOptions } diff --git a/rbi/courier/models/bulk_retrieve_job_params.rbi b/rbi/courier/models/bulk_retrieve_job_params.rbi index 56a42caa..292b2696 100644 --- a/rbi/courier/models/bulk_retrieve_job_params.rbi +++ b/rbi/courier/models/bulk_retrieve_job_params.rbi @@ -11,15 +11,23 @@ module Courier T.any(Courier::BulkRetrieveJobParams, Courier::Internal::AnyHash) end + sig { returns(String) } + attr_accessor :job_id + sig do - params(request_options: Courier::RequestOptions::OrHash).returns( - T.attached_class - ) + params( + job_id: String, + request_options: Courier::RequestOptions::OrHash + ).returns(T.attached_class) end - def self.new(request_options: {}) + def self.new(job_id:, request_options: {}) end - sig { override.returns({ request_options: Courier::RequestOptions }) } + sig do + override.returns( + { job_id: String, request_options: Courier::RequestOptions } + ) + end def to_hash end end diff --git a/rbi/courier/models/bulk_run_job_params.rbi b/rbi/courier/models/bulk_run_job_params.rbi index d9a70757..fc21b61d 100644 --- a/rbi/courier/models/bulk_run_job_params.rbi +++ b/rbi/courier/models/bulk_run_job_params.rbi @@ -11,15 +11,23 @@ module Courier T.any(Courier::BulkRunJobParams, Courier::Internal::AnyHash) end + sig { returns(String) } + attr_accessor :job_id + sig do - params(request_options: Courier::RequestOptions::OrHash).returns( - T.attached_class - ) + params( + job_id: String, + request_options: Courier::RequestOptions::OrHash + ).returns(T.attached_class) end - def self.new(request_options: {}) + def self.new(job_id:, request_options: {}) end - sig { override.returns({ request_options: Courier::RequestOptions }) } + sig do + override.returns( + { job_id: String, request_options: Courier::RequestOptions } + ) + end def to_hash end end diff --git a/rbi/courier/models/list_delete_params.rbi b/rbi/courier/models/list_delete_params.rbi index 78154e26..d892eb4b 100644 --- a/rbi/courier/models/list_delete_params.rbi +++ b/rbi/courier/models/list_delete_params.rbi @@ -11,15 +11,23 @@ module Courier T.any(Courier::ListDeleteParams, Courier::Internal::AnyHash) end + sig { returns(String) } + attr_accessor :list_id + sig do - params(request_options: Courier::RequestOptions::OrHash).returns( - T.attached_class - ) + params( + list_id: String, + request_options: Courier::RequestOptions::OrHash + ).returns(T.attached_class) end - def self.new(request_options: {}) + def self.new(list_id:, request_options: {}) end - sig { override.returns({ request_options: Courier::RequestOptions }) } + sig do + override.returns( + { list_id: String, request_options: Courier::RequestOptions } + ) + end def to_hash end end diff --git a/rbi/courier/models/list_restore_params.rbi b/rbi/courier/models/list_restore_params.rbi index d0f8c2a9..3c3a3e5b 100644 --- a/rbi/courier/models/list_restore_params.rbi +++ b/rbi/courier/models/list_restore_params.rbi @@ -11,15 +11,23 @@ module Courier T.any(Courier::ListRestoreParams, Courier::Internal::AnyHash) end + sig { returns(String) } + attr_accessor :list_id + sig do - params(request_options: Courier::RequestOptions::OrHash).returns( - T.attached_class - ) + params( + list_id: String, + request_options: Courier::RequestOptions::OrHash + ).returns(T.attached_class) end - def self.new(request_options: {}) + def self.new(list_id:, request_options: {}) end - sig { override.returns({ request_options: Courier::RequestOptions }) } + sig do + override.returns( + { list_id: String, request_options: Courier::RequestOptions } + ) + end def to_hash end end diff --git a/rbi/courier/models/list_retrieve_params.rbi b/rbi/courier/models/list_retrieve_params.rbi index 44235112..91012ced 100644 --- a/rbi/courier/models/list_retrieve_params.rbi +++ b/rbi/courier/models/list_retrieve_params.rbi @@ -11,15 +11,23 @@ module Courier T.any(Courier::ListRetrieveParams, Courier::Internal::AnyHash) end + sig { returns(String) } + attr_accessor :list_id + sig do - params(request_options: Courier::RequestOptions::OrHash).returns( - T.attached_class - ) + params( + list_id: String, + request_options: Courier::RequestOptions::OrHash + ).returns(T.attached_class) end - def self.new(request_options: {}) + def self.new(list_id:, request_options: {}) end - sig { override.returns({ request_options: Courier::RequestOptions }) } + sig do + override.returns( + { list_id: String, request_options: Courier::RequestOptions } + ) + end def to_hash end end diff --git a/rbi/courier/models/list_update_params.rbi b/rbi/courier/models/list_update_params.rbi index 72530943..002f2e15 100644 --- a/rbi/courier/models/list_update_params.rbi +++ b/rbi/courier/models/list_update_params.rbi @@ -11,6 +11,9 @@ module Courier T.any(Courier::ListUpdateParams, Courier::Internal::AnyHash) end + sig { returns(String) } + attr_accessor :list_id + sig { returns(String) } attr_accessor :name @@ -26,17 +29,19 @@ module Courier sig do params( + list_id: String, name: String, preferences: T.nilable(Courier::RecipientPreferences::OrHash), request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new(name:, preferences: nil, request_options: {}) + def self.new(list_id:, name:, preferences: nil, request_options: {}) end sig do override.returns( { + list_id: String, name: String, preferences: T.nilable(Courier::RecipientPreferences), request_options: Courier::RequestOptions diff --git a/rbi/courier/models/lists/subscription_add_params.rbi b/rbi/courier/models/lists/subscription_add_params.rbi index 59a01a36..8ff07204 100644 --- a/rbi/courier/models/lists/subscription_add_params.rbi +++ b/rbi/courier/models/lists/subscription_add_params.rbi @@ -15,21 +15,26 @@ module Courier ) end + sig { returns(String) } + attr_accessor :list_id + sig { returns(T::Array[Courier::PutSubscriptionsRecipient]) } attr_accessor :recipients sig do params( + list_id: String, recipients: T::Array[Courier::PutSubscriptionsRecipient::OrHash], request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new(recipients:, request_options: {}) + def self.new(list_id:, recipients:, request_options: {}) end sig do override.returns( { + list_id: String, recipients: T::Array[Courier::PutSubscriptionsRecipient], request_options: Courier::RequestOptions } diff --git a/rbi/courier/models/lists/subscription_list_params.rbi b/rbi/courier/models/lists/subscription_list_params.rbi index 99df8304..75af90f7 100644 --- a/rbi/courier/models/lists/subscription_list_params.rbi +++ b/rbi/courier/models/lists/subscription_list_params.rbi @@ -15,17 +15,22 @@ module Courier ) end + sig { returns(String) } + attr_accessor :list_id + # A unique identifier that allows for fetching the next set of list subscriptions sig { returns(T.nilable(String)) } attr_accessor :cursor sig do params( + list_id: String, cursor: T.nilable(String), request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( + list_id:, # A unique identifier that allows for fetching the next set of list subscriptions cursor: nil, request_options: {} @@ -35,6 +40,7 @@ module Courier sig do override.returns( { + list_id: String, cursor: T.nilable(String), request_options: Courier::RequestOptions } diff --git a/rbi/courier/models/lists/subscription_subscribe_params.rbi b/rbi/courier/models/lists/subscription_subscribe_params.rbi index 6958c8bd..346408b4 100644 --- a/rbi/courier/models/lists/subscription_subscribe_params.rbi +++ b/rbi/courier/models/lists/subscription_subscribe_params.rbi @@ -15,21 +15,26 @@ module Courier ) end + sig { returns(String) } + attr_accessor :list_id + sig { returns(T::Array[Courier::PutSubscriptionsRecipient]) } attr_accessor :recipients sig do params( + list_id: String, recipients: T::Array[Courier::PutSubscriptionsRecipient::OrHash], request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new(recipients:, request_options: {}) + def self.new(list_id:, recipients:, request_options: {}) end sig do override.returns( { + list_id: String, recipients: T::Array[Courier::PutSubscriptionsRecipient], request_options: Courier::RequestOptions } diff --git a/rbi/courier/models/lists/subscription_subscribe_user_params.rbi b/rbi/courier/models/lists/subscription_subscribe_user_params.rbi index 646960ea..f08d80f7 100644 --- a/rbi/courier/models/lists/subscription_subscribe_user_params.rbi +++ b/rbi/courier/models/lists/subscription_subscribe_user_params.rbi @@ -18,6 +18,9 @@ module Courier sig { returns(String) } attr_accessor :list_id + sig { returns(String) } + attr_accessor :user_id + sig { returns(T.nilable(Courier::RecipientPreferences)) } attr_reader :preferences @@ -31,17 +34,19 @@ module Courier sig do params( list_id: String, + user_id: String, preferences: T.nilable(Courier::RecipientPreferences::OrHash), request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new(list_id:, preferences: nil, request_options: {}) + def self.new(list_id:, user_id:, preferences: nil, request_options: {}) end sig do override.returns( { list_id: String, + user_id: String, preferences: T.nilable(Courier::RecipientPreferences), request_options: Courier::RequestOptions } diff --git a/rbi/courier/models/lists/subscription_unsubscribe_user_params.rbi b/rbi/courier/models/lists/subscription_unsubscribe_user_params.rbi index d2fb7bd1..a40ae08d 100644 --- a/rbi/courier/models/lists/subscription_unsubscribe_user_params.rbi +++ b/rbi/courier/models/lists/subscription_unsubscribe_user_params.rbi @@ -18,18 +18,26 @@ module Courier sig { returns(String) } attr_accessor :list_id + sig { returns(String) } + attr_accessor :user_id + sig do params( list_id: String, + user_id: String, request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new(list_id:, request_options: {}) + def self.new(list_id:, user_id:, request_options: {}) end sig do override.returns( - { list_id: String, request_options: Courier::RequestOptions } + { + list_id: String, + user_id: String, + request_options: Courier::RequestOptions + } ) end def to_hash diff --git a/rbi/courier/models/message_cancel_params.rbi b/rbi/courier/models/message_cancel_params.rbi index ab764b74..cec93dcc 100644 --- a/rbi/courier/models/message_cancel_params.rbi +++ b/rbi/courier/models/message_cancel_params.rbi @@ -11,15 +11,23 @@ module Courier T.any(Courier::MessageCancelParams, Courier::Internal::AnyHash) end + sig { returns(String) } + attr_accessor :message_id + sig do - params(request_options: Courier::RequestOptions::OrHash).returns( - T.attached_class - ) + params( + message_id: String, + request_options: Courier::RequestOptions::OrHash + ).returns(T.attached_class) end - def self.new(request_options: {}) + def self.new(message_id:, request_options: {}) end - sig { override.returns({ request_options: Courier::RequestOptions }) } + sig do + override.returns( + { message_id: String, request_options: Courier::RequestOptions } + ) + end def to_hash end end diff --git a/rbi/courier/models/message_content_params.rbi b/rbi/courier/models/message_content_params.rbi index af50ea07..dfb773f5 100644 --- a/rbi/courier/models/message_content_params.rbi +++ b/rbi/courier/models/message_content_params.rbi @@ -11,15 +11,23 @@ module Courier T.any(Courier::MessageContentParams, Courier::Internal::AnyHash) end + sig { returns(String) } + attr_accessor :message_id + sig do - params(request_options: Courier::RequestOptions::OrHash).returns( - T.attached_class - ) + params( + message_id: String, + request_options: Courier::RequestOptions::OrHash + ).returns(T.attached_class) end - def self.new(request_options: {}) + def self.new(message_id:, request_options: {}) end - sig { override.returns({ request_options: Courier::RequestOptions }) } + sig do + override.returns( + { message_id: String, request_options: Courier::RequestOptions } + ) + end def to_hash end end diff --git a/rbi/courier/models/message_history_params.rbi b/rbi/courier/models/message_history_params.rbi index c0636d47..c7a70053 100644 --- a/rbi/courier/models/message_history_params.rbi +++ b/rbi/courier/models/message_history_params.rbi @@ -11,17 +11,22 @@ module Courier T.any(Courier::MessageHistoryParams, Courier::Internal::AnyHash) end + sig { returns(String) } + attr_accessor :message_id + # A supported Message History type that will filter the events returned. sig { returns(T.nilable(String)) } attr_accessor :type sig do params( + message_id: String, type: T.nilable(String), request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( + message_id:, # A supported Message History type that will filter the events returned. type: nil, request_options: {} @@ -30,7 +35,11 @@ module Courier sig do override.returns( - { type: T.nilable(String), request_options: Courier::RequestOptions } + { + message_id: String, + type: T.nilable(String), + request_options: Courier::RequestOptions + } ) end def to_hash diff --git a/rbi/courier/models/message_retrieve_params.rbi b/rbi/courier/models/message_retrieve_params.rbi index c83946a4..52a5b894 100644 --- a/rbi/courier/models/message_retrieve_params.rbi +++ b/rbi/courier/models/message_retrieve_params.rbi @@ -11,15 +11,23 @@ module Courier T.any(Courier::MessageRetrieveParams, Courier::Internal::AnyHash) end + sig { returns(String) } + attr_accessor :message_id + sig do - params(request_options: Courier::RequestOptions::OrHash).returns( - T.attached_class - ) + params( + message_id: String, + request_options: Courier::RequestOptions::OrHash + ).returns(T.attached_class) end - def self.new(request_options: {}) + def self.new(message_id:, request_options: {}) end - sig { override.returns({ request_options: Courier::RequestOptions }) } + sig do + override.returns( + { message_id: String, request_options: Courier::RequestOptions } + ) + end def to_hash end end diff --git a/rbi/courier/models/notification_retrieve_content_params.rbi b/rbi/courier/models/notification_retrieve_content_params.rbi index 6753caa0..fbd20059 100644 --- a/rbi/courier/models/notification_retrieve_content_params.rbi +++ b/rbi/courier/models/notification_retrieve_content_params.rbi @@ -14,15 +14,23 @@ module Courier ) end + sig { returns(String) } + attr_accessor :id + sig do - params(request_options: Courier::RequestOptions::OrHash).returns( - T.attached_class - ) + params( + id: String, + request_options: Courier::RequestOptions::OrHash + ).returns(T.attached_class) end - def self.new(request_options: {}) + def self.new(id:, request_options: {}) end - sig { override.returns({ request_options: Courier::RequestOptions }) } + sig do + override.returns( + { id: String, request_options: Courier::RequestOptions } + ) + end def to_hash end end diff --git a/rbi/courier/models/notifications/check_delete_params.rbi b/rbi/courier/models/notifications/check_delete_params.rbi index c3ec5078..78a1ccb8 100644 --- a/rbi/courier/models/notifications/check_delete_params.rbi +++ b/rbi/courier/models/notifications/check_delete_params.rbi @@ -18,18 +18,26 @@ module Courier sig { returns(String) } attr_accessor :id + sig { returns(String) } + attr_accessor :submission_id + sig do params( id: String, + submission_id: String, request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new(id:, request_options: {}) + def self.new(id:, submission_id:, request_options: {}) end sig do override.returns( - { id: String, request_options: Courier::RequestOptions } + { + id: String, + submission_id: String, + request_options: Courier::RequestOptions + } ) end def to_hash diff --git a/rbi/courier/models/notifications/check_list_params.rbi b/rbi/courier/models/notifications/check_list_params.rbi index 906099d5..50ca3b50 100644 --- a/rbi/courier/models/notifications/check_list_params.rbi +++ b/rbi/courier/models/notifications/check_list_params.rbi @@ -18,18 +18,26 @@ module Courier sig { returns(String) } attr_accessor :id + sig { returns(String) } + attr_accessor :submission_id + sig do params( id: String, + submission_id: String, request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new(id:, request_options: {}) + def self.new(id:, submission_id:, request_options: {}) end sig do override.returns( - { id: String, request_options: Courier::RequestOptions } + { + id: String, + submission_id: String, + request_options: Courier::RequestOptions + } ) end def to_hash diff --git a/rbi/courier/models/notifications/check_update_params.rbi b/rbi/courier/models/notifications/check_update_params.rbi index 7adc3f2c..f7ab5c7a 100644 --- a/rbi/courier/models/notifications/check_update_params.rbi +++ b/rbi/courier/models/notifications/check_update_params.rbi @@ -18,23 +18,28 @@ module Courier sig { returns(String) } attr_accessor :id + sig { returns(String) } + attr_accessor :submission_id + sig { returns(T::Array[Courier::BaseCheck]) } attr_accessor :checks sig do params( id: String, + submission_id: String, checks: T::Array[Courier::BaseCheck::OrHash], request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new(id:, checks:, request_options: {}) + def self.new(id:, submission_id:, checks:, request_options: {}) end sig do override.returns( { id: String, + submission_id: String, checks: T::Array[Courier::BaseCheck], request_options: Courier::RequestOptions } diff --git a/rbi/courier/models/notifications/draft_retrieve_content_params.rbi b/rbi/courier/models/notifications/draft_retrieve_content_params.rbi index 377aead1..ac8bb580 100644 --- a/rbi/courier/models/notifications/draft_retrieve_content_params.rbi +++ b/rbi/courier/models/notifications/draft_retrieve_content_params.rbi @@ -15,15 +15,23 @@ module Courier ) end + sig { returns(String) } + attr_accessor :id + sig do - params(request_options: Courier::RequestOptions::OrHash).returns( - T.attached_class - ) + params( + id: String, + request_options: Courier::RequestOptions::OrHash + ).returns(T.attached_class) end - def self.new(request_options: {}) + def self.new(id:, request_options: {}) end - sig { override.returns({ request_options: Courier::RequestOptions }) } + sig do + override.returns( + { id: String, request_options: Courier::RequestOptions } + ) + end def to_hash end end diff --git a/rbi/courier/models/profile_create_params.rbi b/rbi/courier/models/profile_create_params.rbi index b1292ab9..13109a7e 100644 --- a/rbi/courier/models/profile_create_params.rbi +++ b/rbi/courier/models/profile_create_params.rbi @@ -11,21 +11,26 @@ module Courier T.any(Courier::ProfileCreateParams, Courier::Internal::AnyHash) end + sig { returns(String) } + attr_accessor :user_id + sig { returns(T::Hash[Symbol, T.anything]) } attr_accessor :profile sig do params( + user_id: String, profile: T::Hash[Symbol, T.anything], request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new(profile:, request_options: {}) + def self.new(user_id:, profile:, request_options: {}) end sig do override.returns( { + user_id: String, profile: T::Hash[Symbol, T.anything], request_options: Courier::RequestOptions } diff --git a/rbi/courier/models/profile_delete_params.rbi b/rbi/courier/models/profile_delete_params.rbi index af8908ba..e32b4cb8 100644 --- a/rbi/courier/models/profile_delete_params.rbi +++ b/rbi/courier/models/profile_delete_params.rbi @@ -11,15 +11,23 @@ module Courier T.any(Courier::ProfileDeleteParams, Courier::Internal::AnyHash) end + sig { returns(String) } + attr_accessor :user_id + sig do - params(request_options: Courier::RequestOptions::OrHash).returns( - T.attached_class - ) + params( + user_id: String, + request_options: Courier::RequestOptions::OrHash + ).returns(T.attached_class) end - def self.new(request_options: {}) + def self.new(user_id:, request_options: {}) end - sig { override.returns({ request_options: Courier::RequestOptions }) } + sig do + override.returns( + { user_id: String, request_options: Courier::RequestOptions } + ) + end def to_hash end end diff --git a/rbi/courier/models/profile_replace_params.rbi b/rbi/courier/models/profile_replace_params.rbi index 254a5826..b6d98055 100644 --- a/rbi/courier/models/profile_replace_params.rbi +++ b/rbi/courier/models/profile_replace_params.rbi @@ -11,21 +11,26 @@ module Courier T.any(Courier::ProfileReplaceParams, Courier::Internal::AnyHash) end + sig { returns(String) } + attr_accessor :user_id + sig { returns(T::Hash[Symbol, T.anything]) } attr_accessor :profile sig do params( + user_id: String, profile: T::Hash[Symbol, T.anything], request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new(profile:, request_options: {}) + def self.new(user_id:, profile:, request_options: {}) end sig do override.returns( { + user_id: String, profile: T::Hash[Symbol, T.anything], request_options: Courier::RequestOptions } diff --git a/rbi/courier/models/profile_retrieve_params.rbi b/rbi/courier/models/profile_retrieve_params.rbi index 9ed3fa09..59308647 100644 --- a/rbi/courier/models/profile_retrieve_params.rbi +++ b/rbi/courier/models/profile_retrieve_params.rbi @@ -11,15 +11,23 @@ module Courier T.any(Courier::ProfileRetrieveParams, Courier::Internal::AnyHash) end + sig { returns(String) } + attr_accessor :user_id + sig do - params(request_options: Courier::RequestOptions::OrHash).returns( - T.attached_class - ) + params( + user_id: String, + request_options: Courier::RequestOptions::OrHash + ).returns(T.attached_class) end - def self.new(request_options: {}) + def self.new(user_id:, request_options: {}) end - sig { override.returns({ request_options: Courier::RequestOptions }) } + sig do + override.returns( + { user_id: String, request_options: Courier::RequestOptions } + ) + end def to_hash end end diff --git a/rbi/courier/models/profile_update_params.rbi b/rbi/courier/models/profile_update_params.rbi index d65dfed0..b23a838e 100644 --- a/rbi/courier/models/profile_update_params.rbi +++ b/rbi/courier/models/profile_update_params.rbi @@ -11,17 +11,22 @@ module Courier T.any(Courier::ProfileUpdateParams, Courier::Internal::AnyHash) end + sig { returns(String) } + attr_accessor :user_id + # List of patch operations to apply to the profile. sig { returns(T::Array[Courier::ProfileUpdateParams::Patch]) } attr_accessor :patch sig do params( + user_id: String, patch: T::Array[Courier::ProfileUpdateParams::Patch::OrHash], request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( + user_id:, # List of patch operations to apply to the profile. patch:, request_options: {} @@ -31,6 +36,7 @@ module Courier sig do override.returns( { + user_id: String, patch: T::Array[Courier::ProfileUpdateParams::Patch], request_options: Courier::RequestOptions } diff --git a/rbi/courier/models/profiles/list_delete_params.rbi b/rbi/courier/models/profiles/list_delete_params.rbi index bb281c55..63e9cd5e 100644 --- a/rbi/courier/models/profiles/list_delete_params.rbi +++ b/rbi/courier/models/profiles/list_delete_params.rbi @@ -15,15 +15,23 @@ module Courier ) end + sig { returns(String) } + attr_accessor :user_id + sig do - params(request_options: Courier::RequestOptions::OrHash).returns( - T.attached_class - ) + params( + user_id: String, + request_options: Courier::RequestOptions::OrHash + ).returns(T.attached_class) end - def self.new(request_options: {}) + def self.new(user_id:, request_options: {}) end - sig { override.returns({ request_options: Courier::RequestOptions }) } + sig do + override.returns( + { user_id: String, request_options: Courier::RequestOptions } + ) + end def to_hash end end diff --git a/rbi/courier/models/profiles/list_retrieve_params.rbi b/rbi/courier/models/profiles/list_retrieve_params.rbi index d363f493..39d1eca1 100644 --- a/rbi/courier/models/profiles/list_retrieve_params.rbi +++ b/rbi/courier/models/profiles/list_retrieve_params.rbi @@ -15,17 +15,22 @@ module Courier ) end + sig { returns(String) } + attr_accessor :user_id + # A unique identifier that allows for fetching the next set of message statuses. sig { returns(T.nilable(String)) } attr_accessor :cursor sig do params( + user_id: String, cursor: T.nilable(String), request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( + user_id:, # A unique identifier that allows for fetching the next set of message statuses. cursor: nil, request_options: {} @@ -35,6 +40,7 @@ module Courier sig do override.returns( { + user_id: String, cursor: T.nilable(String), request_options: Courier::RequestOptions } diff --git a/rbi/courier/models/profiles/list_subscribe_params.rbi b/rbi/courier/models/profiles/list_subscribe_params.rbi index b38f5cd0..8e19bc08 100644 --- a/rbi/courier/models/profiles/list_subscribe_params.rbi +++ b/rbi/courier/models/profiles/list_subscribe_params.rbi @@ -15,21 +15,26 @@ module Courier ) end + sig { returns(String) } + attr_accessor :user_id + sig { returns(T::Array[Courier::SubscribeToListsRequestItem]) } attr_accessor :lists sig do params( + user_id: String, lists: T::Array[Courier::SubscribeToListsRequestItem::OrHash], request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new(lists:, request_options: {}) + def self.new(user_id:, lists:, request_options: {}) end sig do override.returns( { + user_id: String, lists: T::Array[Courier::SubscribeToListsRequestItem], request_options: Courier::RequestOptions } diff --git a/rbi/courier/models/request_archive_params.rbi b/rbi/courier/models/request_archive_params.rbi index 3bf17973..96c53b3f 100644 --- a/rbi/courier/models/request_archive_params.rbi +++ b/rbi/courier/models/request_archive_params.rbi @@ -11,15 +11,23 @@ module Courier T.any(Courier::RequestArchiveParams, Courier::Internal::AnyHash) end + sig { returns(String) } + attr_accessor :request_id + sig do - params(request_options: Courier::RequestOptions::OrHash).returns( - T.attached_class - ) + params( + request_id: String, + request_options: Courier::RequestOptions::OrHash + ).returns(T.attached_class) end - def self.new(request_options: {}) + def self.new(request_id:, request_options: {}) end - sig { override.returns({ request_options: Courier::RequestOptions }) } + sig do + override.returns( + { request_id: String, request_options: Courier::RequestOptions } + ) + end def to_hash end end diff --git a/rbi/courier/models/tenant_delete_params.rbi b/rbi/courier/models/tenant_delete_params.rbi index 8d76169b..8a259abb 100644 --- a/rbi/courier/models/tenant_delete_params.rbi +++ b/rbi/courier/models/tenant_delete_params.rbi @@ -11,15 +11,23 @@ module Courier T.any(Courier::TenantDeleteParams, Courier::Internal::AnyHash) end + sig { returns(String) } + attr_accessor :tenant_id + sig do - params(request_options: Courier::RequestOptions::OrHash).returns( - T.attached_class - ) + params( + tenant_id: String, + request_options: Courier::RequestOptions::OrHash + ).returns(T.attached_class) end - def self.new(request_options: {}) + def self.new(tenant_id:, request_options: {}) end - sig { override.returns({ request_options: Courier::RequestOptions }) } + sig do + override.returns( + { tenant_id: String, request_options: Courier::RequestOptions } + ) + end def to_hash end end diff --git a/rbi/courier/models/tenant_list_users_params.rbi b/rbi/courier/models/tenant_list_users_params.rbi index 693d3125..2f2e7a85 100644 --- a/rbi/courier/models/tenant_list_users_params.rbi +++ b/rbi/courier/models/tenant_list_users_params.rbi @@ -11,6 +11,9 @@ module Courier T.any(Courier::TenantListUsersParams, Courier::Internal::AnyHash) end + sig { returns(String) } + attr_accessor :tenant_id + # Continue the pagination with the next cursor sig { returns(T.nilable(String)) } attr_accessor :cursor @@ -21,12 +24,14 @@ module Courier sig do params( + tenant_id: String, cursor: T.nilable(String), limit: T.nilable(Integer), request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( + tenant_id:, # Continue the pagination with the next cursor cursor: nil, # The number of accounts to return (defaults to 20, maximum value of 100) @@ -38,6 +43,7 @@ module Courier sig do override.returns( { + tenant_id: String, cursor: T.nilable(String), limit: T.nilable(Integer), request_options: Courier::RequestOptions diff --git a/rbi/courier/models/tenant_retrieve_params.rbi b/rbi/courier/models/tenant_retrieve_params.rbi index d8fc62ab..609ffd2c 100644 --- a/rbi/courier/models/tenant_retrieve_params.rbi +++ b/rbi/courier/models/tenant_retrieve_params.rbi @@ -11,15 +11,23 @@ module Courier T.any(Courier::TenantRetrieveParams, Courier::Internal::AnyHash) end + sig { returns(String) } + attr_accessor :tenant_id + sig do - params(request_options: Courier::RequestOptions::OrHash).returns( - T.attached_class - ) + params( + tenant_id: String, + request_options: Courier::RequestOptions::OrHash + ).returns(T.attached_class) end - def self.new(request_options: {}) + def self.new(tenant_id:, request_options: {}) end - sig { override.returns({ request_options: Courier::RequestOptions }) } + sig do + override.returns( + { tenant_id: String, request_options: Courier::RequestOptions } + ) + end def to_hash end end diff --git a/rbi/courier/models/tenant_update_params.rbi b/rbi/courier/models/tenant_update_params.rbi index da54ccb9..aafc76c9 100644 --- a/rbi/courier/models/tenant_update_params.rbi +++ b/rbi/courier/models/tenant_update_params.rbi @@ -11,6 +11,9 @@ module Courier T.any(Courier::TenantUpdateParams, Courier::Internal::AnyHash) end + sig { returns(String) } + attr_accessor :tenant_id + # Name of the tenant. sig { returns(String) } attr_accessor :name @@ -45,6 +48,7 @@ module Courier sig do params( + tenant_id: String, name: String, brand_id: T.nilable(String), default_preferences: T.nilable(Courier::DefaultPreferences::OrHash), @@ -55,6 +59,7 @@ module Courier ).returns(T.attached_class) end def self.new( + tenant_id:, # Name of the tenant. name:, # Brand to be used for the account when one is not specified by the send call. @@ -75,6 +80,7 @@ module Courier sig do override.returns( { + tenant_id: String, name: String, brand_id: T.nilable(String), default_preferences: T.nilable(Courier::DefaultPreferences), diff --git a/rbi/courier/models/tenants/preferences/item_delete_params.rbi b/rbi/courier/models/tenants/preferences/item_delete_params.rbi index 65653639..ded0e67c 100644 --- a/rbi/courier/models/tenants/preferences/item_delete_params.rbi +++ b/rbi/courier/models/tenants/preferences/item_delete_params.rbi @@ -19,18 +19,26 @@ module Courier sig { returns(String) } attr_accessor :tenant_id + sig { returns(String) } + attr_accessor :topic_id + sig do params( tenant_id: String, + topic_id: String, request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new(tenant_id:, request_options: {}) + def self.new(tenant_id:, topic_id:, request_options: {}) end sig do override.returns( - { tenant_id: String, request_options: Courier::RequestOptions } + { + tenant_id: String, + topic_id: String, + request_options: Courier::RequestOptions + } ) end def to_hash diff --git a/rbi/courier/models/tenants/preferences/item_update_params.rbi b/rbi/courier/models/tenants/preferences/item_update_params.rbi index 360b2007..46ae740e 100644 --- a/rbi/courier/models/tenants/preferences/item_update_params.rbi +++ b/rbi/courier/models/tenants/preferences/item_update_params.rbi @@ -19,18 +19,26 @@ module Courier sig { returns(String) } attr_accessor :tenant_id + sig { returns(String) } + attr_accessor :topic_id + sig do params( tenant_id: String, + topic_id: String, request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new(tenant_id:, request_options: {}) + def self.new(tenant_id:, topic_id:, request_options: {}) end sig do override.returns( - { tenant_id: String, request_options: Courier::RequestOptions } + { + tenant_id: String, + topic_id: String, + request_options: Courier::RequestOptions + } ) end def to_hash diff --git a/rbi/courier/models/tenants/template_list_params.rbi b/rbi/courier/models/tenants/template_list_params.rbi index 5ac78d33..dd5372f6 100644 --- a/rbi/courier/models/tenants/template_list_params.rbi +++ b/rbi/courier/models/tenants/template_list_params.rbi @@ -15,6 +15,9 @@ module Courier ) end + sig { returns(String) } + attr_accessor :tenant_id + # Continue the pagination with the next cursor sig { returns(T.nilable(String)) } attr_accessor :cursor @@ -25,12 +28,14 @@ module Courier sig do params( + tenant_id: String, cursor: T.nilable(String), limit: T.nilable(Integer), request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( + tenant_id:, # Continue the pagination with the next cursor cursor: nil, # The number of templates to return (defaults to 20, maximum value of 100) @@ -42,6 +47,7 @@ module Courier sig do override.returns( { + tenant_id: String, cursor: T.nilable(String), limit: T.nilable(Integer), request_options: Courier::RequestOptions diff --git a/rbi/courier/models/tenants/template_publish_params.rbi b/rbi/courier/models/tenants/template_publish_params.rbi index ce35b83e..d3188da3 100644 --- a/rbi/courier/models/tenants/template_publish_params.rbi +++ b/rbi/courier/models/tenants/template_publish_params.rbi @@ -18,18 +18,26 @@ module Courier sig { returns(String) } attr_accessor :tenant_id + sig { returns(String) } + attr_accessor :template_id + sig do params( tenant_id: String, + template_id: String, request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new(tenant_id:, request_options: {}) + def self.new(tenant_id:, template_id:, request_options: {}) end sig do override.returns( - { tenant_id: String, request_options: Courier::RequestOptions } + { + tenant_id: String, + template_id: String, + request_options: Courier::RequestOptions + } ) end def to_hash diff --git a/rbi/courier/models/tenants/template_replace_params.rbi b/rbi/courier/models/tenants/template_replace_params.rbi index 4b08d2a8..18c77a90 100644 --- a/rbi/courier/models/tenants/template_replace_params.rbi +++ b/rbi/courier/models/tenants/template_replace_params.rbi @@ -18,18 +18,26 @@ module Courier sig { returns(String) } attr_accessor :tenant_id + sig { returns(String) } + attr_accessor :template_id + sig do params( tenant_id: String, + template_id: String, request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new(tenant_id:, request_options: {}) + def self.new(tenant_id:, template_id:, request_options: {}) end sig do override.returns( - { tenant_id: String, request_options: Courier::RequestOptions } + { + tenant_id: String, + template_id: String, + request_options: Courier::RequestOptions + } ) end def to_hash diff --git a/rbi/courier/models/tenants/template_retrieve_params.rbi b/rbi/courier/models/tenants/template_retrieve_params.rbi index 9f42caae..ba75277b 100644 --- a/rbi/courier/models/tenants/template_retrieve_params.rbi +++ b/rbi/courier/models/tenants/template_retrieve_params.rbi @@ -18,18 +18,26 @@ module Courier sig { returns(String) } attr_accessor :tenant_id + sig { returns(String) } + attr_accessor :template_id + sig do params( tenant_id: String, + template_id: String, request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new(tenant_id:, request_options: {}) + def self.new(tenant_id:, template_id:, request_options: {}) end sig do override.returns( - { tenant_id: String, request_options: Courier::RequestOptions } + { + tenant_id: String, + template_id: String, + request_options: Courier::RequestOptions + } ) end def to_hash diff --git a/rbi/courier/models/tenants/templates/version_retrieve_params.rbi b/rbi/courier/models/tenants/templates/version_retrieve_params.rbi index 5118be80..b62e4bd1 100644 --- a/rbi/courier/models/tenants/templates/version_retrieve_params.rbi +++ b/rbi/courier/models/tenants/templates/version_retrieve_params.rbi @@ -22,14 +22,18 @@ module Courier sig { returns(String) } attr_accessor :template_id + sig { returns(String) } + attr_accessor :version + sig do params( tenant_id: String, template_id: String, + version: String, request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new(tenant_id:, template_id:, request_options: {}) + def self.new(tenant_id:, template_id:, version:, request_options: {}) end sig do @@ -37,6 +41,7 @@ module Courier { tenant_id: String, template_id: String, + version: String, request_options: Courier::RequestOptions } ) diff --git a/rbi/courier/models/translation_retrieve_params.rbi b/rbi/courier/models/translation_retrieve_params.rbi index 045e452c..8fa6177e 100644 --- a/rbi/courier/models/translation_retrieve_params.rbi +++ b/rbi/courier/models/translation_retrieve_params.rbi @@ -14,18 +14,26 @@ module Courier sig { returns(String) } attr_accessor :domain + sig { returns(String) } + attr_accessor :locale + sig do params( domain: String, + locale: String, request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new(domain:, request_options: {}) + def self.new(domain:, locale:, request_options: {}) end sig do override.returns( - { domain: String, request_options: Courier::RequestOptions } + { + domain: String, + locale: String, + request_options: Courier::RequestOptions + } ) end def to_hash diff --git a/rbi/courier/models/translation_update_params.rbi b/rbi/courier/models/translation_update_params.rbi index e4f5489e..3ef29091 100644 --- a/rbi/courier/models/translation_update_params.rbi +++ b/rbi/courier/models/translation_update_params.rbi @@ -14,23 +14,28 @@ module Courier sig { returns(String) } attr_accessor :domain + sig { returns(String) } + attr_accessor :locale + sig { returns(String) } attr_accessor :body sig do params( domain: String, + locale: String, body: String, request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new(domain:, body:, request_options: {}) + def self.new(domain:, locale:, body:, request_options: {}) end sig do override.returns( { domain: String, + locale: String, body: String, request_options: Courier::RequestOptions } diff --git a/rbi/courier/models/users/preference_retrieve_params.rbi b/rbi/courier/models/users/preference_retrieve_params.rbi index e9463e70..f5f9370b 100644 --- a/rbi/courier/models/users/preference_retrieve_params.rbi +++ b/rbi/courier/models/users/preference_retrieve_params.rbi @@ -15,17 +15,22 @@ module Courier ) end + sig { returns(String) } + attr_accessor :user_id + # Query the preferences of a user for this specific tenant context. sig { returns(T.nilable(String)) } attr_accessor :tenant_id sig do params( + user_id: String, tenant_id: T.nilable(String), request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( + user_id:, # Query the preferences of a user for this specific tenant context. tenant_id: nil, request_options: {} @@ -35,6 +40,7 @@ module Courier sig do override.returns( { + user_id: String, tenant_id: T.nilable(String), request_options: Courier::RequestOptions } diff --git a/rbi/courier/models/users/preference_retrieve_topic_params.rbi b/rbi/courier/models/users/preference_retrieve_topic_params.rbi index 3bda19ff..ccd577cb 100644 --- a/rbi/courier/models/users/preference_retrieve_topic_params.rbi +++ b/rbi/courier/models/users/preference_retrieve_topic_params.rbi @@ -18,6 +18,9 @@ module Courier sig { returns(String) } attr_accessor :user_id + sig { returns(String) } + attr_accessor :topic_id + # Query the preferences of a user for this specific tenant context. sig { returns(T.nilable(String)) } attr_accessor :tenant_id @@ -25,12 +28,14 @@ module Courier sig do params( user_id: String, + topic_id: String, tenant_id: T.nilable(String), request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( user_id:, + topic_id:, # Query the preferences of a user for this specific tenant context. tenant_id: nil, request_options: {} @@ -41,6 +46,7 @@ module Courier override.returns( { user_id: String, + topic_id: String, tenant_id: T.nilable(String), request_options: Courier::RequestOptions } diff --git a/rbi/courier/models/users/preference_update_or_create_topic_params.rbi b/rbi/courier/models/users/preference_update_or_create_topic_params.rbi index 6b1ef8ed..7f7e3c51 100644 --- a/rbi/courier/models/users/preference_update_or_create_topic_params.rbi +++ b/rbi/courier/models/users/preference_update_or_create_topic_params.rbi @@ -18,6 +18,9 @@ module Courier sig { returns(String) } attr_accessor :user_id + sig { returns(String) } + attr_accessor :topic_id + sig do returns(Courier::Users::PreferenceUpdateOrCreateTopicParams::Topic) end @@ -38,6 +41,7 @@ module Courier sig do params( user_id: String, + topic_id: String, topic: Courier::Users::PreferenceUpdateOrCreateTopicParams::Topic::OrHash, tenant_id: T.nilable(String), @@ -46,6 +50,7 @@ module Courier end def self.new( user_id:, + topic_id:, topic:, # Update the preferences of a user for this specific tenant context. tenant_id: nil, @@ -57,6 +62,7 @@ module Courier override.returns( { user_id: String, + topic_id: String, topic: Courier::Users::PreferenceUpdateOrCreateTopicParams::Topic, tenant_id: T.nilable(String), request_options: Courier::RequestOptions diff --git a/rbi/courier/models/users/tenant_add_multiple_params.rbi b/rbi/courier/models/users/tenant_add_multiple_params.rbi index cdfef2c5..5c040feb 100644 --- a/rbi/courier/models/users/tenant_add_multiple_params.rbi +++ b/rbi/courier/models/users/tenant_add_multiple_params.rbi @@ -15,21 +15,26 @@ module Courier ) end + sig { returns(String) } + attr_accessor :user_id + sig { returns(T::Array[Courier::TenantAssociation]) } attr_accessor :tenants sig do params( + user_id: String, tenants: T::Array[Courier::TenantAssociation::OrHash], request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new(tenants:, request_options: {}) + def self.new(user_id:, tenants:, request_options: {}) end sig do override.returns( { + user_id: String, tenants: T::Array[Courier::TenantAssociation], request_options: Courier::RequestOptions } diff --git a/rbi/courier/models/users/tenant_add_single_params.rbi b/rbi/courier/models/users/tenant_add_single_params.rbi index 141cc9d4..0841e630 100644 --- a/rbi/courier/models/users/tenant_add_single_params.rbi +++ b/rbi/courier/models/users/tenant_add_single_params.rbi @@ -18,23 +18,28 @@ module Courier sig { returns(String) } attr_accessor :user_id + sig { returns(String) } + attr_accessor :tenant_id + sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } attr_accessor :profile sig do params( user_id: String, + tenant_id: String, profile: T.nilable(T::Hash[Symbol, T.anything]), request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new(user_id:, profile: nil, request_options: {}) + def self.new(user_id:, tenant_id:, profile: nil, request_options: {}) end sig do override.returns( { user_id: String, + tenant_id: String, profile: T.nilable(T::Hash[Symbol, T.anything]), request_options: Courier::RequestOptions } diff --git a/rbi/courier/models/users/tenant_list_params.rbi b/rbi/courier/models/users/tenant_list_params.rbi index 25b25018..bdc66669 100644 --- a/rbi/courier/models/users/tenant_list_params.rbi +++ b/rbi/courier/models/users/tenant_list_params.rbi @@ -12,6 +12,9 @@ module Courier T.any(Courier::Users::TenantListParams, Courier::Internal::AnyHash) end + sig { returns(String) } + attr_accessor :user_id + # Continue the pagination with the next cursor sig { returns(T.nilable(String)) } attr_accessor :cursor @@ -22,12 +25,14 @@ module Courier sig do params( + user_id: String, cursor: T.nilable(String), limit: T.nilable(Integer), request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( + user_id:, # Continue the pagination with the next cursor cursor: nil, # The number of accounts to return (defaults to 20, maximum value of 100) @@ -39,6 +44,7 @@ module Courier sig do override.returns( { + user_id: String, cursor: T.nilable(String), limit: T.nilable(Integer), request_options: Courier::RequestOptions diff --git a/rbi/courier/models/users/tenant_remove_all_params.rbi b/rbi/courier/models/users/tenant_remove_all_params.rbi index 3cae78d9..41b38f6b 100644 --- a/rbi/courier/models/users/tenant_remove_all_params.rbi +++ b/rbi/courier/models/users/tenant_remove_all_params.rbi @@ -15,15 +15,23 @@ module Courier ) end + sig { returns(String) } + attr_accessor :user_id + sig do - params(request_options: Courier::RequestOptions::OrHash).returns( - T.attached_class - ) + params( + user_id: String, + request_options: Courier::RequestOptions::OrHash + ).returns(T.attached_class) end - def self.new(request_options: {}) + def self.new(user_id:, request_options: {}) end - sig { override.returns({ request_options: Courier::RequestOptions }) } + sig do + override.returns( + { user_id: String, request_options: Courier::RequestOptions } + ) + end def to_hash end end diff --git a/rbi/courier/models/users/tenant_remove_single_params.rbi b/rbi/courier/models/users/tenant_remove_single_params.rbi index b5b8f2c0..f30ddbb2 100644 --- a/rbi/courier/models/users/tenant_remove_single_params.rbi +++ b/rbi/courier/models/users/tenant_remove_single_params.rbi @@ -18,18 +18,26 @@ module Courier sig { returns(String) } attr_accessor :user_id + sig { returns(String) } + attr_accessor :tenant_id + sig do params( user_id: String, + tenant_id: String, request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new(user_id:, request_options: {}) + def self.new(user_id:, tenant_id:, request_options: {}) end sig do override.returns( - { user_id: String, request_options: Courier::RequestOptions } + { + user_id: String, + tenant_id: String, + request_options: Courier::RequestOptions + } ) end def to_hash diff --git a/rbi/courier/models/users/token_add_multiple_params.rbi b/rbi/courier/models/users/token_add_multiple_params.rbi index be6c83b6..b50e75c2 100644 --- a/rbi/courier/models/users/token_add_multiple_params.rbi +++ b/rbi/courier/models/users/token_add_multiple_params.rbi @@ -15,15 +15,23 @@ module Courier ) end + sig { returns(String) } + attr_accessor :user_id + sig do - params(request_options: Courier::RequestOptions::OrHash).returns( - T.attached_class - ) + params( + user_id: String, + request_options: Courier::RequestOptions::OrHash + ).returns(T.attached_class) end - def self.new(request_options: {}) + def self.new(user_id:, request_options: {}) end - sig { override.returns({ request_options: Courier::RequestOptions }) } + sig do + override.returns( + { user_id: String, request_options: Courier::RequestOptions } + ) + end def to_hash end end diff --git a/rbi/courier/models/users/token_add_single_params.rbi b/rbi/courier/models/users/token_add_single_params.rbi index b726a86a..51f3e70d 100644 --- a/rbi/courier/models/users/token_add_single_params.rbi +++ b/rbi/courier/models/users/token_add_single_params.rbi @@ -18,6 +18,9 @@ module Courier sig { returns(String) } attr_accessor :user_id + sig { returns(String) } + attr_accessor :token + sig do returns(Courier::Users::TokenAddSingleParams::ProviderKey::OrSymbol) end @@ -70,6 +73,7 @@ module Courier sig do params( user_id: String, + token: String, provider_key: Courier::Users::TokenAddSingleParams::ProviderKey::OrSymbol, device: @@ -86,6 +90,7 @@ module Courier end def self.new( user_id:, + token:, provider_key:, # Information about the device the token came from. device: nil, @@ -104,6 +109,7 @@ module Courier override.returns( { user_id: String, + token: String, provider_key: Courier::Users::TokenAddSingleParams::ProviderKey::OrSymbol, device: T.nilable(Courier::Users::TokenAddSingleParams::Device), diff --git a/rbi/courier/models/users/token_delete_params.rbi b/rbi/courier/models/users/token_delete_params.rbi index 566ea1b8..befaaee8 100644 --- a/rbi/courier/models/users/token_delete_params.rbi +++ b/rbi/courier/models/users/token_delete_params.rbi @@ -15,18 +15,26 @@ module Courier sig { returns(String) } attr_accessor :user_id + sig { returns(String) } + attr_accessor :token + sig do params( user_id: String, + token: String, request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new(user_id:, request_options: {}) + def self.new(user_id:, token:, request_options: {}) end sig do override.returns( - { user_id: String, request_options: Courier::RequestOptions } + { + user_id: String, + token: String, + request_options: Courier::RequestOptions + } ) end def to_hash diff --git a/rbi/courier/models/users/token_list_params.rbi b/rbi/courier/models/users/token_list_params.rbi index de833b99..f6f45fc9 100644 --- a/rbi/courier/models/users/token_list_params.rbi +++ b/rbi/courier/models/users/token_list_params.rbi @@ -12,15 +12,23 @@ module Courier T.any(Courier::Users::TokenListParams, Courier::Internal::AnyHash) end + sig { returns(String) } + attr_accessor :user_id + sig do - params(request_options: Courier::RequestOptions::OrHash).returns( - T.attached_class - ) + params( + user_id: String, + request_options: Courier::RequestOptions::OrHash + ).returns(T.attached_class) end - def self.new(request_options: {}) + def self.new(user_id:, request_options: {}) end - sig { override.returns({ request_options: Courier::RequestOptions }) } + sig do + override.returns( + { user_id: String, request_options: Courier::RequestOptions } + ) + end def to_hash end end diff --git a/rbi/courier/models/users/token_retrieve_params.rbi b/rbi/courier/models/users/token_retrieve_params.rbi index d9deb215..71971e10 100644 --- a/rbi/courier/models/users/token_retrieve_params.rbi +++ b/rbi/courier/models/users/token_retrieve_params.rbi @@ -18,18 +18,26 @@ module Courier sig { returns(String) } attr_accessor :user_id + sig { returns(String) } + attr_accessor :token + sig do params( user_id: String, + token: String, request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new(user_id:, request_options: {}) + def self.new(user_id:, token:, request_options: {}) end sig do override.returns( - { user_id: String, request_options: Courier::RequestOptions } + { + user_id: String, + token: String, + request_options: Courier::RequestOptions + } ) end def to_hash diff --git a/rbi/courier/models/users/token_update_params.rbi b/rbi/courier/models/users/token_update_params.rbi index 984dbb64..0a3f11e1 100644 --- a/rbi/courier/models/users/token_update_params.rbi +++ b/rbi/courier/models/users/token_update_params.rbi @@ -15,23 +15,28 @@ module Courier sig { returns(String) } attr_accessor :user_id + sig { returns(String) } + attr_accessor :token + sig { returns(T::Array[Courier::Users::TokenUpdateParams::Patch]) } attr_accessor :patch sig do params( user_id: String, + token: String, patch: T::Array[Courier::Users::TokenUpdateParams::Patch::OrHash], request_options: Courier::RequestOptions::OrHash ).returns(T.attached_class) end - def self.new(user_id:, patch:, request_options: {}) + def self.new(user_id:, token:, patch:, request_options: {}) end sig do override.returns( { user_id: String, + token: String, patch: T::Array[Courier::Users::TokenUpdateParams::Patch], request_options: Courier::RequestOptions } diff --git a/sig/courier/models/audience_delete_params.rbs b/sig/courier/models/audience_delete_params.rbs index 445081fc..e11d4318 100644 --- a/sig/courier/models/audience_delete_params.rbs +++ b/sig/courier/models/audience_delete_params.rbs @@ -1,15 +1,23 @@ module Courier module Models type audience_delete_params = - { } & Courier::Internal::Type::request_parameters + { audience_id: String } & Courier::Internal::Type::request_parameters class AudienceDeleteParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - def initialize: (?request_options: Courier::request_opts) -> void + attr_accessor audience_id: String - def to_hash: -> { request_options: Courier::RequestOptions } + def initialize: ( + audience_id: String, + ?request_options: Courier::request_opts + ) -> void + + def to_hash: -> { + audience_id: String, + request_options: Courier::RequestOptions + } end end end diff --git a/sig/courier/models/audience_list_members_params.rbs b/sig/courier/models/audience_list_members_params.rbs index 67cb17bf..f9df83ae 100644 --- a/sig/courier/models/audience_list_members_params.rbs +++ b/sig/courier/models/audience_list_members_params.rbs @@ -1,20 +1,25 @@ module Courier module Models type audience_list_members_params = - { cursor: String? } & Courier::Internal::Type::request_parameters + { audience_id: String, cursor: String? } + & Courier::Internal::Type::request_parameters class AudienceListMembersParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + attr_accessor audience_id: String + attr_accessor cursor: String? def initialize: ( + audience_id: String, ?cursor: String?, ?request_options: Courier::request_opts ) -> void def to_hash: -> { + audience_id: String, cursor: String?, request_options: Courier::RequestOptions } diff --git a/sig/courier/models/audience_retrieve_params.rbs b/sig/courier/models/audience_retrieve_params.rbs index 22e0b42f..3e930a26 100644 --- a/sig/courier/models/audience_retrieve_params.rbs +++ b/sig/courier/models/audience_retrieve_params.rbs @@ -1,15 +1,23 @@ module Courier module Models type audience_retrieve_params = - { } & Courier::Internal::Type::request_parameters + { audience_id: String } & Courier::Internal::Type::request_parameters class AudienceRetrieveParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - def initialize: (?request_options: Courier::request_opts) -> void + attr_accessor audience_id: String - def to_hash: -> { request_options: Courier::RequestOptions } + def initialize: ( + audience_id: String, + ?request_options: Courier::request_opts + ) -> void + + def to_hash: -> { + audience_id: String, + request_options: Courier::RequestOptions + } end end end diff --git a/sig/courier/models/audience_update_params.rbs b/sig/courier/models/audience_update_params.rbs index a6f15203..ad0d8496 100644 --- a/sig/courier/models/audience_update_params.rbs +++ b/sig/courier/models/audience_update_params.rbs @@ -2,6 +2,7 @@ module Courier module Models type audience_update_params = { + audience_id: String, description: String?, filter: Courier::AudienceFilterConfig?, name: String?, @@ -13,6 +14,8 @@ module Courier extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + attr_accessor audience_id: String + attr_accessor description: String? attr_accessor filter: Courier::AudienceFilterConfig? @@ -22,6 +25,7 @@ module Courier attr_accessor operator: Courier::Models::AudienceUpdateParams::operator? def initialize: ( + audience_id: String, ?description: String?, ?filter: Courier::AudienceFilterConfig?, ?name: String?, @@ -30,6 +34,7 @@ module Courier ) -> void def to_hash: -> { + audience_id: String, description: String?, filter: Courier::AudienceFilterConfig?, name: String?, diff --git a/sig/courier/models/audit_event_retrieve_params.rbs b/sig/courier/models/audit_event_retrieve_params.rbs index bfe33445..21402caf 100644 --- a/sig/courier/models/audit_event_retrieve_params.rbs +++ b/sig/courier/models/audit_event_retrieve_params.rbs @@ -1,15 +1,23 @@ module Courier module Models type audit_event_retrieve_params = - { } & Courier::Internal::Type::request_parameters + { audit_event_id: String } & Courier::Internal::Type::request_parameters class AuditEventRetrieveParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - def initialize: (?request_options: Courier::request_opts) -> void + attr_accessor audit_event_id: String - def to_hash: -> { request_options: Courier::RequestOptions } + def initialize: ( + audit_event_id: String, + ?request_options: Courier::request_opts + ) -> void + + def to_hash: -> { + audit_event_id: String, + request_options: Courier::RequestOptions + } end end end diff --git a/sig/courier/models/automations/invoke_invoke_by_template_params.rbs b/sig/courier/models/automations/invoke_invoke_by_template_params.rbs index 2b8b21d7..add8ca95 100644 --- a/sig/courier/models/automations/invoke_invoke_by_template_params.rbs +++ b/sig/courier/models/automations/invoke_invoke_by_template_params.rbs @@ -3,6 +3,7 @@ module Courier module Automations type invoke_invoke_by_template_params = { + template_id: String, recipient: String?, brand: String?, data: ::Hash[Symbol, top]?, @@ -15,6 +16,8 @@ module Courier extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + attr_accessor template_id: String + attr_accessor recipient: String? attr_accessor brand: String? @@ -26,6 +29,7 @@ module Courier attr_accessor template: String? def initialize: ( + template_id: String, recipient: String?, ?brand: String?, ?data: ::Hash[Symbol, top]?, @@ -35,6 +39,7 @@ module Courier ) -> void def to_hash: -> { + template_id: String, recipient: String?, brand: String?, data: ::Hash[Symbol, top]?, diff --git a/sig/courier/models/brand_delete_params.rbs b/sig/courier/models/brand_delete_params.rbs index 454e21d8..c866cb5c 100644 --- a/sig/courier/models/brand_delete_params.rbs +++ b/sig/courier/models/brand_delete_params.rbs @@ -1,15 +1,23 @@ module Courier module Models type brand_delete_params = - { } & Courier::Internal::Type::request_parameters + { brand_id: String } & Courier::Internal::Type::request_parameters class BrandDeleteParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - def initialize: (?request_options: Courier::request_opts) -> void + attr_accessor brand_id: String - def to_hash: -> { request_options: Courier::RequestOptions } + def initialize: ( + brand_id: String, + ?request_options: Courier::request_opts + ) -> void + + def to_hash: -> { + brand_id: String, + request_options: Courier::RequestOptions + } end end end diff --git a/sig/courier/models/brand_retrieve_params.rbs b/sig/courier/models/brand_retrieve_params.rbs index 5796e119..cd3e107a 100644 --- a/sig/courier/models/brand_retrieve_params.rbs +++ b/sig/courier/models/brand_retrieve_params.rbs @@ -1,15 +1,23 @@ module Courier module Models type brand_retrieve_params = - { } & Courier::Internal::Type::request_parameters + { brand_id: String } & Courier::Internal::Type::request_parameters class BrandRetrieveParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - def initialize: (?request_options: Courier::request_opts) -> void + attr_accessor brand_id: String - def to_hash: -> { request_options: Courier::RequestOptions } + def initialize: ( + brand_id: String, + ?request_options: Courier::request_opts + ) -> void + + def to_hash: -> { + brand_id: String, + request_options: Courier::RequestOptions + } end end end diff --git a/sig/courier/models/brand_update_params.rbs b/sig/courier/models/brand_update_params.rbs index 7d6d5cd4..e1c6a08c 100644 --- a/sig/courier/models/brand_update_params.rbs +++ b/sig/courier/models/brand_update_params.rbs @@ -2,6 +2,7 @@ module Courier module Models type brand_update_params = { + brand_id: String, name: String, settings: Courier::BrandSettings?, snippets: Courier::BrandSnippets? @@ -12,6 +13,8 @@ module Courier extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + attr_accessor brand_id: String + attr_accessor name: String attr_accessor settings: Courier::BrandSettings? @@ -19,6 +22,7 @@ module Courier attr_accessor snippets: Courier::BrandSnippets? def initialize: ( + brand_id: String, name: String, ?settings: Courier::BrandSettings?, ?snippets: Courier::BrandSnippets?, @@ -26,6 +30,7 @@ module Courier ) -> void def to_hash: -> { + brand_id: String, name: String, settings: Courier::BrandSettings?, snippets: Courier::BrandSnippets?, diff --git a/sig/courier/models/bulk_add_users_params.rbs b/sig/courier/models/bulk_add_users_params.rbs index b81b9353..47d5a76b 100644 --- a/sig/courier/models/bulk_add_users_params.rbs +++ b/sig/courier/models/bulk_add_users_params.rbs @@ -1,21 +1,25 @@ module Courier module Models type bulk_add_users_params = - { users: ::Array[Courier::InboundBulkMessageUser] } + { job_id: String, users: ::Array[Courier::InboundBulkMessageUser] } & Courier::Internal::Type::request_parameters class BulkAddUsersParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + attr_accessor job_id: String + attr_accessor users: ::Array[Courier::InboundBulkMessageUser] def initialize: ( + job_id: String, users: ::Array[Courier::InboundBulkMessageUser], ?request_options: Courier::request_opts ) -> void def to_hash: -> { + job_id: String, users: ::Array[Courier::InboundBulkMessageUser], request_options: Courier::RequestOptions } diff --git a/sig/courier/models/bulk_list_users_params.rbs b/sig/courier/models/bulk_list_users_params.rbs index 9cd12706..749c5893 100644 --- a/sig/courier/models/bulk_list_users_params.rbs +++ b/sig/courier/models/bulk_list_users_params.rbs @@ -1,20 +1,25 @@ module Courier module Models type bulk_list_users_params = - { cursor: String? } & Courier::Internal::Type::request_parameters + { job_id: String, cursor: String? } + & Courier::Internal::Type::request_parameters class BulkListUsersParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + attr_accessor job_id: String + attr_accessor cursor: String? def initialize: ( + job_id: String, ?cursor: String?, ?request_options: Courier::request_opts ) -> void def to_hash: -> { + job_id: String, cursor: String?, request_options: Courier::RequestOptions } diff --git a/sig/courier/models/bulk_retrieve_job_params.rbs b/sig/courier/models/bulk_retrieve_job_params.rbs index c90d5e56..4314b360 100644 --- a/sig/courier/models/bulk_retrieve_job_params.rbs +++ b/sig/courier/models/bulk_retrieve_job_params.rbs @@ -1,15 +1,23 @@ module Courier module Models type bulk_retrieve_job_params = - { } & Courier::Internal::Type::request_parameters + { job_id: String } & Courier::Internal::Type::request_parameters class BulkRetrieveJobParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - def initialize: (?request_options: Courier::request_opts) -> void + attr_accessor job_id: String - def to_hash: -> { request_options: Courier::RequestOptions } + def initialize: ( + job_id: String, + ?request_options: Courier::request_opts + ) -> void + + def to_hash: -> { + job_id: String, + request_options: Courier::RequestOptions + } end end end diff --git a/sig/courier/models/bulk_run_job_params.rbs b/sig/courier/models/bulk_run_job_params.rbs index 5f7fd80f..1d0398e5 100644 --- a/sig/courier/models/bulk_run_job_params.rbs +++ b/sig/courier/models/bulk_run_job_params.rbs @@ -1,15 +1,23 @@ module Courier module Models type bulk_run_job_params = - { } & Courier::Internal::Type::request_parameters + { job_id: String } & Courier::Internal::Type::request_parameters class BulkRunJobParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - def initialize: (?request_options: Courier::request_opts) -> void + attr_accessor job_id: String - def to_hash: -> { request_options: Courier::RequestOptions } + def initialize: ( + job_id: String, + ?request_options: Courier::request_opts + ) -> void + + def to_hash: -> { + job_id: String, + request_options: Courier::RequestOptions + } end end end diff --git a/sig/courier/models/list_delete_params.rbs b/sig/courier/models/list_delete_params.rbs index b1867d46..b55d6aed 100644 --- a/sig/courier/models/list_delete_params.rbs +++ b/sig/courier/models/list_delete_params.rbs @@ -1,14 +1,23 @@ module Courier module Models - type list_delete_params = { } & Courier::Internal::Type::request_parameters + type list_delete_params = + { list_id: String } & Courier::Internal::Type::request_parameters class ListDeleteParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - def initialize: (?request_options: Courier::request_opts) -> void + attr_accessor list_id: String - def to_hash: -> { request_options: Courier::RequestOptions } + def initialize: ( + list_id: String, + ?request_options: Courier::request_opts + ) -> void + + def to_hash: -> { + list_id: String, + request_options: Courier::RequestOptions + } end end end diff --git a/sig/courier/models/list_restore_params.rbs b/sig/courier/models/list_restore_params.rbs index c7cfefff..518fb870 100644 --- a/sig/courier/models/list_restore_params.rbs +++ b/sig/courier/models/list_restore_params.rbs @@ -1,15 +1,23 @@ module Courier module Models type list_restore_params = - { } & Courier::Internal::Type::request_parameters + { list_id: String } & Courier::Internal::Type::request_parameters class ListRestoreParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - def initialize: (?request_options: Courier::request_opts) -> void + attr_accessor list_id: String - def to_hash: -> { request_options: Courier::RequestOptions } + def initialize: ( + list_id: String, + ?request_options: Courier::request_opts + ) -> void + + def to_hash: -> { + list_id: String, + request_options: Courier::RequestOptions + } end end end diff --git a/sig/courier/models/list_retrieve_params.rbs b/sig/courier/models/list_retrieve_params.rbs index a7e04b4c..4c216fa9 100644 --- a/sig/courier/models/list_retrieve_params.rbs +++ b/sig/courier/models/list_retrieve_params.rbs @@ -1,15 +1,23 @@ module Courier module Models type list_retrieve_params = - { } & Courier::Internal::Type::request_parameters + { list_id: String } & Courier::Internal::Type::request_parameters class ListRetrieveParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - def initialize: (?request_options: Courier::request_opts) -> void + attr_accessor list_id: String - def to_hash: -> { request_options: Courier::RequestOptions } + def initialize: ( + list_id: String, + ?request_options: Courier::request_opts + ) -> void + + def to_hash: -> { + list_id: String, + request_options: Courier::RequestOptions + } end end end diff --git a/sig/courier/models/list_update_params.rbs b/sig/courier/models/list_update_params.rbs index 06827932..7bb3373c 100644 --- a/sig/courier/models/list_update_params.rbs +++ b/sig/courier/models/list_update_params.rbs @@ -1,24 +1,32 @@ module Courier module Models type list_update_params = - { name: String, preferences: Courier::RecipientPreferences? } + { + list_id: String, + name: String, + preferences: Courier::RecipientPreferences? + } & Courier::Internal::Type::request_parameters class ListUpdateParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + attr_accessor list_id: String + attr_accessor name: String attr_accessor preferences: Courier::RecipientPreferences? def initialize: ( + list_id: String, name: String, ?preferences: Courier::RecipientPreferences?, ?request_options: Courier::request_opts ) -> void def to_hash: -> { + list_id: String, name: String, preferences: Courier::RecipientPreferences?, request_options: Courier::RequestOptions diff --git a/sig/courier/models/lists/subscription_add_params.rbs b/sig/courier/models/lists/subscription_add_params.rbs index c99a53bb..cbdeece7 100644 --- a/sig/courier/models/lists/subscription_add_params.rbs +++ b/sig/courier/models/lists/subscription_add_params.rbs @@ -2,21 +2,28 @@ module Courier module Models module Lists type subscription_add_params = - { recipients: ::Array[Courier::PutSubscriptionsRecipient] } + { + list_id: String, + recipients: ::Array[Courier::PutSubscriptionsRecipient] + } & Courier::Internal::Type::request_parameters class SubscriptionAddParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + attr_accessor list_id: String + attr_accessor recipients: ::Array[Courier::PutSubscriptionsRecipient] def initialize: ( + list_id: String, recipients: ::Array[Courier::PutSubscriptionsRecipient], ?request_options: Courier::request_opts ) -> void def to_hash: -> { + list_id: String, recipients: ::Array[Courier::PutSubscriptionsRecipient], request_options: Courier::RequestOptions } diff --git a/sig/courier/models/lists/subscription_list_params.rbs b/sig/courier/models/lists/subscription_list_params.rbs index d1ca2af5..ac0b584b 100644 --- a/sig/courier/models/lists/subscription_list_params.rbs +++ b/sig/courier/models/lists/subscription_list_params.rbs @@ -2,20 +2,25 @@ module Courier module Models module Lists type subscription_list_params = - { cursor: String? } & Courier::Internal::Type::request_parameters + { list_id: String, cursor: String? } + & Courier::Internal::Type::request_parameters class SubscriptionListParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + attr_accessor list_id: String + attr_accessor cursor: String? def initialize: ( + list_id: String, ?cursor: String?, ?request_options: Courier::request_opts ) -> void def to_hash: -> { + list_id: String, cursor: String?, request_options: Courier::RequestOptions } diff --git a/sig/courier/models/lists/subscription_subscribe_params.rbs b/sig/courier/models/lists/subscription_subscribe_params.rbs index f09f1b43..2da0af82 100644 --- a/sig/courier/models/lists/subscription_subscribe_params.rbs +++ b/sig/courier/models/lists/subscription_subscribe_params.rbs @@ -2,21 +2,28 @@ module Courier module Models module Lists type subscription_subscribe_params = - { recipients: ::Array[Courier::PutSubscriptionsRecipient] } + { + list_id: String, + recipients: ::Array[Courier::PutSubscriptionsRecipient] + } & Courier::Internal::Type::request_parameters class SubscriptionSubscribeParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + attr_accessor list_id: String + attr_accessor recipients: ::Array[Courier::PutSubscriptionsRecipient] def initialize: ( + list_id: String, recipients: ::Array[Courier::PutSubscriptionsRecipient], ?request_options: Courier::request_opts ) -> void def to_hash: -> { + list_id: String, recipients: ::Array[Courier::PutSubscriptionsRecipient], request_options: Courier::RequestOptions } diff --git a/sig/courier/models/lists/subscription_subscribe_user_params.rbs b/sig/courier/models/lists/subscription_subscribe_user_params.rbs index dacdad68..39e19ab0 100644 --- a/sig/courier/models/lists/subscription_subscribe_user_params.rbs +++ b/sig/courier/models/lists/subscription_subscribe_user_params.rbs @@ -2,7 +2,11 @@ module Courier module Models module Lists type subscription_subscribe_user_params = - { list_id: String, preferences: Courier::RecipientPreferences? } + { + list_id: String, + user_id: String, + preferences: Courier::RecipientPreferences? + } & Courier::Internal::Type::request_parameters class SubscriptionSubscribeUserParams < Courier::Internal::Type::BaseModel @@ -11,16 +15,20 @@ module Courier attr_accessor list_id: String + attr_accessor user_id: String + attr_accessor preferences: Courier::RecipientPreferences? def initialize: ( list_id: String, + user_id: String, ?preferences: Courier::RecipientPreferences?, ?request_options: Courier::request_opts ) -> void def to_hash: -> { list_id: String, + user_id: String, preferences: Courier::RecipientPreferences?, request_options: Courier::RequestOptions } diff --git a/sig/courier/models/lists/subscription_unsubscribe_user_params.rbs b/sig/courier/models/lists/subscription_unsubscribe_user_params.rbs index 6a2bedce..481b0ebb 100644 --- a/sig/courier/models/lists/subscription_unsubscribe_user_params.rbs +++ b/sig/courier/models/lists/subscription_unsubscribe_user_params.rbs @@ -2,7 +2,8 @@ module Courier module Models module Lists type subscription_unsubscribe_user_params = - { list_id: String } & Courier::Internal::Type::request_parameters + { list_id: String, user_id: String } + & Courier::Internal::Type::request_parameters class SubscriptionUnsubscribeUserParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter @@ -10,13 +11,17 @@ module Courier attr_accessor list_id: String + attr_accessor user_id: String + def initialize: ( list_id: String, + user_id: String, ?request_options: Courier::request_opts ) -> void def to_hash: -> { list_id: String, + user_id: String, request_options: Courier::RequestOptions } end diff --git a/sig/courier/models/message_cancel_params.rbs b/sig/courier/models/message_cancel_params.rbs index e251f116..15c4ebe2 100644 --- a/sig/courier/models/message_cancel_params.rbs +++ b/sig/courier/models/message_cancel_params.rbs @@ -1,15 +1,23 @@ module Courier module Models type message_cancel_params = - { } & Courier::Internal::Type::request_parameters + { message_id: String } & Courier::Internal::Type::request_parameters class MessageCancelParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - def initialize: (?request_options: Courier::request_opts) -> void + attr_accessor message_id: String - def to_hash: -> { request_options: Courier::RequestOptions } + def initialize: ( + message_id: String, + ?request_options: Courier::request_opts + ) -> void + + def to_hash: -> { + message_id: String, + request_options: Courier::RequestOptions + } end end end diff --git a/sig/courier/models/message_content_params.rbs b/sig/courier/models/message_content_params.rbs index 725a5607..8285e6f9 100644 --- a/sig/courier/models/message_content_params.rbs +++ b/sig/courier/models/message_content_params.rbs @@ -1,15 +1,23 @@ module Courier module Models type message_content_params = - { } & Courier::Internal::Type::request_parameters + { message_id: String } & Courier::Internal::Type::request_parameters class MessageContentParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - def initialize: (?request_options: Courier::request_opts) -> void + attr_accessor message_id: String - def to_hash: -> { request_options: Courier::RequestOptions } + def initialize: ( + message_id: String, + ?request_options: Courier::request_opts + ) -> void + + def to_hash: -> { + message_id: String, + request_options: Courier::RequestOptions + } end end end diff --git a/sig/courier/models/message_history_params.rbs b/sig/courier/models/message_history_params.rbs index 9e0fc580..b1669138 100644 --- a/sig/courier/models/message_history_params.rbs +++ b/sig/courier/models/message_history_params.rbs @@ -1,20 +1,25 @@ module Courier module Models type message_history_params = - { type: String? } & Courier::Internal::Type::request_parameters + { message_id: String, type: String? } + & Courier::Internal::Type::request_parameters class MessageHistoryParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + attr_accessor message_id: String + attr_accessor type: String? def initialize: ( + message_id: String, ?type: String?, ?request_options: Courier::request_opts ) -> void def to_hash: -> { + message_id: String, type: String?, request_options: Courier::RequestOptions } diff --git a/sig/courier/models/message_retrieve_params.rbs b/sig/courier/models/message_retrieve_params.rbs index 6faf2aa0..de01ba8a 100644 --- a/sig/courier/models/message_retrieve_params.rbs +++ b/sig/courier/models/message_retrieve_params.rbs @@ -1,15 +1,23 @@ module Courier module Models type message_retrieve_params = - { } & Courier::Internal::Type::request_parameters + { message_id: String } & Courier::Internal::Type::request_parameters class MessageRetrieveParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - def initialize: (?request_options: Courier::request_opts) -> void + attr_accessor message_id: String - def to_hash: -> { request_options: Courier::RequestOptions } + def initialize: ( + message_id: String, + ?request_options: Courier::request_opts + ) -> void + + def to_hash: -> { + message_id: String, + request_options: Courier::RequestOptions + } end end end diff --git a/sig/courier/models/notification_retrieve_content_params.rbs b/sig/courier/models/notification_retrieve_content_params.rbs index 964a3743..0c9b88ad 100644 --- a/sig/courier/models/notification_retrieve_content_params.rbs +++ b/sig/courier/models/notification_retrieve_content_params.rbs @@ -1,15 +1,20 @@ module Courier module Models type notification_retrieve_content_params = - { } & Courier::Internal::Type::request_parameters + { id: String } & Courier::Internal::Type::request_parameters class NotificationRetrieveContentParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - def initialize: (?request_options: Courier::request_opts) -> void + attr_accessor id: String - def to_hash: -> { request_options: Courier::RequestOptions } + def initialize: ( + id: String, + ?request_options: Courier::request_opts + ) -> void + + def to_hash: -> { id: String, request_options: Courier::RequestOptions } end end end diff --git a/sig/courier/models/notifications/check_delete_params.rbs b/sig/courier/models/notifications/check_delete_params.rbs index 3d240a9d..145158cf 100644 --- a/sig/courier/models/notifications/check_delete_params.rbs +++ b/sig/courier/models/notifications/check_delete_params.rbs @@ -2,7 +2,8 @@ module Courier module Models module Notifications type check_delete_params = - { id: String } & Courier::Internal::Type::request_parameters + { id: String, submission_id: String } + & Courier::Internal::Type::request_parameters class CheckDeleteParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter @@ -10,12 +11,19 @@ module Courier attr_accessor id: String + attr_accessor submission_id: String + def initialize: ( id: String, + submission_id: String, ?request_options: Courier::request_opts ) -> void - def to_hash: -> { id: String, request_options: Courier::RequestOptions } + def to_hash: -> { + id: String, + submission_id: String, + request_options: Courier::RequestOptions + } end end end diff --git a/sig/courier/models/notifications/check_list_params.rbs b/sig/courier/models/notifications/check_list_params.rbs index 7aa762d1..ce4cd428 100644 --- a/sig/courier/models/notifications/check_list_params.rbs +++ b/sig/courier/models/notifications/check_list_params.rbs @@ -2,7 +2,8 @@ module Courier module Models module Notifications type check_list_params = - { id: String } & Courier::Internal::Type::request_parameters + { id: String, submission_id: String } + & Courier::Internal::Type::request_parameters class CheckListParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter @@ -10,12 +11,19 @@ module Courier attr_accessor id: String + attr_accessor submission_id: String + def initialize: ( id: String, + submission_id: String, ?request_options: Courier::request_opts ) -> void - def to_hash: -> { id: String, request_options: Courier::RequestOptions } + def to_hash: -> { + id: String, + submission_id: String, + request_options: Courier::RequestOptions + } end end end diff --git a/sig/courier/models/notifications/check_update_params.rbs b/sig/courier/models/notifications/check_update_params.rbs index 111edca2..664646f5 100644 --- a/sig/courier/models/notifications/check_update_params.rbs +++ b/sig/courier/models/notifications/check_update_params.rbs @@ -2,7 +2,11 @@ module Courier module Models module Notifications type check_update_params = - { id: String, checks: ::Array[Courier::BaseCheck] } + { + id: String, + submission_id: String, + checks: ::Array[Courier::BaseCheck] + } & Courier::Internal::Type::request_parameters class CheckUpdateParams < Courier::Internal::Type::BaseModel @@ -11,16 +15,20 @@ module Courier attr_accessor id: String + attr_accessor submission_id: String + attr_accessor checks: ::Array[Courier::BaseCheck] def initialize: ( id: String, + submission_id: String, checks: ::Array[Courier::BaseCheck], ?request_options: Courier::request_opts ) -> void def to_hash: -> { id: String, + submission_id: String, checks: ::Array[Courier::BaseCheck], request_options: Courier::RequestOptions } diff --git a/sig/courier/models/notifications/draft_retrieve_content_params.rbs b/sig/courier/models/notifications/draft_retrieve_content_params.rbs index 1fddb840..c27cf6ac 100644 --- a/sig/courier/models/notifications/draft_retrieve_content_params.rbs +++ b/sig/courier/models/notifications/draft_retrieve_content_params.rbs @@ -2,15 +2,20 @@ module Courier module Models module Notifications type draft_retrieve_content_params = - { } & Courier::Internal::Type::request_parameters + { id: String } & Courier::Internal::Type::request_parameters class DraftRetrieveContentParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - def initialize: (?request_options: Courier::request_opts) -> void + attr_accessor id: String - def to_hash: -> { request_options: Courier::RequestOptions } + def initialize: ( + id: String, + ?request_options: Courier::request_opts + ) -> void + + def to_hash: -> { id: String, request_options: Courier::RequestOptions } end end end diff --git a/sig/courier/models/profile_create_params.rbs b/sig/courier/models/profile_create_params.rbs index f2f47e7b..fe318b69 100644 --- a/sig/courier/models/profile_create_params.rbs +++ b/sig/courier/models/profile_create_params.rbs @@ -1,21 +1,25 @@ module Courier module Models type profile_create_params = - { profile: ::Hash[Symbol, top] } + { user_id: String, profile: ::Hash[Symbol, top] } & Courier::Internal::Type::request_parameters class ProfileCreateParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + attr_accessor user_id: String + attr_accessor profile: ::Hash[Symbol, top] def initialize: ( + user_id: String, profile: ::Hash[Symbol, top], ?request_options: Courier::request_opts ) -> void def to_hash: -> { + user_id: String, profile: ::Hash[Symbol, top], request_options: Courier::RequestOptions } diff --git a/sig/courier/models/profile_delete_params.rbs b/sig/courier/models/profile_delete_params.rbs index 8925a57f..3c033bbf 100644 --- a/sig/courier/models/profile_delete_params.rbs +++ b/sig/courier/models/profile_delete_params.rbs @@ -1,15 +1,23 @@ module Courier module Models type profile_delete_params = - { } & Courier::Internal::Type::request_parameters + { user_id: String } & Courier::Internal::Type::request_parameters class ProfileDeleteParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - def initialize: (?request_options: Courier::request_opts) -> void + attr_accessor user_id: String - def to_hash: -> { request_options: Courier::RequestOptions } + def initialize: ( + user_id: String, + ?request_options: Courier::request_opts + ) -> void + + def to_hash: -> { + user_id: String, + request_options: Courier::RequestOptions + } end end end diff --git a/sig/courier/models/profile_replace_params.rbs b/sig/courier/models/profile_replace_params.rbs index 4c22dfc9..b6ede1c8 100644 --- a/sig/courier/models/profile_replace_params.rbs +++ b/sig/courier/models/profile_replace_params.rbs @@ -1,21 +1,25 @@ module Courier module Models type profile_replace_params = - { profile: ::Hash[Symbol, top] } + { user_id: String, profile: ::Hash[Symbol, top] } & Courier::Internal::Type::request_parameters class ProfileReplaceParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + attr_accessor user_id: String + attr_accessor profile: ::Hash[Symbol, top] def initialize: ( + user_id: String, profile: ::Hash[Symbol, top], ?request_options: Courier::request_opts ) -> void def to_hash: -> { + user_id: String, profile: ::Hash[Symbol, top], request_options: Courier::RequestOptions } diff --git a/sig/courier/models/profile_retrieve_params.rbs b/sig/courier/models/profile_retrieve_params.rbs index 722703b0..dd8b0a26 100644 --- a/sig/courier/models/profile_retrieve_params.rbs +++ b/sig/courier/models/profile_retrieve_params.rbs @@ -1,15 +1,23 @@ module Courier module Models type profile_retrieve_params = - { } & Courier::Internal::Type::request_parameters + { user_id: String } & Courier::Internal::Type::request_parameters class ProfileRetrieveParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - def initialize: (?request_options: Courier::request_opts) -> void + attr_accessor user_id: String - def to_hash: -> { request_options: Courier::RequestOptions } + def initialize: ( + user_id: String, + ?request_options: Courier::request_opts + ) -> void + + def to_hash: -> { + user_id: String, + request_options: Courier::RequestOptions + } end end end diff --git a/sig/courier/models/profile_update_params.rbs b/sig/courier/models/profile_update_params.rbs index 3cf13568..62ac6de8 100644 --- a/sig/courier/models/profile_update_params.rbs +++ b/sig/courier/models/profile_update_params.rbs @@ -1,21 +1,25 @@ module Courier module Models type profile_update_params = - { patch: ::Array[Courier::ProfileUpdateParams::Patch] } + { user_id: String, patch: ::Array[Courier::ProfileUpdateParams::Patch] } & Courier::Internal::Type::request_parameters class ProfileUpdateParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + attr_accessor user_id: String + attr_accessor patch: ::Array[Courier::ProfileUpdateParams::Patch] def initialize: ( + user_id: String, patch: ::Array[Courier::ProfileUpdateParams::Patch], ?request_options: Courier::request_opts ) -> void def to_hash: -> { + user_id: String, patch: ::Array[Courier::ProfileUpdateParams::Patch], request_options: Courier::RequestOptions } diff --git a/sig/courier/models/profiles/list_delete_params.rbs b/sig/courier/models/profiles/list_delete_params.rbs index 22e6bd2e..09add290 100644 --- a/sig/courier/models/profiles/list_delete_params.rbs +++ b/sig/courier/models/profiles/list_delete_params.rbs @@ -2,15 +2,23 @@ module Courier module Models module Profiles type list_delete_params = - { } & Courier::Internal::Type::request_parameters + { user_id: String } & Courier::Internal::Type::request_parameters class ListDeleteParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - def initialize: (?request_options: Courier::request_opts) -> void + attr_accessor user_id: String - def to_hash: -> { request_options: Courier::RequestOptions } + def initialize: ( + user_id: String, + ?request_options: Courier::request_opts + ) -> void + + def to_hash: -> { + user_id: String, + request_options: Courier::RequestOptions + } end end end diff --git a/sig/courier/models/profiles/list_retrieve_params.rbs b/sig/courier/models/profiles/list_retrieve_params.rbs index 89e70516..95eafc4c 100644 --- a/sig/courier/models/profiles/list_retrieve_params.rbs +++ b/sig/courier/models/profiles/list_retrieve_params.rbs @@ -2,20 +2,25 @@ module Courier module Models module Profiles type list_retrieve_params = - { cursor: String? } & Courier::Internal::Type::request_parameters + { user_id: String, cursor: String? } + & Courier::Internal::Type::request_parameters class ListRetrieveParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + attr_accessor user_id: String + attr_accessor cursor: String? def initialize: ( + user_id: String, ?cursor: String?, ?request_options: Courier::request_opts ) -> void def to_hash: -> { + user_id: String, cursor: String?, request_options: Courier::RequestOptions } diff --git a/sig/courier/models/profiles/list_subscribe_params.rbs b/sig/courier/models/profiles/list_subscribe_params.rbs index 0c1757f5..ccf15123 100644 --- a/sig/courier/models/profiles/list_subscribe_params.rbs +++ b/sig/courier/models/profiles/list_subscribe_params.rbs @@ -2,21 +2,28 @@ module Courier module Models module Profiles type list_subscribe_params = - { lists: ::Array[Courier::SubscribeToListsRequestItem] } + { + user_id: String, + lists: ::Array[Courier::SubscribeToListsRequestItem] + } & Courier::Internal::Type::request_parameters class ListSubscribeParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + attr_accessor user_id: String + attr_accessor lists: ::Array[Courier::SubscribeToListsRequestItem] def initialize: ( + user_id: String, lists: ::Array[Courier::SubscribeToListsRequestItem], ?request_options: Courier::request_opts ) -> void def to_hash: -> { + user_id: String, lists: ::Array[Courier::SubscribeToListsRequestItem], request_options: Courier::RequestOptions } diff --git a/sig/courier/models/request_archive_params.rbs b/sig/courier/models/request_archive_params.rbs index e50538fd..feb3dc55 100644 --- a/sig/courier/models/request_archive_params.rbs +++ b/sig/courier/models/request_archive_params.rbs @@ -1,15 +1,23 @@ module Courier module Models type request_archive_params = - { } & Courier::Internal::Type::request_parameters + { request_id: String } & Courier::Internal::Type::request_parameters class RequestArchiveParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - def initialize: (?request_options: Courier::request_opts) -> void + attr_accessor request_id: String - def to_hash: -> { request_options: Courier::RequestOptions } + def initialize: ( + request_id: String, + ?request_options: Courier::request_opts + ) -> void + + def to_hash: -> { + request_id: String, + request_options: Courier::RequestOptions + } end end end diff --git a/sig/courier/models/tenant_delete_params.rbs b/sig/courier/models/tenant_delete_params.rbs index d1c30e6b..f983f30e 100644 --- a/sig/courier/models/tenant_delete_params.rbs +++ b/sig/courier/models/tenant_delete_params.rbs @@ -1,15 +1,23 @@ module Courier module Models type tenant_delete_params = - { } & Courier::Internal::Type::request_parameters + { tenant_id: String } & Courier::Internal::Type::request_parameters class TenantDeleteParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - def initialize: (?request_options: Courier::request_opts) -> void + attr_accessor tenant_id: String - def to_hash: -> { request_options: Courier::RequestOptions } + def initialize: ( + tenant_id: String, + ?request_options: Courier::request_opts + ) -> void + + def to_hash: -> { + tenant_id: String, + request_options: Courier::RequestOptions + } end end end diff --git a/sig/courier/models/tenant_list_users_params.rbs b/sig/courier/models/tenant_list_users_params.rbs index cdaecfd7..1aa70d21 100644 --- a/sig/courier/models/tenant_list_users_params.rbs +++ b/sig/courier/models/tenant_list_users_params.rbs @@ -1,24 +1,28 @@ module Courier module Models type tenant_list_users_params = - { cursor: String?, limit: Integer? } + { tenant_id: String, cursor: String?, limit: Integer? } & Courier::Internal::Type::request_parameters class TenantListUsersParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + attr_accessor tenant_id: String + attr_accessor cursor: String? attr_accessor limit: Integer? def initialize: ( + tenant_id: String, ?cursor: String?, ?limit: Integer?, ?request_options: Courier::request_opts ) -> void def to_hash: -> { + tenant_id: String, cursor: String?, limit: Integer?, request_options: Courier::RequestOptions diff --git a/sig/courier/models/tenant_retrieve_params.rbs b/sig/courier/models/tenant_retrieve_params.rbs index 8749dff2..0d4d1337 100644 --- a/sig/courier/models/tenant_retrieve_params.rbs +++ b/sig/courier/models/tenant_retrieve_params.rbs @@ -1,15 +1,23 @@ module Courier module Models type tenant_retrieve_params = - { } & Courier::Internal::Type::request_parameters + { tenant_id: String } & Courier::Internal::Type::request_parameters class TenantRetrieveParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - def initialize: (?request_options: Courier::request_opts) -> void + attr_accessor tenant_id: String - def to_hash: -> { request_options: Courier::RequestOptions } + def initialize: ( + tenant_id: String, + ?request_options: Courier::request_opts + ) -> void + + def to_hash: -> { + tenant_id: String, + request_options: Courier::RequestOptions + } end end end diff --git a/sig/courier/models/tenant_update_params.rbs b/sig/courier/models/tenant_update_params.rbs index 7236485d..db472f7c 100644 --- a/sig/courier/models/tenant_update_params.rbs +++ b/sig/courier/models/tenant_update_params.rbs @@ -2,6 +2,7 @@ module Courier module Models type tenant_update_params = { + tenant_id: String, name: String, brand_id: String?, default_preferences: Courier::DefaultPreferences?, @@ -15,6 +16,8 @@ module Courier extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + attr_accessor tenant_id: String + attr_accessor name: String attr_accessor brand_id: String? @@ -28,6 +31,7 @@ module Courier attr_accessor user_profile: ::Hash[Symbol, top]? def initialize: ( + tenant_id: String, name: String, ?brand_id: String?, ?default_preferences: Courier::DefaultPreferences?, @@ -38,6 +42,7 @@ module Courier ) -> void def to_hash: -> { + tenant_id: String, name: String, brand_id: String?, default_preferences: Courier::DefaultPreferences?, diff --git a/sig/courier/models/tenants/preferences/item_delete_params.rbs b/sig/courier/models/tenants/preferences/item_delete_params.rbs index 0624ba87..2699425c 100644 --- a/sig/courier/models/tenants/preferences/item_delete_params.rbs +++ b/sig/courier/models/tenants/preferences/item_delete_params.rbs @@ -3,7 +3,8 @@ module Courier module Tenants module Preferences type item_delete_params = - { tenant_id: String } & Courier::Internal::Type::request_parameters + { tenant_id: String, topic_id: String } + & Courier::Internal::Type::request_parameters class ItemDeleteParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter @@ -11,13 +12,17 @@ module Courier attr_accessor tenant_id: String + attr_accessor topic_id: String + def initialize: ( tenant_id: String, + topic_id: String, ?request_options: Courier::request_opts ) -> void def to_hash: -> { tenant_id: String, + topic_id: String, request_options: Courier::RequestOptions } end diff --git a/sig/courier/models/tenants/preferences/item_update_params.rbs b/sig/courier/models/tenants/preferences/item_update_params.rbs index bd7165a7..74569693 100644 --- a/sig/courier/models/tenants/preferences/item_update_params.rbs +++ b/sig/courier/models/tenants/preferences/item_update_params.rbs @@ -3,7 +3,8 @@ module Courier module Tenants module Preferences type item_update_params = - { tenant_id: String } & Courier::Internal::Type::request_parameters + { tenant_id: String, topic_id: String } + & Courier::Internal::Type::request_parameters class ItemUpdateParams < Courier::Models::SubscriptionTopicNew extend Courier::Internal::Type::RequestParameters::Converter @@ -13,13 +14,19 @@ module Courier def tenant_id=: (String _) -> String + def topic_id: -> String + + def topic_id=: (String _) -> String + def initialize: ( tenant_id: String, + topic_id: String, ?request_options: Courier::request_opts ) -> void def to_hash: -> { tenant_id: String, + topic_id: String, request_options: Courier::RequestOptions } end diff --git a/sig/courier/models/tenants/template_list_params.rbs b/sig/courier/models/tenants/template_list_params.rbs index 5bf28c7d..ac273a3a 100644 --- a/sig/courier/models/tenants/template_list_params.rbs +++ b/sig/courier/models/tenants/template_list_params.rbs @@ -2,24 +2,28 @@ module Courier module Models module Tenants type template_list_params = - { cursor: String?, limit: Integer? } + { tenant_id: String, cursor: String?, limit: Integer? } & Courier::Internal::Type::request_parameters class TemplateListParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + attr_accessor tenant_id: String + attr_accessor cursor: String? attr_accessor limit: Integer? def initialize: ( + tenant_id: String, ?cursor: String?, ?limit: Integer?, ?request_options: Courier::request_opts ) -> void def to_hash: -> { + tenant_id: String, cursor: String?, limit: Integer?, request_options: Courier::RequestOptions diff --git a/sig/courier/models/tenants/template_publish_params.rbs b/sig/courier/models/tenants/template_publish_params.rbs index f3368f5b..0020404a 100644 --- a/sig/courier/models/tenants/template_publish_params.rbs +++ b/sig/courier/models/tenants/template_publish_params.rbs @@ -2,7 +2,8 @@ module Courier module Models module Tenants type template_publish_params = - { tenant_id: String } & Courier::Internal::Type::request_parameters + { tenant_id: String, template_id: String } + & Courier::Internal::Type::request_parameters class TemplatePublishParams < Courier::Models::PostTenantTemplatePublishRequest extend Courier::Internal::Type::RequestParameters::Converter @@ -12,13 +13,19 @@ module Courier def tenant_id=: (String _) -> String + def template_id: -> String + + def template_id=: (String _) -> String + def initialize: ( tenant_id: String, + template_id: String, ?request_options: Courier::request_opts ) -> void def to_hash: -> { tenant_id: String, + template_id: String, request_options: Courier::RequestOptions } end diff --git a/sig/courier/models/tenants/template_replace_params.rbs b/sig/courier/models/tenants/template_replace_params.rbs index 5cebf466..cc4bccd9 100644 --- a/sig/courier/models/tenants/template_replace_params.rbs +++ b/sig/courier/models/tenants/template_replace_params.rbs @@ -2,7 +2,8 @@ module Courier module Models module Tenants type template_replace_params = - { tenant_id: String } & Courier::Internal::Type::request_parameters + { tenant_id: String, template_id: String } + & Courier::Internal::Type::request_parameters class TemplateReplaceParams < Courier::Models::PutTenantTemplateRequest extend Courier::Internal::Type::RequestParameters::Converter @@ -12,13 +13,19 @@ module Courier def tenant_id=: (String _) -> String + def template_id: -> String + + def template_id=: (String _) -> String + def initialize: ( tenant_id: String, + template_id: String, ?request_options: Courier::request_opts ) -> void def to_hash: -> { tenant_id: String, + template_id: String, request_options: Courier::RequestOptions } end diff --git a/sig/courier/models/tenants/template_retrieve_params.rbs b/sig/courier/models/tenants/template_retrieve_params.rbs index f5c2e45e..2d680715 100644 --- a/sig/courier/models/tenants/template_retrieve_params.rbs +++ b/sig/courier/models/tenants/template_retrieve_params.rbs @@ -2,7 +2,8 @@ module Courier module Models module Tenants type template_retrieve_params = - { tenant_id: String } & Courier::Internal::Type::request_parameters + { tenant_id: String, template_id: String } + & Courier::Internal::Type::request_parameters class TemplateRetrieveParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter @@ -10,13 +11,17 @@ module Courier attr_accessor tenant_id: String + attr_accessor template_id: String + def initialize: ( tenant_id: String, + template_id: String, ?request_options: Courier::request_opts ) -> void def to_hash: -> { tenant_id: String, + template_id: String, request_options: Courier::RequestOptions } end diff --git a/sig/courier/models/tenants/templates/version_retrieve_params.rbs b/sig/courier/models/tenants/templates/version_retrieve_params.rbs index a3b6957c..a507f049 100644 --- a/sig/courier/models/tenants/templates/version_retrieve_params.rbs +++ b/sig/courier/models/tenants/templates/version_retrieve_params.rbs @@ -3,7 +3,7 @@ module Courier module Tenants module Templates type version_retrieve_params = - { tenant_id: String, template_id: String } + { tenant_id: String, template_id: String, version: String } & Courier::Internal::Type::request_parameters class VersionRetrieveParams < Courier::Internal::Type::BaseModel @@ -14,15 +14,19 @@ module Courier attr_accessor template_id: String + attr_accessor version: String + def initialize: ( tenant_id: String, template_id: String, + version: String, ?request_options: Courier::request_opts ) -> void def to_hash: -> { tenant_id: String, template_id: String, + version: String, request_options: Courier::RequestOptions } end diff --git a/sig/courier/models/translation_retrieve_params.rbs b/sig/courier/models/translation_retrieve_params.rbs index 3c835f0e..23454f0f 100644 --- a/sig/courier/models/translation_retrieve_params.rbs +++ b/sig/courier/models/translation_retrieve_params.rbs @@ -1,7 +1,8 @@ module Courier module Models type translation_retrieve_params = - { domain: String } & Courier::Internal::Type::request_parameters + { domain: String, locale: String } + & Courier::Internal::Type::request_parameters class TranslationRetrieveParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter @@ -9,13 +10,17 @@ module Courier attr_accessor domain: String + attr_accessor locale: String + def initialize: ( domain: String, + locale: String, ?request_options: Courier::request_opts ) -> void def to_hash: -> { domain: String, + locale: String, request_options: Courier::RequestOptions } end diff --git a/sig/courier/models/translation_update_params.rbs b/sig/courier/models/translation_update_params.rbs index 459e07c1..f23c9f84 100644 --- a/sig/courier/models/translation_update_params.rbs +++ b/sig/courier/models/translation_update_params.rbs @@ -1,7 +1,7 @@ module Courier module Models type translation_update_params = - { domain: String, body: String } + { domain: String, locale: String, body: String } & Courier::Internal::Type::request_parameters class TranslationUpdateParams < Courier::Internal::Type::BaseModel @@ -10,16 +10,20 @@ module Courier attr_accessor domain: String + attr_accessor locale: String + attr_accessor body: String def initialize: ( domain: String, + locale: String, body: String, ?request_options: Courier::request_opts ) -> void def to_hash: -> { domain: String, + locale: String, body: String, request_options: Courier::RequestOptions } diff --git a/sig/courier/models/users/preference_retrieve_params.rbs b/sig/courier/models/users/preference_retrieve_params.rbs index 5da361a3..2efd2bd2 100644 --- a/sig/courier/models/users/preference_retrieve_params.rbs +++ b/sig/courier/models/users/preference_retrieve_params.rbs @@ -2,20 +2,25 @@ module Courier module Models module Users type preference_retrieve_params = - { tenant_id: String? } & Courier::Internal::Type::request_parameters + { user_id: String, tenant_id: String? } + & Courier::Internal::Type::request_parameters class PreferenceRetrieveParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + attr_accessor user_id: String + attr_accessor tenant_id: String? def initialize: ( + user_id: String, ?tenant_id: String?, ?request_options: Courier::request_opts ) -> void def to_hash: -> { + user_id: String, tenant_id: String?, request_options: Courier::RequestOptions } diff --git a/sig/courier/models/users/preference_retrieve_topic_params.rbs b/sig/courier/models/users/preference_retrieve_topic_params.rbs index 7ccc6a7f..b294f140 100644 --- a/sig/courier/models/users/preference_retrieve_topic_params.rbs +++ b/sig/courier/models/users/preference_retrieve_topic_params.rbs @@ -2,7 +2,7 @@ module Courier module Models module Users type preference_retrieve_topic_params = - { user_id: String, tenant_id: String? } + { user_id: String, topic_id: String, tenant_id: String? } & Courier::Internal::Type::request_parameters class PreferenceRetrieveTopicParams < Courier::Internal::Type::BaseModel @@ -11,16 +11,20 @@ module Courier attr_accessor user_id: String + attr_accessor topic_id: String + attr_accessor tenant_id: String? def initialize: ( user_id: String, + topic_id: String, ?tenant_id: String?, ?request_options: Courier::request_opts ) -> void def to_hash: -> { user_id: String, + topic_id: String, tenant_id: String?, request_options: Courier::RequestOptions } diff --git a/sig/courier/models/users/preference_update_or_create_topic_params.rbs b/sig/courier/models/users/preference_update_or_create_topic_params.rbs index 2c7b3652..f2b4ff8a 100644 --- a/sig/courier/models/users/preference_update_or_create_topic_params.rbs +++ b/sig/courier/models/users/preference_update_or_create_topic_params.rbs @@ -4,6 +4,7 @@ module Courier type preference_update_or_create_topic_params = { user_id: String, + topic_id: String, topic: Courier::Users::PreferenceUpdateOrCreateTopicParams::Topic, tenant_id: String? } @@ -15,12 +16,15 @@ module Courier attr_accessor user_id: String + attr_accessor topic_id: String + attr_accessor topic: Courier::Users::PreferenceUpdateOrCreateTopicParams::Topic attr_accessor tenant_id: String? def initialize: ( user_id: String, + topic_id: String, topic: Courier::Users::PreferenceUpdateOrCreateTopicParams::Topic, ?tenant_id: String?, ?request_options: Courier::request_opts @@ -28,6 +32,7 @@ module Courier def to_hash: -> { user_id: String, + topic_id: String, topic: Courier::Users::PreferenceUpdateOrCreateTopicParams::Topic, tenant_id: String?, request_options: Courier::RequestOptions diff --git a/sig/courier/models/users/tenant_add_multiple_params.rbs b/sig/courier/models/users/tenant_add_multiple_params.rbs index 79ea4f2d..645d38a8 100644 --- a/sig/courier/models/users/tenant_add_multiple_params.rbs +++ b/sig/courier/models/users/tenant_add_multiple_params.rbs @@ -2,21 +2,25 @@ module Courier module Models module Users type tenant_add_multiple_params = - { tenants: ::Array[Courier::TenantAssociation] } + { user_id: String, tenants: ::Array[Courier::TenantAssociation] } & Courier::Internal::Type::request_parameters class TenantAddMultipleParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + attr_accessor user_id: String + attr_accessor tenants: ::Array[Courier::TenantAssociation] def initialize: ( + user_id: String, tenants: ::Array[Courier::TenantAssociation], ?request_options: Courier::request_opts ) -> void def to_hash: -> { + user_id: String, tenants: ::Array[Courier::TenantAssociation], request_options: Courier::RequestOptions } diff --git a/sig/courier/models/users/tenant_add_single_params.rbs b/sig/courier/models/users/tenant_add_single_params.rbs index c4250780..0aefe0d0 100644 --- a/sig/courier/models/users/tenant_add_single_params.rbs +++ b/sig/courier/models/users/tenant_add_single_params.rbs @@ -2,7 +2,7 @@ module Courier module Models module Users type tenant_add_single_params = - { user_id: String, profile: ::Hash[Symbol, top]? } + { user_id: String, tenant_id: String, profile: ::Hash[Symbol, top]? } & Courier::Internal::Type::request_parameters class TenantAddSingleParams < Courier::Internal::Type::BaseModel @@ -11,16 +11,20 @@ module Courier attr_accessor user_id: String + attr_accessor tenant_id: String + attr_accessor profile: ::Hash[Symbol, top]? def initialize: ( user_id: String, + tenant_id: String, ?profile: ::Hash[Symbol, top]?, ?request_options: Courier::request_opts ) -> void def to_hash: -> { user_id: String, + tenant_id: String, profile: ::Hash[Symbol, top]?, request_options: Courier::RequestOptions } diff --git a/sig/courier/models/users/tenant_list_params.rbs b/sig/courier/models/users/tenant_list_params.rbs index e452edf4..6b4322a8 100644 --- a/sig/courier/models/users/tenant_list_params.rbs +++ b/sig/courier/models/users/tenant_list_params.rbs @@ -2,24 +2,28 @@ module Courier module Models module Users type tenant_list_params = - { cursor: String?, limit: Integer? } + { user_id: String, cursor: String?, limit: Integer? } & Courier::Internal::Type::request_parameters class TenantListParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters + attr_accessor user_id: String + attr_accessor cursor: String? attr_accessor limit: Integer? def initialize: ( + user_id: String, ?cursor: String?, ?limit: Integer?, ?request_options: Courier::request_opts ) -> void def to_hash: -> { + user_id: String, cursor: String?, limit: Integer?, request_options: Courier::RequestOptions diff --git a/sig/courier/models/users/tenant_remove_all_params.rbs b/sig/courier/models/users/tenant_remove_all_params.rbs index 79e7ee67..8679fcb7 100644 --- a/sig/courier/models/users/tenant_remove_all_params.rbs +++ b/sig/courier/models/users/tenant_remove_all_params.rbs @@ -2,15 +2,23 @@ module Courier module Models module Users type tenant_remove_all_params = - { } & Courier::Internal::Type::request_parameters + { user_id: String } & Courier::Internal::Type::request_parameters class TenantRemoveAllParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - def initialize: (?request_options: Courier::request_opts) -> void + attr_accessor user_id: String - def to_hash: -> { request_options: Courier::RequestOptions } + def initialize: ( + user_id: String, + ?request_options: Courier::request_opts + ) -> void + + def to_hash: -> { + user_id: String, + request_options: Courier::RequestOptions + } end end end diff --git a/sig/courier/models/users/tenant_remove_single_params.rbs b/sig/courier/models/users/tenant_remove_single_params.rbs index 9aa2b26e..063e9d16 100644 --- a/sig/courier/models/users/tenant_remove_single_params.rbs +++ b/sig/courier/models/users/tenant_remove_single_params.rbs @@ -2,7 +2,8 @@ module Courier module Models module Users type tenant_remove_single_params = - { user_id: String } & Courier::Internal::Type::request_parameters + { user_id: String, tenant_id: String } + & Courier::Internal::Type::request_parameters class TenantRemoveSingleParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter @@ -10,13 +11,17 @@ module Courier attr_accessor user_id: String + attr_accessor tenant_id: String + def initialize: ( user_id: String, + tenant_id: String, ?request_options: Courier::request_opts ) -> void def to_hash: -> { user_id: String, + tenant_id: String, request_options: Courier::RequestOptions } end diff --git a/sig/courier/models/users/token_add_multiple_params.rbs b/sig/courier/models/users/token_add_multiple_params.rbs index 7bc523b1..dd2a8512 100644 --- a/sig/courier/models/users/token_add_multiple_params.rbs +++ b/sig/courier/models/users/token_add_multiple_params.rbs @@ -2,15 +2,23 @@ module Courier module Models module Users type token_add_multiple_params = - { } & Courier::Internal::Type::request_parameters + { user_id: String } & Courier::Internal::Type::request_parameters class TokenAddMultipleParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - def initialize: (?request_options: Courier::request_opts) -> void + attr_accessor user_id: String - def to_hash: -> { request_options: Courier::RequestOptions } + def initialize: ( + user_id: String, + ?request_options: Courier::request_opts + ) -> void + + def to_hash: -> { + user_id: String, + request_options: Courier::RequestOptions + } end end end diff --git a/sig/courier/models/users/token_add_single_params.rbs b/sig/courier/models/users/token_add_single_params.rbs index 02fe3e16..ba9ce615 100644 --- a/sig/courier/models/users/token_add_single_params.rbs +++ b/sig/courier/models/users/token_add_single_params.rbs @@ -4,6 +4,7 @@ module Courier type token_add_single_params = { user_id: String, + token: String, provider_key: Courier::Models::Users::TokenAddSingleParams::provider_key, device: Courier::Users::TokenAddSingleParams::Device?, expiry_date: Courier::Models::Users::TokenAddSingleParams::expiry_date?, @@ -18,6 +19,8 @@ module Courier attr_accessor user_id: String + attr_accessor token: String + attr_accessor provider_key: Courier::Models::Users::TokenAddSingleParams::provider_key attr_accessor device: Courier::Users::TokenAddSingleParams::Device? @@ -32,6 +35,7 @@ module Courier def initialize: ( user_id: String, + token: String, provider_key: Courier::Models::Users::TokenAddSingleParams::provider_key, ?device: Courier::Users::TokenAddSingleParams::Device?, ?expiry_date: Courier::Models::Users::TokenAddSingleParams::expiry_date?, @@ -42,6 +46,7 @@ module Courier def to_hash: -> { user_id: String, + token: String, provider_key: Courier::Models::Users::TokenAddSingleParams::provider_key, device: Courier::Users::TokenAddSingleParams::Device?, expiry_date: Courier::Models::Users::TokenAddSingleParams::expiry_date?, diff --git a/sig/courier/models/users/token_delete_params.rbs b/sig/courier/models/users/token_delete_params.rbs index ef71b817..eb153cdd 100644 --- a/sig/courier/models/users/token_delete_params.rbs +++ b/sig/courier/models/users/token_delete_params.rbs @@ -2,7 +2,8 @@ module Courier module Models module Users type token_delete_params = - { user_id: String } & Courier::Internal::Type::request_parameters + { user_id: String, token: String } + & Courier::Internal::Type::request_parameters class TokenDeleteParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter @@ -10,13 +11,17 @@ module Courier attr_accessor user_id: String + attr_accessor token: String + def initialize: ( user_id: String, + token: String, ?request_options: Courier::request_opts ) -> void def to_hash: -> { user_id: String, + token: String, request_options: Courier::RequestOptions } end diff --git a/sig/courier/models/users/token_list_params.rbs b/sig/courier/models/users/token_list_params.rbs index d4c43542..d0253c8c 100644 --- a/sig/courier/models/users/token_list_params.rbs +++ b/sig/courier/models/users/token_list_params.rbs @@ -2,15 +2,23 @@ module Courier module Models module Users type token_list_params = - { } & Courier::Internal::Type::request_parameters + { user_id: String } & Courier::Internal::Type::request_parameters class TokenListParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter include Courier::Internal::Type::RequestParameters - def initialize: (?request_options: Courier::request_opts) -> void + attr_accessor user_id: String - def to_hash: -> { request_options: Courier::RequestOptions } + def initialize: ( + user_id: String, + ?request_options: Courier::request_opts + ) -> void + + def to_hash: -> { + user_id: String, + request_options: Courier::RequestOptions + } end end end diff --git a/sig/courier/models/users/token_retrieve_params.rbs b/sig/courier/models/users/token_retrieve_params.rbs index 1377df10..6058bd0d 100644 --- a/sig/courier/models/users/token_retrieve_params.rbs +++ b/sig/courier/models/users/token_retrieve_params.rbs @@ -2,7 +2,8 @@ module Courier module Models module Users type token_retrieve_params = - { user_id: String } & Courier::Internal::Type::request_parameters + { user_id: String, token: String } + & Courier::Internal::Type::request_parameters class TokenRetrieveParams < Courier::Internal::Type::BaseModel extend Courier::Internal::Type::RequestParameters::Converter @@ -10,13 +11,17 @@ module Courier attr_accessor user_id: String + attr_accessor token: String + def initialize: ( user_id: String, + token: String, ?request_options: Courier::request_opts ) -> void def to_hash: -> { user_id: String, + token: String, request_options: Courier::RequestOptions } end diff --git a/sig/courier/models/users/token_update_params.rbs b/sig/courier/models/users/token_update_params.rbs index 94cd0ca9..93332ebf 100644 --- a/sig/courier/models/users/token_update_params.rbs +++ b/sig/courier/models/users/token_update_params.rbs @@ -4,6 +4,7 @@ module Courier type token_update_params = { user_id: String, + token: String, patch: ::Array[Courier::Users::TokenUpdateParams::Patch] } & Courier::Internal::Type::request_parameters @@ -14,16 +15,20 @@ module Courier attr_accessor user_id: String + attr_accessor token: String + attr_accessor patch: ::Array[Courier::Users::TokenUpdateParams::Patch] def initialize: ( user_id: String, + token: String, patch: ::Array[Courier::Users::TokenUpdateParams::Patch], ?request_options: Courier::request_opts ) -> void def to_hash: -> { user_id: String, + token: String, patch: ::Array[Courier::Users::TokenUpdateParams::Patch], request_options: Courier::RequestOptions } From d4c06361e5ef4e7c0a3a1660215d63fe845694c5 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 7 Mar 2026 16:53:39 +0000 Subject: [PATCH 12/13] chore(ci): skip uploading artifacts on stainless-internal branches --- .github/workflows/ci.yml | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index d9653bed..810bd931 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -33,14 +33,18 @@ jobs: bundle install - name: Get GitHub OIDC Token - if: github.repository == 'stainless-sdks/courier-ruby' + if: |- + github.repository == 'stainless-sdks/courier-ruby' && + !startsWith(github.ref, 'refs/heads/stl/') id: github-oidc uses: actions/github-script@v8 with: script: core.setOutput('github_token', await core.getIDToken()); - name: Build and upload gem artifacts - if: github.repository == 'stainless-sdks/courier-ruby' + if: |- + github.repository == 'stainless-sdks/courier-ruby' && + !startsWith(github.ref, 'refs/heads/stl/') env: URL: https://pkg.stainless.com/s AUTH: ${{ steps.github-oidc.outputs.github_token }} From 38ba709947abbc527b45d1258bba65477f2dd313 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 7 Mar 2026 16:53:56 +0000 Subject: [PATCH 13/13] release: 4.8.0 --- .release-please-manifest.json | 2 +- CHANGELOG.md | 25 +++++++++++++++++++++++++ Gemfile.lock | 2 +- lib/courier/version.rb | 2 +- 4 files changed, 28 insertions(+), 3 deletions(-) diff --git a/.release-please-manifest.json b/.release-please-manifest.json index f1a48d37..90eeef65 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "4.7.1" + ".": "4.8.0" } \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index f93bae61..9e81f39a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,30 @@ # Changelog +## 4.8.0 (2026-03-07) + +Full Changelog: [v4.7.1...v4.8.0](https://github.com/trycourier/courier-ruby/compare/v4.7.1...v4.8.0) + +### Features + +* **api:** add provider_key/device/tracking to token params, remove body_token ([acb3031](https://github.com/trycourier/courier-ruby/commit/acb30313188a385e2ad39be4f4040e4e5836106d)) +* **api:** remove brand field from ElementalContent model ([519fcc0](https://github.com/trycourier/courier-ruby/commit/519fcc0a2f35a1fd61e64362b5a2e7b2d8225232)) + + +### Chores + +* **ci:** add build step ([d07ae3d](https://github.com/trycourier/courier-ruby/commit/d07ae3dc073f38ac30af1311f1d70153e441bf51)) +* **ci:** skip uploading artifacts on stainless-internal branches ([d4c0636](https://github.com/trycourier/courier-ruby/commit/d4c06361e5ef4e7c0a3a1660215d63fe845694c5)) +* **internal:** codegen related update ([3a0f51e](https://github.com/trycourier/courier-ruby/commit/3a0f51e6a03c33097f1307ac7974a3c5ca72ac90)) +* **internal:** codegen related update ([1cce4a8](https://github.com/trycourier/courier-ruby/commit/1cce4a8be23782aae7fb9185b8ac2efd06516842)) +* **internal:** remove mock server code ([a81351a](https://github.com/trycourier/courier-ruby/commit/a81351a2fde27b8a785a79436394a991e9048d97)) +* update mock server docs ([62d69fc](https://github.com/trycourier/courier-ruby/commit/62d69fc657babf8ff535e150d74a2283ddb64459)) + + +### Documentation + +* add AUTO-GENERATED-OVERVIEW markers for README sync ([#75](https://github.com/trycourier/courier-ruby/issues/75)) ([ab86102](https://github.com/trycourier/courier-ruby/commit/ab86102437d2af03dc45beae7262371c70b6847f)) +* sync README from mintlify-docs (2026-02-20 18:11 UTC) ([#76](https://github.com/trycourier/courier-ruby/issues/76)) ([cc67458](https://github.com/trycourier/courier-ruby/commit/cc6745816e152b890b84caaf666178bdbd9d3192)) + ## 4.7.1 (2026-02-07) Full Changelog: [v4.7.0...v4.7.1](https://github.com/trycourier/courier-ruby/compare/v4.7.0...v4.7.1) diff --git a/Gemfile.lock b/Gemfile.lock index e0b6500b..cfed93ba 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -11,7 +11,7 @@ GIT PATH remote: . specs: - trycourier (4.7.1) + trycourier (4.8.0) cgi connection_pool diff --git a/lib/courier/version.rb b/lib/courier/version.rb index 4ef2cb5e..c802e4c8 100644 --- a/lib/courier/version.rb +++ b/lib/courier/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module Courier - VERSION = "4.7.1" + VERSION = "4.8.0" end