3.1.0

What's Changed

• Remove deprecated 'im' API section and related tests by @jadolg in #348

Full Changelog: 3.0.0...3.1.0

3.0.0

What's Changed

Breaking changes

• Rework how exceptions work so they carry more information by @jadolg in #346

Now exceptions will have error data in them. Eg:

try:
    testuser = logged_rocket.users_info(username="testuser1")
except RocketApiException as e:
    if e.error == "User not found":
        testuser = logged_rocket.users_create(
            "testuser1@domain.com", "testuser1", "password", "testuser1"
        )
    else:
        raise e

or

try:
    logged_rocket.channels_leave("GENERAL")
except RocketApiException as e:
    if e.error_type == "error-you-are-last-owner":
        print("Not allowed to leave cause you are the last owner")

Also now RocketBadStatusCodeException triggers only when the API does not return valid data (maybe reverse proxy error or similar). RocketApiException is now the way to check for common API errors.

Github Actions

• Protect github actions inputs by @jadolg in #340
• Potential fix for code scanning alert no. 3: Workflow does not contain permissions by @jadolg in #341
• Potential fix for code scanning alert no. 5: Workflow does not contain permissions by @jadolg in #342
• Potential fix for code scanning alert no. 4: Workflow does not contain permissions by @jadolg in #343
• Potential fix for code scanning alert no. 7: Workflow does not contain permissions by @jadolg in #344

Full Changelog: 2.1.0...3.0.0

2.1.0

What's Changed

• Update mongodb to version 8 by @jadolg in #338
• Prepare library for rocket.chat V8 by @jadolg in #339

🚨 Breaking changes 🚨

• Removed deprecated rooms_upload method
• Updated addUserToRole and removeUserFromRole to use role_id instead of role_name
• Updated users_create_token to remove username parameter and add secret parameter which is now mandatory

Full Changelog: 2.0.1...2.1.0

2.0.1

What's Changed

• Fix pagination decorator to accept positional and keyword arguments by @jadolg in #337

Full Changelog: 2.0.0...2.0.1

2.0.0

🚨 Breaking changes 🚨

What's Changed

• Bump actions/checkout from 6.0.0 to 6.0.1 by @dependabot[bot] in #326
• Stop returning requests objects by @jadolg in #329
• Make connection pooling the default behavior by @jadolg in #331
• Remove query parameter from channels_online by @jadolg in #332
• Remove outdated information from readme by @jadolg in #333
• Return iterators for paginated endpoints by @jadolg in #327
• Remove pprint from README by @jadolg in #334
• Update test matrix by @jadolg in #335

Full Changelog: 1.37.0...2.0.0

1.37.0

What's Changed

Mostly maintenance stuff

• Update test matrix to add 7.10 and remove 7.4 by @jadolg in #315
• Bump actions/setup-python from 5 to 6 by @dependabot[bot] in #316
• Use bitnami legacy until rocketchat updates their deployment instructions by @jadolg in #317
• Update python versions by @jadolg in #318
• Update test matrix. Removed 7.5 and added 7.11 and 7.12 by @jadolg in #320
• Bump actions/checkout from 5.0.0 to 6.0.0 by @dependabot[bot] in #322
• Expose the mongodb port for local database access by @jadolg in #323
• Move testing dependencies to pyproject by @jadolg in #324

Really relevant changes

• Introduce the dm API by @jadolg in #325

The im API was renamed to dm many moons ago. They are essentially the same and work exactly the same but there's no documentation for im. In order to make it closer to the docs, I have added the dm API and plan to completely remove the im API in the future.

Full Changelog: 1.36.0...1.37.0

1.36.0

What's Changed

• Bump requests from 2.32.4 to 2.32.5 by @dependabot[bot] in #313
• Bump actions/checkout from 4.2.2 to 5.0.0 by @dependabot[bot] in #312
• Switch from using setup.py to just pyproject.toml by @jadolg in #314

Full Changelog: 1.35.2...1.36.0

1.35.2

What's Changed

• Add kwargs to im_messages to allow extra parameters by @jadolg in #311

Full Changelog: 1.35.1...1.35.2

1.35.1

What's Changed

• Remove version from docker-compose by @jadolg in #284
• Improve license detection on tests by @jadolg in #286
• Bump isbang/compose-action from 2.0.2 to 2.1.0 by @dependabot in #285
• Bump isbang/compose-action from 2.1.0 to 2.2.0 by @dependabot in #287
• Update test versions to remove 6.10 and add 7.3 by @jadolg in #288
• Add python 3.13 to the tests matrix by @jadolg in #289
• Remove "latest" from testing matrix by @jadolg in #291
• Introduce separate test action by @jadolg in #292
• Remove codecov from manual tests by @jadolg in #293
• Run tests on ubuntu-latest by @jadolg in #298
• Update packaging requirement from ~=24.2 to ~=25.0 by @dependabot in #297
• change Content-Type of login request to application/json by @paulchen in #300

New Contributors

• @paulchen made their first contribution in #300

Full Changelog: 1.35.0...1.35.1

1.35.0

What's Changed

• Update test matrix to include 7.2.0 and remove 6.9 by @jadolg in #280
• Update channels.online method by @jadolg in #282
• Add deprecation warning to licenses.get method by @jadolg in #283

Full Changelog: 1.34.0...1.35.0