Skip to content

Rename method #91

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Nov 1, 2023
Merged

Rename method #91

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/brown-hairs-smell.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@team-plain/typescript-sdk': minor
---

Rename `userByEmail` to `getUserByEmail` and deprecate old method.
15 changes: 15 additions & 0 deletions src/client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@ export class PlainClient {

/**
* Get a paginated list of customers.
* @deprecated "use `getUserByEmail" instead
*/
async userByEmail(
variables: VariablesOf<typeof UserByEmailDocument>
Expand All @@ -124,6 +125,20 @@ export class PlainClient {
return unwrapData(res, (q) => q.userByEmail || null);
}

/**
* Get a paginated list of customers.
*/
async getUserByEmail(
variables: VariablesOf<typeof UserByEmailDocument>
): SDKResult<UserPartsFragment | null> {
const res = await request(this.#ctx, {
query: UserByEmailDocument,
variables,
});

return unwrapData(res, (q) => q.userByEmail || null);
}

/**
* Get a paginated list of customers.
*/
Expand Down