Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[62378] Updated credential naming to be consistent with the API and other SDKs #159

Merged

Conversation

mrashed-dev
Copy link
Collaborator

Discussion

In the other Nylas components like the API and Dashboard, as well as the other SDKs, the credentials are referred to as client_id and client_secret however this SDK was referring to these credentials as app_id and app_secret. This causes some unnecessary confusion, and this change addresses this by switching all references of app_id and app_secret to client_id and client_secret.

Usage

If you were previously initializing APIClient by passing in the credentials as a variable assignment, you are required to update your code to reflect the new credential variable names:

client = APIClient(
        client_id="CLIENT_ID",
        client_secret="CLIENT_SECRET",
    )

If you were initializing it by just passing in the values in order like so:

client = APIClient(
        "CLIENT_ID",
        "CLIENT_SECRET",
    )

then no change is required on your part.

License

I confirm that this contribution is made under the terms of the MIT license and that I have the authority necessary to make this contribution on behalf of its copyright owner.

Transitioned from `app_id` and `app_secret` to `client_id` and `client_secret` to match the naming of what we use in the API and across all the other SDKs.
@shortcut-integration
Copy link

This pull request has been linked to Clubhouse Story #62378: Credentials naming should be consistent.

@mrashed-dev mrashed-dev linked an issue Jun 16, 2021 that may be closed by this pull request
Copy link

@lkaileh lkaileh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@mrashed-dev mrashed-dev merged commit 9a6833c into main Jun 16, 2021
@mrashed-dev mrashed-dev deleted the mostafarashed/ch62378/credentials-naming-should-be-consistent branch June 16, 2021 18:37
mrashed-dev added a commit that referenced this pull request Jul 21, 2021
New `nylas` v5.0.0 release bringing in the following additions:
* Add support for the Nylas Neural API (#163)
* Add `metadata` support (#152)
* Add new Room Resource fields  (#156)
* Add `Nylas-API-Version` header support (#157, #151)

as well as the following changes:
* Transitioned from `app_id` and `app_secret` naming to `client_id` and `client_secret` (#159, #86)
* Fix adding a tracking object to an existing `draft` (#153)
* Fix issue when converting offset-aware `datetime` objects to `timestamp` (#154, #143)
* Fix `limit` value in filter not being used when making `.all()` call (#155)
* Fix `from_` field set by attribute on draft ignored (#162, #160)
* Remove `bumpversion` from a required dependency to an extra dependency (#158, #144)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Credentials naming should be consistent
2 participants