{"id":15018949,"url":"https://github.com/klaviyo/klaviyo-api-node","last_synced_at":"2025-04-12T19:44:27.892Z","repository":{"id":61723993,"uuid":"554429103","full_name":"klaviyo/klaviyo-api-node","owner":"klaviyo","description":"Node sdk for the Klaviyo API","archived":false,"fork":false,"pushed_at":"2025-02-21T17:19:00.000Z","size":11516,"stargazers_count":66,"open_issues_count":9,"forks_count":17,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-04-11T17:11:19.483Z","etag":null,"topics":["bigcommerce","ecommerce","email","klaviyo","klaviyo-api","magento","prestashop","push-notifications","sfcc","shopify","sms","woocommerce"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/klaviyo.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-10-19T19:55:34.000Z","updated_at":"2025-03-11T10:58:49.000Z","dependencies_parsed_at":"2023-02-14T11:16:36.375Z","dependency_job_id":"687f4e6d-2920-4975-829c-3d6836986194","html_url":"https://github.com/klaviyo/klaviyo-api-node","commit_stats":{"total_commits":23,"total_committers":5,"mean_commits":4.6,"dds":"0.26086956521739135","last_synced_commit":"9a6025a1e3aa829de99141da09126b4379e1e3bf"},"previous_names":[],"tags_count":38,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaviyo%2Fklaviyo-api-node","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaviyo%2Fklaviyo-api-node/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaviyo%2Fklaviyo-api-node/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klaviyo%2Fklaviyo-api-node/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/klaviyo","download_url":"https://codeload.github.com/klaviyo/klaviyo-api-node/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248447854,"owners_count":21105195,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bigcommerce","ecommerce","email","klaviyo","klaviyo-api","magento","prestashop","push-notifications","sfcc","shopify","sms","woocommerce"],"created_at":"2024-09-24T19:52:39.485Z","updated_at":"2025-04-12T19:44:27.856Z","avatar_url":"https://github.com/klaviyo.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Klaviyo Typescript SDK\n\n- SDK version: 17.0.0\n\n- Revision: 2025-01-15\n\n## Helpful Resources\n\n- If you want to suggest code changes check out our [`CONTRIBUTING.md`](CONTRIBUTING.md) document.\n- To learn about migration from our 5.x.x version check out the [`MIGRATION.md`](MIGRATION.md) file.\n- Read version changes in [`CHANGELOG.md`](CHANGELOG.md).\n\n### Other Klaviyo Resources\n\n- [API Reference](https://developers.klaviyo.com/en/v2025-01-15/reference/)\n- [API Guides](https://developers.klaviyo.com/en/v2025-01-15/docs)\n- [Postman Workspace](https://www.postman.com/klaviyo/workspace/klaviyo-developers)\n\n## Design \u0026 Approach\n\nThis SDK is a thin wrapper around our API. See our API Reference for full documentation on API behavior.\n\nThis SDK exactly mirrors the organization and naming convention of the above language-agnostic resources, with a few namespace changes to make it fit better with Typescript\n\n## Organization\n\nThis SDK is organized into the following resources:\n\n- AccountsApi\n- CampaignsApi\n- CatalogsApi\n- CouponsApi\n- DataPrivacyApi\n- EventsApi\n- FlowsApi\n- FormsApi\n- ImagesApi\n- ListsApi\n- MetricsApi\n- ProfilesApi\n- ReportingApi\n- ReviewsApi\n- SegmentsApi\n- TagsApi\n- TemplatesApi\n- TrackingSettingsApi\n- WebhooksApi\n\n# Installation\n\n## NPM\n\nYou can install this library using `npm`.\n\n`npm install klaviyo-api@17.0.0`\n\n\n## source code\n\n*Alternatively*, you can also run this using this repo as source code, simply download this repo then connect to your app putting the path in your package.json or via `npm link`\n\npath: add this line to your apps package.json\n\n```Json\n\"klaviyo-api\": \"\u003c path to downloaded source code \u003e\"\n```\n\nnpm link:\n\nrun `npm link` in your local copy of this repo's directory\n\nrun `npm link \u003c\"path to this repo\"\u003e` first in your consuming app's directory\n\nSample file:\n\nIf you want to test out the repo but don't have a consuming app, you can run our sample typescript file, make whatever edits you want to `sample.ts` in the `sample` folder and use\n```\nnpm run sample --pk=\u003cYOUR PRIVATE KEY HERE\u003e\n```\n\n# Usage Example\n\n### To instantiate an API wrapper using an API Key\n\n```JavaScript\nimport { ApiKeySession, ProfilesApi } from 'klaviyo-api'\n\nconst session = new ApiKeySession(\"\u003c YOUR API KEY HERE \u003e\")\nconst profilesApi = new ProfilesApi(session)\n```\n\n\n### To call the `createProfile` operation:\n\n```JavaScript\nimport {\n  ApiKeySession,\n  ProfileCreateQuery,\n  ProfileEnum,\n  ProfilesApi,\n} from 'klaviyo-api'\n\nconst session = new ApiKeySession(\"\u003c YOUR API KEY HERE \u003e\")\nconst profilesApi = new ProfilesApi(session)\n\nlet profile: ProfileCreateQuery = {\n  data: {\n  type: ProfileEnum.Profile,\n  attributes: {\n    email: \"typescript_test_1@klaviyo-demo.com\"\n    }\n  }\n}\n\n\nprofilesApi.createProfile(profile).then(result =\u003e {\n  console.log(result)\n}).catch(error =\u003e {\n  console.log(error)\n});\n\n```\n\n\u003e [!IMPORTANT]\n\u003e In this SDK, properties in request and response bodies use `camelCase`, rather than `snake_case`, which is used by the API.\n\u003e For example, in the `createProfile` payload, you would supply `phoneNumber` instead of `phone_number`.\n\n### Retry Options\n\nConstructing an API object also has optional property `RetryWithExponentialBackoff`, which attempts retries on failed API calls with exponential backoff.\n\nThe default configs are:\n- retryCodes: [429, 503, 504, 524]\n- numRetries: 3\n- maxInterval: 60\n\n```Typescript\nconst retryWithExponentialBackoff: RetryWithExponentialBackoff = new RetryWithExponentialBackoff({ retryCodes: [429, 503, 504, 524], numRetries: 3, maxInterval: 60})\nconst session = new ApiKeySession(\"\u003c YOUR API KEY HERE \u003e\", retryWithExponentialBackoff)\n```\n\n### Organizational Helpers\n\nThere is also an optional `Klaviyo` import that has all the Apis and Auth, if you prefer that method for organization.\n```Typescript\nimport { Klaviyo } from 'klaviyo-api'\n\nconst profilesApi = new Klaviyo.ProfilesApi(new Klaviyo.Auth.ApiKeySession(\"\u003c YOUR API KEY HERE \u003e\", retry))\n````\n\n### Inspecting Errors\n\nFailed api calls throw an AxiosError.\n\nThe two most commonly useful error items are probably\n    - `error.response.status`\n    - `error.response.statusText`\n\nHere is an example of logging those errors to the console\n\n```Typescript\nprofilesApi.createProfile(profile).then(result =\u003e {\n  console.log(result.body)\n}).catch(error =\u003e {\n  console.log(error.response.status)\n  console.log(error.response.statusText)\n});\n```\n\n### Uploading an image by file\n\nThe `ImageApi` exposes `uploadImageFromFile()`\n\n```Typescript\nimport fs from 'fs'\nimport {ApiKeySession, ImageApi } from 'klaviyo-api'\n\nconst session = new ApiKeySession(\"\u003c YOUR API KEY HERE \u003e\")\nconst imageApi = new ImagesApi(session)\nimageApi.uploadImageFromFile(fs.createReadStream(\"./test_image.jpeg\")).then(result =\u003e {\n    console.log(result.body)\n}).catch(error =\u003e {\n  console.log(error)\n}\n```\n\n### Global Api Key\n\nIf you only connect to one Klaviyo account you may find it useful to access preconfigured objects.\n\nSet a global key, If you were using `ConfigWrapper` this also sets the GlobalApiKeySettings\n```Typescript\nimport { GlobalApiKeySettings } from 'klaviyo-api'\n\nnew GlobalApiKeySettings(\"\u003c YOUR API KEY HERE \u003e\")\n```\n\nNow you can use the shortened names `ProfilesApi` can be referenced with `Profiles`\n```Typescript\nimport { Profiles, GlobalApiKeySettings } from 'klaviyo-api'\n\nnew GlobalApiKeySettings(\"\u003c YOUR API KEY HERE \u003e\")\n\nProfiles.getProfiles().then(result =\u003e {\n  console.log(result.body)\n}).catch(error =\u003e {\n  console.log(error.response.status)\n  console.log(error.response.statusText)\n});\n```\n\n## Using OAuth to connect to multiple Klaviyo accounts.\n\nFor users creating integrations or managing multiple Klaviyo accounts, Klaviyo's OAuth authentication will make these tasks easier.\n\n### Getting started with OAuth\n\nFirst, configure an integration. If you haven't set up an integration, learn about it in this [guide](https://developers.klaviyo.com/en/v2025-01-15/docs/set_up_oauth)\n\n### Making API Calls with OAuth\nThe `klaviyo-api` package can keep your `access token` up to date. If you have already developed a system for refreshing tokens or would like a more minimalist option, skip to [OAuthBasicSession](#oauthbasicsession)\n\n#### TokenStorage\nFor the OAuthApi to be storage agnostic, this interface must be implemented for the `OAuthApi` to retrieve and save you `access` and `refresh` tokens.\nImplement the `retrieve` and `save` functions outlined in the interface. If you need help getting started, check out the `storageHelpers.ts` in the [Klaviyo Example Typescript Integration](https://github.com/klaviyo-labs/node-integration-example)\n\nYour implementation needs to include two methods:\n1. `save` is called after creating a new `access token` via the authorization flow or after refreshing the `access token`.\n    Your code needs to update (and insert if you are going to be using `createTokens()`) the new `access` or `refresh` token information into storage\n    to keep track of which of your integration users' access information you are referencing, the `customerIdentifier` is a unique value to help with lookup later.\n    ```typescript\n    save(customerIdentifier: string, tokens: CreatedTokens): Promise\u003cvoid\u003e | void\n    ```\n2. `retrieve` leverages the `customerIdentifier` to look up the saved token information and returns it for the `OAuthApi` to use\n    ```typescript\n    retrieve(customerIdentifier: string): Promise\u003cRetrievedTokens\u003e | RetrievedTokens\n    ```\n\n```typescript\nimport { TokenStorage } from 'klaviyo-api';\nclass \u003cYour Token Storage Class Name Here\u003e implements TokenStorage\n```\n\n#### OAuthApi\nThis class holds the information about your specific integration. It takes three inputs:\n1. `clientId` - This is the id of your integration. Retrieve it from your integration's settings page\n2. `clientSecret` - This is the secret for your integration. The secret is generated upon the creation of your integration.\n3. `tokenStorage` - This is an instance of your implementation of `TokenStorage` and is called automatically when creating and refreshing `access tokens`\n\n\n```typescript\nimport { OAuthApi } from 'klaviyo-api';\n\nconst oauthApi = new OAuthApi(\"\u003cclient id\u003e\", \"\u003cclient secret\u003e\", \u003cinstance of your TokenStorage implimentation\u003e)\n```\n\n#### `OAuthSession`\nTo make an API call, you need to create an `OAuthSession` instance. This session object is the OAuth equivalent of `ApiKeySession` and is used similarly.\n\nIt takes two properties\n1. `customerIdentifier` - This is how the session is going to grab a user's authentication information and let your implementation of `TokenStorage` know where to save any update `access token`\n2. `oauthApi` - This is the instance of `OAuthApi` created above. It will dictate how the session `saves` and `retrieves` the `access tokens`\n3. `retryWithExponentialBackoff` - OPTIONAL - the `RetryWithExponentialBackoff` instance outlines your desired exponential backoff configs, outlined in [Retry Options](#retry-options) above\n\n```typescript\nimport { OAuthSession, ProfilesApi } from 'klaviyo-api';\n\nconst session = new OAuthSession(customerIdentifier, oauthApi)\n\n//Pass the session into the API you want to use\nconst profileApi = new ProfilesApi(session)\n```\n\n#### `OAuthBasicSession`\nIf you don't want to deal with any of the helpers above or don't want `klaviyo-api` to refresh your tokens for you, this is the alternative.\n\nThe `OAuthBasicSession` takes up to two parameters\n1. `accessToken` - The token is used in the API calls' authentication\n3. `retryWithExponentialBackoff` - OPTIONAL - the `RetryWithExponentialBackoff` instance outlines your desired exponential backoff configs, outlined in [Retry Options](#retry-options) above\n\n```typescript\nimport { OAuthBasicSession } from 'klaviyo-api';\n\nconst session = new OAuthBasicSession(\"\u003caccess token\u003e\")\n\n//Pass the session into the API you want to use\nconst profileApi = new ProfilesApi(session)\n```\n\nRemember to check for `401` errors. A 401 means that your token is probably expired.\n\n#### `KlaviyoTokenError`\n\nIf an error occurred during an API call, check the error type with `isKlaviyoTokenError`. The name property will reflect which step the error occurred, reflecting whether it happened during creating, refreshing, saving, or retrieving the `name` tokens. The `cause` property will hold the error object of whatever specific error occurred.\n\n### Authorization Flow\n\nBuild The authorization flow in the same application as with the rest of your integrations business logic or separately.\nThere is no requirement that the authorization flow has to be backend and can be implemented entirely in a frontend application (in that case, you can ignore this section, as this repo shouldn't use this for frontend code)\n\nTo understand the authorization flow, there are two major resources to help:\n1. [OAuth authorization guide](https://developers.klaviyo.com/en/v2025-01-15/docs/set_up_oauth#1-user-installs-your-integration)\n2. [Node Integration Example](https://github.com/klaviyo-labs/node-integration-example)\n\nIf you implement your authorization flow on a node server, you can use these exposed helper functions.\n\n#### OAuthApi\n\nThe OAuthApi class also exposes helpful Authorization flow utilities.\n\n1. `generateAuthorizeUrl` - This helps correctly format the Klaviyo `/oauth/authorize` URL the application needs to redirect to so a user can approve your integration.\n   1. `state` - This is the only way to identify which user just authorized your application (or failed to). `state` is passed back via query parameter to your `redirectUrl`.\n   2. `scope` - The permissions the created `access tokens` will have. The user will be displayed these scopes during the authorization flow. For these permissions to work, also add them to your app settings in Klaviyo [here](www.klaviyo.com/oauth/client)\n   3. `codeChallenge` - This is the value generated above by the `generateCode` function.\n   4. `redirectUrl` - This is the URL that Klaviyo will redirect the user to once Authorization is completed (even if it is denied or has an error).\n   Remember to whitelist this redirect URL in your integration's settings in Klaviyo.\n   ```typescript\n    import { OAuthApi } from 'klaviyo-api'\n\n    const oauthApi = new OAuthApi(\"\u003cclient id\u003e\", \"\u003cclient secret\u003e\", \u003cTokenStorage implementation instance\u003e)\n    oauthApi.generateAuthorizeUrl(\n      state, // It's suggested to use your internal identifier for the Klaviyo account that is authorizing\n      scopes,\n      codeChallenge,\n      redirectUrl\n    )\n    ```\n2. `createTokens` - Uses Klaviyo `/oauth/token/` endpoint to create `access` and `refresh` tokens\n   1. `customerIdentifier` - This ID is NOT sent to Klaviyo's API. If the `/token` API call this method wraps is successful, the created tokens will be passed into your `save` method along with this `customerIdentifier`  in your implementation of `TokenStorage`.\n   2. `codeVerifier` - The verifier code must match the challenge code in the authorized URL redirect.\n   3. `authorizationCode`- A User approving your integration creates this temporary authorization code. Your specified redirect URL receives this under a `code` query parameter.\n   4. `redirectUrl` - The endpoint set in `generateAuthorizeUrl`. Whitelist the URL in your application settings.\n\n   ```typescript\n    import { OAuthApi } from 'klaviyo-api'\n\n    const oauthApi = new OAuthApi(\"\u003cclient id\u003e\", \"\u003cclient secret\u003e\", \u003cTokenStorage implementation instance\u003e)\n    await oauthApi.createTokens(\n      customerIdentifier,\n      codeVerifier,\n      authorizationCode,\n      redirectUrl\n    )\n   ```\n3. `OAuthCallbackQueryParams` For typescript users, this object is an interface representing the possible query parameters sent to your redirect endpoint\n\n\n\n#### Proof Key of Code Exchange (PKCE)\n\nAll the PKCE helper functions live within the `Pkce` namespace. Read about PKCE [here](https://developers.klaviyo.com/en/v2025-01-15/docs/set_up_oauth#pkce-and-code-challenges)\n\n```typescript\nimport { Pkce } from 'klaviyo-api'\n```\n\nThe `Pkce` namespace holds two different helper utilities\n1. `generateCodes` - This method will create the `codeVerifier` and `codeChallenge` needed later in the authorization flow.\n\n    ```typescript\n    import { Pkce } from 'klaviyo-api'\n\n    const pkceCodes = new Pkce.generateCodes()\n    // the two codes can be accessed by\n    const codeVerifier: string = pkceCodes.codeVerifier\n    const codeChallenge: string = pkceCodes.codeChallenge\n    ```\n\n2. `CodeStorage` - This is an OPTIONAL interface to help keep your code organized, to relate a `customerIdentifier` to their generated PKCE code\n\n    ```typescript\n    import { Pkce } from 'klaviyo-api'\n    class \u003cYour Code Storage Class Here\u003e implements Pkce.CodeStorage\n    ```\n\n## Optional Parameters and [JSON:API](https://jsonapi.org/) features\n\nHere we will go over\n\n- Pagination\n- Page size\n- Additional Fields\n- Filtering\n- Sparse Fields\n- Sorting\n- Relationships\n\n### Quick rule\n\nAs a reminder, some optional parameters are named slightly differently from how you would make the call without the SDK docs;\nthe reason for this is that some query parameter names have variables that make for bad JavaScript names.\nFor example: `page[cursor]` becomes `pageCursor`. (In short: remove the non-allowed characters and append words with camelCase).\n\n### Cursor based Pagination\n\nAll the endpoints that return a list of results use cursor-based pagination.\n\nObtain the cursor value from the call you want to get the next page for, then pass it under the `pageCursor` optional parameter. The page cursor looks like `WzE2NDA5OTUyMDAsICIzYzRjeXdGTndadyIsIHRydWVd`.\n\nAPI call:\n\n```\nhttps://a.klaviyo.com/api/profiles/?page[cursor]=WzE2NTcyMTM4NjQsICIzc042NjRyeHo0ciIsIHRydWVd\n```\n\nSDK call:\n\n```Typescript\nimport { ApiKeySession, ProfilesApi } from 'klaviyo-api'\n\nconst session = new ApiKeySession(\"\u003c YOUR API KEY HERE \u003e\")\nconst profilesApi = new ProfilesApi(session)\n\nconst profileList = await profilesApi.getProfiles({pageCursor: 'WzE2NTcyMTM4NjQsICIzc042NjRyeHo0ciIsIHRydWVd'})\n```\n\nYou get the cursor for the `next` page from `body.link.next`. This returns the entire url of the next call,\nbut the SDK will accept the entire link and use only the relevant cursor, so no need to do any parsing of the `next` link on your end\n\nHere is an example of getting the second next and passing in the page cursor:\n\n```Typescript\nimport { ApiKeySession, ProfilesApi } from 'klaviyo-api'\n\nconst session = new ApiKeySession(\"\u003c YOUR API KEY HERE \u003e\")\nconst profilesApi = new ProfilesApi(session)\n\ntry {\n    const profilesListFirstPage = await profilesApi.getProfiles()\n    const nextPage = profilesListFirstPage.body.links.next\n    const profileListSecondPage = await profilesApi.getProfiles({pageCursor: nextPage})\n    console.log(profileListSecondPage.body)\n} catch (e) {\n    console.log(e)\n}\n```\n\nThere are more page cursors than just `next`: `first`, `last`, `next` and `prev`. Check the API Reference for all the paging params for a given endpoint.\n\n### Page Size\n\nSome endpoints allow you to set the page size by using the `pageSize` parameter.\n\nAPI call:\n\n```\nhttps://a.klaviyo.com/api/profiles/?page[size]=20\n```\n\nSDK call:\n\n```typescript\nimport { ApiKeySession, ProfilesApi } from 'klaviyo-api'\n\nconst session = new ApiKeySession(\"\u003c YOUR API KEY HERE \u003e\")\nconst profilesApi = new ProfilesApi(session)\n\nconst profileList = await profilesApi.getProfiles({pageSize: 20})\n```\n\n### Additional Fields\n\nAdditional fields are used to populate parts of the response that would be `null` otherwise.\nFor example, for the `getProfile`, endpoint you can pass in a request to get the predictive analytics of the profile. Using the `additionalFields` parameter does impact the rate limit of the endpoint in cases where the related resource is subject to a lower rate limit, so be sure to keep an eye on your usage.\nAPI call:\n```\nhttps://a.klaviyo.com/api/profiles/01GDDKASAP8TKDDA2GRZDSVP4H/?additional-fields[profile]=predictive_analytics\n```\n\nSDK call:\n\n```javascript\nimport { ApiKeySession, ProfilesApi } from 'klaviyo-api'\n\nconst session = new ApiKeySession(\"\u003c YOUR API KEY HERE \u003e\")\nconst profilesApi = new ProfilesApi(session)\n\nconst profileId = '01GDDKASAP8TKDDA2GRZDSVP4H'\nconst profile = await profilesApi.getProfile(profileId, {additionalFieldsProfile: ['predictive_analytics']})\n\n// If your profile has enough information for predictive analytis it will populate\nconsole.log(profile.body.data.attributes.predictiveAnalytics)\n```\n\n#### Filtering\n\nYou can filter responses by passing a string into the optional parameter `filter`. Note that when filtering by a property it will be snake_case instead of camelCase, ie. `metric_id`\n\nRead more about formatting your filter strings in our [developer documentation](https://developers.klaviyo.com/en/v2025-01-15/docs/filtering_)\n\nHere is an example of a filter string for results between two date times: `less-than(updated,2023-04-26T00:00:00Z),greater-than(updated,2023-04-19T00:00:00Z)`\n\nHere is a code example to filter for profiles with the matching emails:\n\n```\nhttps://a.klaviyo.com/api/profiles/?filter=any(email,[\"henry.chan@klaviyo-demo.com\",\"amanda.das@klaviyo-demo.com\"]\n```\nSDK call:\n```javascript\nimport { ApiKeySession, ProfilesApi } from 'klaviyo-api'\n\nconst session = new ApiKeySession(\"\u003c YOUR API KEY HERE \u003e\")\nconst profilesApi = new ProfilesApi(session)\n\nconst filter = 'any(email,[\"henry.chan@klaviyo-demo.com\",\"amanda.das@klaviyo-demo.com\"])'\nconst profileList = await profilesApi.getProfiles({filter})\n```\n\nTo help create filters in the correct format, use the `FilterBuilder` class\n\n```typescript\nnew FilterBuilder()\n      .equals(\"email\", \"sm@klaviyo-demo.com\")\n      .build() // outputs equals(email,\"sm@klaviyo-demo.com\")\n```\n\nComplex filters can be build by adding additional filters to the builder before calling `build()`\n\n```typescript\nconst date = new Date(2023, 7, 15, 12, 30, 0);\nnew FilterBuilder()\n      .any(\"email\", [\"sarah.mason@klaviyo-demo.com\", \"sm@klaviyo-demo.com\"])\n      .greaterThan(\"created\", date)\n      .build();\n// outputs any(email,[\"sarah.mason@klaviyo-demo.com\",\"sm@klaviyo-demo.com\"]),greater-than(created,2023-08-15T16:30:00.000Z)\n```\n\n### Sparse Fields\n\nIf you only want a specific subset of data from a specific query you can use sparse fields to request only the specific properties.\nThe SDK expands the optional sparse fields into their own option, where you can pass a list of the desired items to include.\n\nTo get a list of event properties the API call you would use is:\n```\nhttps://a.klaviyo.com/api/events/?fields[event]=event_properties\n```\n\nSDK call:\n\n```javascript\nimport { ApiKeySession, EventsApi } from 'klaviyo-api'\n\nconst session = new ApiKeySession(\"\u003c YOUR API KEY HERE \u003e\")\nconst eventsApi = new EventsApi(session)\n\nconst eventsList = await eventsApi.getEvents({fieldsEvent: [\"event_properties\"]})\n```\n\n### Sorting\n\nYour can request the results of specific endpoints to be ordered by a given parameter. The direction of the sort can be reversed by adding a `-` in front of the sort key.\nFor example `datetime` will be ascending while `-datetime` will be descending.\n\nIf you are unsure about the available sort fields, refer to the API Reference page for the endpoint you are using.\nFor a comprehensive list that links to the documentation for each function check the Endpoints section [below](#endpoints).\n\n\nAPI Call to get events sorted by oldest to newest datetime:\n```\nhttps://a.klaviyo.com/api/events/?sort=-datetime\n```\nSDK call:\n\n```typescript\nimport { ApiKeySession, EventsApi } from 'klaviyo-api'\n\nconst session = new ApiKeySession(\"\u003c YOUR API KEY HERE \u003e\")\nconst eventsApi = new EventsApi(session)\n\nconst events = await eventsApi.getEvents({sort: '-datetime'})\n```\n\n### Includes\n\nYou can add additional information to your API response via additional fields and the includes parameter.\nThis allows you to get information about two or more objects from a single API call.\nUsing the includes parameter often changes the rate limit of the endpoint so be sure to take note.\n\nAPI call to get profile information and the information about the lists the profile is in:\n\n```\nhttps://a.klaviyo.com/api/profiles/01GDDKASAP8TKDDA2GRZDSVP4H/?include=lists\n```\n\nSDK call:\n\n```Typescript\nimport { ApiKeySession, ProfilesApi } from 'klaviyo-api'\n\nconst session = new ApiKeySession(\"\u003c YOUR API KEY HERE \u003e\")\nconst profilesApi = new ProfilesApi(session)\n\nconst profileId = '01GDDKASAP8TKDDA2GRZDSVP4H'\nconst profile = await profilesApi.getProfile(profileId,{include:[\"lists\"]})\n\n// Profile information is accessed the same way with\nconsole.log(profile.body.data)\n// Lists related to the profile with be accessible via the included array\nconsole.log(profile.body.included)\n```\n\n*Note about sparse fields and relationships:* you can also request only specific fields for the included object as well.\n\n```Typescript\nimport { ApiKeySession, ProfilesApi } from 'klaviyo-api'\n\nconst session = new ApiKeySession(\"\u003c YOUR API KEY HERE \u003e\")\nconst profilesApi = new ProfilesApi(session)\n\nconst profileId = '01GDDKASAP8TKDDA2GRZDSVP4H'\n// Use the fieldsLists property to request only the list name\nconst profile = await profilesApi.getProfile(profileId, {fieldsList: ['name'], include: [\"lists\"]})\n\n// Profile information is accessed the same way with\nconsole.log(profile.body.data)\n// Lists related to the profile with be accessible via the included array\nconsole.log(profile.body.included)\n```\n\n### Relationships\n\nThe Klaviyo API has a series of endpoints to expose the relationships between different Klaviyo Items. You can read more about relationships in [our documentation](https://developers.klaviyo.com/en/v2025-01-15/docs/relationships_).\n\nHere are some use cases and their examples:\n\nAPI call to get the list membership for a profile with the given profile ID:\n\n```\nhttps://a.klaviyo.com/api/profiles/01GDDKASAP8TKDDA2GRZDSVP4H/relationships/lists/\n```\n\nSDK call:\n\n```Typescript\nimport { ApiKeySession, ProfilesApi } from 'klaviyo-api'\n\nconst session = new ApiKeySession(\"\u003c YOUR API KEY HERE \u003e\")\nconst profilesApi = new ProfilesApi(session)\n\nconst profileId = '01GDDKASAP8TKDDA2GRZDSVP4H'\nconst profileRelationships = await profilesApi.getProfileRelationshipsLists(profileId)\n```\n\nFor another example:\n\nGet all campaigns associated with the given `tag_id`.\n\nAPI call:\n\n```\nhttps://a.klaviyo.com/api/tags/9c8db7a0-5ab5-4e3c-9a37-a3224fd14382/relationships/campaigns/\n```\n\nSDK call:\n\n```typescript\nimport { ApiKeySession, TagsApi } from 'klaviyo-api'\n\nconst session = new ApiKeySession(\"\u003c YOUR API KEY HERE \u003e\")\nconst tagsApi = new TagsApi(session)\n\nconst tagId = '9c8db7a0-5ab5-4e3c-9a37-a3224fd14382'\nconst relatedCampagins = tagsApi.getTagRelationshipsCampaigns(tagId)\n```\n### Combining\n\nYou can use any combination of the features outlines above in conjunction with one another.\n\nAPI call to get events associated with a specific metric, then return just the event properties sorted by oldest to newest datetime:\n\nAPI call:\n```\nhttps://a.klaviyo.com/api/events/?fields[event]=event_properties\u0026filter=equals(metric_id,\"URDbLg\")\u0026sort=-datetime\n```\nSDK call:\n```typescript\nimport { ApiKeySession, EventsApi } from 'klaviyo-api'\n\nconst session = new ApiKeySession(\"\u003c YOUR API KEY HERE \u003e\")\nconst eventsApi = new EventsApi(session)\n\nconst metricId = 'URDbLg'\nconst filter = `equal(metric_id,\"${metricId}\")`\nconst events = await eventsApi.getEvents({fieldsEvent: ['event_properties'], sort: '-datetime', filter})\n```\n\n# Endpoints\n\n## AccountsApi\n_______________________________\n\n[Get Account](https://developers.klaviyo.com/en/v2025-01-15/reference/get_account)\n\n```typescript\nAccountsApi.getAccount(id: string, options)\n```\n_______________________________\n\n[Get Accounts](https://developers.klaviyo.com/en/v2025-01-15/reference/get_accounts)\n\n```typescript\nAccountsApi.getAccounts(options)\n```\n_______________________________\n## CampaignsApi\n_______________________________\n\n[Assign Template to Campaign Message](https://developers.klaviyo.com/en/v2025-01-15/reference/assign_template_to_campaign_message)\n\n```typescript\nCampaignsApi.assignTemplateToCampaignMessage(campaignMessageAssignTemplateQuery: CampaignMessageAssignTemplateQuery)\n```\n##### Method alias:\n```typescript\nCampaignsApi.createCampaignMessageAssignTemplate(campaignMessageAssignTemplateQuery: CampaignMessageAssignTemplateQuery)\n```\n_______________________________\n\n[Cancel Campaign Send](https://developers.klaviyo.com/en/v2025-01-15/reference/cancel_campaign_send)\n\n```typescript\nCampaignsApi.cancelCampaignSend(id: string, campaignSendJobPartialUpdateQuery: CampaignSendJobPartialUpdateQuery)\n```\n##### Method alias:\n```typescript\nCampaignsApi.updateCampaignSendJob(id: string, campaignSendJobPartialUpdateQuery: CampaignSendJobPartialUpdateQuery)\n```\n_______________________________\n\n[Create Campaign](https://developers.klaviyo.com/en/v2025-01-15/reference/create_campaign)\n\n```typescript\nCampaignsApi.createCampaign(campaignCreateQuery: CampaignCreateQuery)\n```\n_______________________________\n\n[Create Campaign Clone](https://developers.klaviyo.com/en/v2025-01-15/reference/create_campaign_clone)\n\n```typescript\nCampaignsApi.createCampaignClone(campaignCloneQuery: CampaignCloneQuery)\n```\n##### Method alias:\n```typescript\nCampaignsApi.cloneCampaign(campaignCloneQuery: CampaignCloneQuery)\n```\n_______________________________\n\n[Delete Campaign](https://developers.klaviyo.com/en/v2025-01-15/reference/delete_campaign)\n\n```typescript\nCampaignsApi.deleteCampaign(id: string)\n```\n_______________________________\n\n[Get Campaign](https://developers.klaviyo.com/en/v2025-01-15/reference/get_campaign)\n\n```typescript\nCampaignsApi.getCampaign(id: string, options)\n```\n_______________________________\n\n[Get Campaign for Campaign Message](https://developers.klaviyo.com/en/v2025-01-15/reference/get_campaign_for_campaign_message)\n\n```typescript\nCampaignsApi.getCampaignForCampaignMessage(id: string, options)\n```\n##### Method alias:\n```typescript\nCampaignsApi.getCampaignMessageCampaign(id: string, options)\n```\n_______________________________\n\n[Get Campaign ID for Campaign Message](https://developers.klaviyo.com/en/v2025-01-15/reference/get_campaign_id_for_campaign_message)\n\n```typescript\nCampaignsApi.getCampaignIdForCampaignMessage(id: string)\n```\n##### Method alias:\n```typescript\nCampaignsApi.getCampaignMessageRelationshipsCampaign(id: string)\n```\n_______________________________\n\n[Get Campaign Message](https://developers.klaviyo.com/en/v2025-01-15/reference/get_campaign_message)\n\n```typescript\nCampaignsApi.getCampaignMessage(id: string, options)\n```\n_______________________________\n\n[Get Campaign Recipient Estimation](https://developers.klaviyo.com/en/v2025-01-15/reference/get_campaign_recipient_estimation)\n\n```typescript\nCampaignsApi.getCampaignRecipientEstimation(id: string, options)\n```\n_______________________________\n\n[Get Campaign Recipient Estimation Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_campaign_recipient_estimation_job)\n\n```typescript\nCampaignsApi.getCampaignRecipientEstimationJob(id: string, options)\n```\n_______________________________\n\n[Get Campaign Send Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_campaign_send_job)\n\n```typescript\nCampaignsApi.getCampaignSendJob(id: string, options)\n```\n_______________________________\n\n[Get Campaigns](https://developers.klaviyo.com/en/v2025-01-15/reference/get_campaigns)\n\n```typescript\nCampaignsApi.getCampaigns(filter: string, options)\n```\n_______________________________\n\n[Get Image for Campaign Message](https://developers.klaviyo.com/en/v2025-01-15/reference/get_image_for_campaign_message)\n\n```typescript\nCampaignsApi.getImageForCampaignMessage(id: string, options)\n```\n##### Method alias:\n```typescript\nCampaignsApi.getCampaignMessageImage(id: string, options)\n```\n_______________________________\n\n[Get Image ID for Campaign Message](https://developers.klaviyo.com/en/v2025-01-15/reference/get_image_id_for_campaign_message)\n\n```typescript\nCampaignsApi.getImageIdForCampaignMessage(id: string)\n```\n##### Method alias:\n```typescript\nCampaignsApi.getCampaignMessageRelationshipsImage(id: string)\n```\n_______________________________\n\n[Get Message IDs for Campaign](https://developers.klaviyo.com/en/v2025-01-15/reference/get_message_ids_for_campaign)\n\n```typescript\nCampaignsApi.getMessageIdsForCampaign(id: string)\n```\n##### Method alias:\n```typescript\nCampaignsApi.getCampaignRelationshipsCampaignMessages(id: string)\n```\n##### Method alias:\n```typescript\nCampaignsApi.getCampaignRelationshipsMessages(id: string)\n```\n_______________________________\n\n[Get Messages for Campaign](https://developers.klaviyo.com/en/v2025-01-15/reference/get_messages_for_campaign)\n\n```typescript\nCampaignsApi.getMessagesForCampaign(id: string, options)\n```\n##### Method alias:\n```typescript\nCampaignsApi.getCampaignCampaignMessages(id: string, options)\n```\n##### Method alias:\n```typescript\nCampaignsApi.getCampaignMessages(id: string, options)\n```\n_______________________________\n\n[Get Tag IDs for Campaign](https://developers.klaviyo.com/en/v2025-01-15/reference/get_tag_ids_for_campaign)\n\n```typescript\nCampaignsApi.getTagIdsForCampaign(id: string)\n```\n##### Method alias:\n```typescript\nCampaignsApi.getCampaignRelationshipsTags(id: string)\n```\n_______________________________\n\n[Get Tags for Campaign](https://developers.klaviyo.com/en/v2025-01-15/reference/get_tags_for_campaign)\n\n```typescript\nCampaignsApi.getTagsForCampaign(id: string, options)\n```\n##### Method alias:\n```typescript\nCampaignsApi.getCampaignTags(id: string, options)\n```\n_______________________________\n\n[Get Template for Campaign Message](https://developers.klaviyo.com/en/v2025-01-15/reference/get_template_for_campaign_message)\n\n```typescript\nCampaignsApi.getTemplateForCampaignMessage(id: string, options)\n```\n##### Method alias:\n```typescript\nCampaignsApi.getCampaignMessageTemplate(id: string, options)\n```\n_______________________________\n\n[Get Template ID for Campaign Message](https://developers.klaviyo.com/en/v2025-01-15/reference/get_template_id_for_campaign_message)\n\n```typescript\nCampaignsApi.getTemplateIdForCampaignMessage(id: string)\n```\n##### Method alias:\n```typescript\nCampaignsApi.getCampaignMessageRelationshipsTemplate(id: string)\n```\n_______________________________\n\n[Refresh Campaign Recipient Estimation](https://developers.klaviyo.com/en/v2025-01-15/reference/refresh_campaign_recipient_estimation)\n\n```typescript\nCampaignsApi.refreshCampaignRecipientEstimation(campaignRecipientEstimationJobCreateQuery: CampaignRecipientEstimationJobCreateQuery)\n```\n##### Method alias:\n```typescript\nCampaignsApi.createCampaignRecipientEstimationJob(campaignRecipientEstimationJobCreateQuery: CampaignRecipientEstimationJobCreateQuery)\n```\n_______________________________\n\n[Send Campaign](https://developers.klaviyo.com/en/v2025-01-15/reference/send_campaign)\n\n```typescript\nCampaignsApi.sendCampaign(campaignSendJobCreateQuery: CampaignSendJobCreateQuery)\n```\n##### Method alias:\n```typescript\nCampaignsApi.createCampaignSendJob(campaignSendJobCreateQuery: CampaignSendJobCreateQuery)\n```\n_______________________________\n\n[Update Campaign](https://developers.klaviyo.com/en/v2025-01-15/reference/update_campaign)\n\n```typescript\nCampaignsApi.updateCampaign(id: string, campaignPartialUpdateQuery: CampaignPartialUpdateQuery)\n```\n_______________________________\n\n[Update Campaign Message](https://developers.klaviyo.com/en/v2025-01-15/reference/update_campaign_message)\n\n```typescript\nCampaignsApi.updateCampaignMessage(id: string, campaignMessagePartialUpdateQuery: CampaignMessagePartialUpdateQuery)\n```\n_______________________________\n\n[Update Image for Campaign Message](https://developers.klaviyo.com/en/v2025-01-15/reference/update_image_for_campaign_message)\n\n```typescript\nCampaignsApi.updateImageForCampaignMessage(id: string, campaignMessageImageUpdateQuery: CampaignMessageImageUpdateQuery)\n```\n##### Method alias:\n```typescript\nCampaignsApi.updateCampaignMessageRelationshipsImage(id: string, campaignMessageImageUpdateQuery: CampaignMessageImageUpdateQuery)\n```\n_______________________________\n## CatalogsApi\n_______________________________\n\n[Add Categories to Catalog Item](https://developers.klaviyo.com/en/v2025-01-15/reference/add_categories_to_catalog_item)\n\n```typescript\nCatalogsApi.addCategoriesToCatalogItem(id: string, catalogItemCategoryOp: CatalogItemCategoryOp)\n```\n##### Method alias:\n```typescript\nCatalogsApi.addCategoryToCatalogItem(id: string, catalogItemCategoryOp: CatalogItemCategoryOp)\n```\n##### Method alias:\n```typescript\nCatalogsApi.createCatalogItemRelationshipsCategory(id: string, catalogItemCategoryOp: CatalogItemCategoryOp)\n```\n##### Method alias:\n```typescript\nCatalogsApi.createCatalogItemRelationshipsCategories(id: string, catalogItemCategoryOp: CatalogItemCategoryOp)\n```\n_______________________________\n\n[Add Items to Catalog Category](https://developers.klaviyo.com/en/v2025-01-15/reference/add_items_to_catalog_category)\n\n```typescript\nCatalogsApi.addItemsToCatalogCategory(id: string, catalogCategoryItemOp: CatalogCategoryItemOp)\n```\n##### Method alias:\n```typescript\nCatalogsApi.createCatalogCategoryRelationshipsItem(id: string, catalogCategoryItemOp: CatalogCategoryItemOp)\n```\n##### Method alias:\n```typescript\nCatalogsApi.createCatalogCategoryRelationshipsItems(id: string, catalogCategoryItemOp: CatalogCategoryItemOp)\n```\n_______________________________\n\n[Bulk Create Catalog Categories](https://developers.klaviyo.com/en/v2025-01-15/reference/bulk_create_catalog_categories)\n\n```typescript\nCatalogsApi.bulkCreateCatalogCategories(catalogCategoryCreateJobCreateQuery: CatalogCategoryCreateJobCreateQuery)\n```\n##### Method alias:\n```typescript\nCatalogsApi.spawnCreateCategoriesJob(catalogCategoryCreateJobCreateQuery: CatalogCategoryCreateJobCreateQuery)\n```\n##### Method alias:\n```typescript\nCatalogsApi.createCatalogCategoryBulkCreateJob(catalogCategoryCreateJobCreateQuery: CatalogCategoryCreateJobCreateQuery)\n```\n_______________________________\n\n[Bulk Create Catalog Items](https://developers.klaviyo.com/en/v2025-01-15/reference/bulk_create_catalog_items)\n\n```typescript\nCatalogsApi.bulkCreateCatalogItems(catalogItemCreateJobCreateQuery: CatalogItemCreateJobCreateQuery)\n```\n##### Method alias:\n```typescript\nCatalogsApi.spawnCreateItemsJob(catalogItemCreateJobCreateQuery: CatalogItemCreateJobCreateQuery)\n```\n##### Method alias:\n```typescript\nCatalogsApi.createCatalogItemBulkCreateJob(catalogItemCreateJobCreateQuery: CatalogItemCreateJobCreateQuery)\n```\n_______________________________\n\n[Bulk Create Catalog Variants](https://developers.klaviyo.com/en/v2025-01-15/reference/bulk_create_catalog_variants)\n\n```typescript\nCatalogsApi.bulkCreateCatalogVariants(catalogVariantCreateJobCreateQuery: CatalogVariantCreateJobCreateQuery)\n```\n##### Method alias:\n```typescript\nCatalogsApi.spawnCreateVariantsJob(catalogVariantCreateJobCreateQuery: CatalogVariantCreateJobCreateQuery)\n```\n##### Method alias:\n```typescript\nCatalogsApi.createCatalogVariantBulkCreateJob(catalogVariantCreateJobCreateQuery: CatalogVariantCreateJobCreateQuery)\n```\n_______________________________\n\n[Bulk Delete Catalog Categories](https://developers.klaviyo.com/en/v2025-01-15/reference/bulk_delete_catalog_categories)\n\n```typescript\nCatalogsApi.bulkDeleteCatalogCategories(catalogCategoryDeleteJobCreateQuery: CatalogCategoryDeleteJobCreateQuery)\n```\n##### Method alias:\n```typescript\nCatalogsApi.spawnDeleteCategoriesJob(catalogCategoryDeleteJobCreateQuery: CatalogCategoryDeleteJobCreateQuery)\n```\n##### Method alias:\n```typescript\nCatalogsApi.createCatalogCategoryBulkDeleteJob(catalogCategoryDeleteJobCreateQuery: CatalogCategoryDeleteJobCreateQuery)\n```\n_______________________________\n\n[Bulk Delete Catalog Items](https://developers.klaviyo.com/en/v2025-01-15/reference/bulk_delete_catalog_items)\n\n```typescript\nCatalogsApi.bulkDeleteCatalogItems(catalogItemDeleteJobCreateQuery: CatalogItemDeleteJobCreateQuery)\n```\n##### Method alias:\n```typescript\nCatalogsApi.spawnDeleteItemsJob(catalogItemDeleteJobCreateQuery: CatalogItemDeleteJobCreateQuery)\n```\n##### Method alias:\n```typescript\nCatalogsApi.createCatalogItemBulkDeleteJob(catalogItemDeleteJobCreateQuery: CatalogItemDeleteJobCreateQuery)\n```\n_______________________________\n\n[Bulk Delete Catalog Variants](https://developers.klaviyo.com/en/v2025-01-15/reference/bulk_delete_catalog_variants)\n\n```typescript\nCatalogsApi.bulkDeleteCatalogVariants(catalogVariantDeleteJobCreateQuery: CatalogVariantDeleteJobCreateQuery)\n```\n##### Method alias:\n```typescript\nCatalogsApi.spawnDeleteVariantsJob(catalogVariantDeleteJobCreateQuery: CatalogVariantDeleteJobCreateQuery)\n```\n##### Method alias:\n```typescript\nCatalogsApi.createCatalogVariantBulkDeleteJob(catalogVariantDeleteJobCreateQuery: CatalogVariantDeleteJobCreateQuery)\n```\n_______________________________\n\n[Bulk Update Catalog Categories](https://developers.klaviyo.com/en/v2025-01-15/reference/bulk_update_catalog_categories)\n\n```typescript\nCatalogsApi.bulkUpdateCatalogCategories(catalogCategoryUpdateJobCreateQuery: CatalogCategoryUpdateJobCreateQuery)\n```\n##### Method alias:\n```typescript\nCatalogsApi.spawnUpdateCategoriesJob(catalogCategoryUpdateJobCreateQuery: CatalogCategoryUpdateJobCreateQuery)\n```\n##### Method alias:\n```typescript\nCatalogsApi.createCatalogCategoryBulkUpdateJob(catalogCategoryUpdateJobCreateQuery: CatalogCategoryUpdateJobCreateQuery)\n```\n_______________________________\n\n[Bulk Update Catalog Items](https://developers.klaviyo.com/en/v2025-01-15/reference/bulk_update_catalog_items)\n\n```typescript\nCatalogsApi.bulkUpdateCatalogItems(catalogItemUpdateJobCreateQuery: CatalogItemUpdateJobCreateQuery)\n```\n##### Method alias:\n```typescript\nCatalogsApi.spawnUpdateItemsJob(catalogItemUpdateJobCreateQuery: CatalogItemUpdateJobCreateQuery)\n```\n##### Method alias:\n```typescript\nCatalogsApi.createCatalogItemBulkUpdateJob(catalogItemUpdateJobCreateQuery: CatalogItemUpdateJobCreateQuery)\n```\n_______________________________\n\n[Bulk Update Catalog Variants](https://developers.klaviyo.com/en/v2025-01-15/reference/bulk_update_catalog_variants)\n\n```typescript\nCatalogsApi.bulkUpdateCatalogVariants(catalogVariantUpdateJobCreateQuery: CatalogVariantUpdateJobCreateQuery)\n```\n##### Method alias:\n```typescript\nCatalogsApi.spawnUpdateVariantsJob(catalogVariantUpdateJobCreateQuery: CatalogVariantUpdateJobCreateQuery)\n```\n##### Method alias:\n```typescript\nCatalogsApi.createCatalogVariantBulkUpdateJob(catalogVariantUpdateJobCreateQuery: CatalogVariantUpdateJobCreateQuery)\n```\n_______________________________\n\n[Create Back In Stock Subscription](https://developers.klaviyo.com/en/v2025-01-15/reference/create_back_in_stock_subscription)\n\n```typescript\nCatalogsApi.createBackInStockSubscription(serverBISSubscriptionCreateQuery: ServerBISSubscriptionCreateQuery)\n```\n_______________________________\n\n[Create Catalog Category](https://developers.klaviyo.com/en/v2025-01-15/reference/create_catalog_category)\n\n```typescript\nCatalogsApi.createCatalogCategory(catalogCategoryCreateQuery: CatalogCategoryCreateQuery)\n```\n_______________________________\n\n[Create Catalog Item](https://developers.klaviyo.com/en/v2025-01-15/reference/create_catalog_item)\n\n```typescript\nCatalogsApi.createCatalogItem(catalogItemCreateQuery: CatalogItemCreateQuery)\n```\n_______________________________\n\n[Create Catalog Variant](https://developers.klaviyo.com/en/v2025-01-15/reference/create_catalog_variant)\n\n```typescript\nCatalogsApi.createCatalogVariant(catalogVariantCreateQuery: CatalogVariantCreateQuery)\n```\n_______________________________\n\n[Delete Catalog Category](https://developers.klaviyo.com/en/v2025-01-15/reference/delete_catalog_category)\n\n```typescript\nCatalogsApi.deleteCatalogCategory(id: string)\n```\n_______________________________\n\n[Delete Catalog Item](https://developers.klaviyo.com/en/v2025-01-15/reference/delete_catalog_item)\n\n```typescript\nCatalogsApi.deleteCatalogItem(id: string)\n```\n_______________________________\n\n[Delete Catalog Variant](https://developers.klaviyo.com/en/v2025-01-15/reference/delete_catalog_variant)\n\n```typescript\nCatalogsApi.deleteCatalogVariant(id: string)\n```\n_______________________________\n\n[Get Bulk Create Catalog Items Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_create_catalog_items_job)\n\n```typescript\nCatalogsApi.getBulkCreateCatalogItemsJob(jobId: string, options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getCreateItemsJob(jobId: string, options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getCatalogItemBulkCreateJob(jobId: string, options)\n```\n_______________________________\n\n[Get Bulk Create Catalog Items Jobs](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_create_catalog_items_jobs)\n\n```typescript\nCatalogsApi.getBulkCreateCatalogItemsJobs(options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getCreateItemsJobs(options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getCatalogItemBulkCreateJobs(options)\n```\n_______________________________\n\n[Get Bulk Create Categories Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_create_categories_job)\n\n```typescript\nCatalogsApi.getBulkCreateCategoriesJob(jobId: string, options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getCreateCategoriesJob(jobId: string, options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getCatalogCategoryBulkCreateJob(jobId: string, options)\n```\n_______________________________\n\n[Get Bulk Create Categories Jobs](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_create_categories_jobs)\n\n```typescript\nCatalogsApi.getBulkCreateCategoriesJobs(options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getCreateCategoriesJobs(options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getCatalogCategoryBulkCreateJobs(options)\n```\n_______________________________\n\n[Get Bulk Create Variants Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_create_variants_job)\n\n```typescript\nCatalogsApi.getBulkCreateVariantsJob(jobId: string, options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getCreateVariantsJob(jobId: string, options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getCatalogVariantBulkCreateJob(jobId: string, options)\n```\n_______________________________\n\n[Get Bulk Create Variants Jobs](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_create_variants_jobs)\n\n```typescript\nCatalogsApi.getBulkCreateVariantsJobs(options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getCreateVariantsJobs(options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getCatalogVariantBulkCreateJobs(options)\n```\n_______________________________\n\n[Get Bulk Delete Catalog Items Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_delete_catalog_items_job)\n\n```typescript\nCatalogsApi.getBulkDeleteCatalogItemsJob(jobId: string, options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getDeleteItemsJob(jobId: string, options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getCatalogItemBulkDeleteJob(jobId: string, options)\n```\n_______________________________\n\n[Get Bulk Delete Catalog Items Jobs](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_delete_catalog_items_jobs)\n\n```typescript\nCatalogsApi.getBulkDeleteCatalogItemsJobs(options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getDeleteItemsJobs(options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getCatalogItemBulkDeleteJobs(options)\n```\n_______________________________\n\n[Get Bulk Delete Categories Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_delete_categories_job)\n\n```typescript\nCatalogsApi.getBulkDeleteCategoriesJob(jobId: string, options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getDeleteCategoriesJob(jobId: string, options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getCatalogCategoryBulkDeleteJob(jobId: string, options)\n```\n_______________________________\n\n[Get Bulk Delete Categories Jobs](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_delete_categories_jobs)\n\n```typescript\nCatalogsApi.getBulkDeleteCategoriesJobs(options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getDeleteCategoriesJobs(options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getCatalogCategoryBulkDeleteJobs(options)\n```\n_______________________________\n\n[Get Bulk Delete Variants Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_delete_variants_job)\n\n```typescript\nCatalogsApi.getBulkDeleteVariantsJob(jobId: string, options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getDeleteVariantsJob(jobId: string, options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getCatalogVariantBulkDeleteJob(jobId: string, options)\n```\n_______________________________\n\n[Get Bulk Delete Variants Jobs](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_delete_variants_jobs)\n\n```typescript\nCatalogsApi.getBulkDeleteVariantsJobs(options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getDeleteVariantsJobs(options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getCatalogVariantBulkDeleteJobs(options)\n```\n_______________________________\n\n[Get Bulk Update Catalog Items Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_update_catalog_items_job)\n\n```typescript\nCatalogsApi.getBulkUpdateCatalogItemsJob(jobId: string, options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getUpdateItemsJob(jobId: string, options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getCatalogItemBulkUpdateJob(jobId: string, options)\n```\n_______________________________\n\n[Get Bulk Update Catalog Items Jobs](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_update_catalog_items_jobs)\n\n```typescript\nCatalogsApi.getBulkUpdateCatalogItemsJobs(options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getUpdateItemsJobs(options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getCatalogItemBulkUpdateJobs(options)\n```\n_______________________________\n\n[Get Bulk Update Categories Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_update_categories_job)\n\n```typescript\nCatalogsApi.getBulkUpdateCategoriesJob(jobId: string, options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getUpdateCategoriesJob(jobId: string, options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getCatalogCategoryBulkUpdateJob(jobId: string, options)\n```\n_______________________________\n\n[Get Bulk Update Categories Jobs](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_update_categories_jobs)\n\n```typescript\nCatalogsApi.getBulkUpdateCategoriesJobs(options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getUpdateCategoriesJobs(options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getCatalogCategoryBulkUpdateJobs(options)\n```\n_______________________________\n\n[Get Bulk Update Variants Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_update_variants_job)\n\n```typescript\nCatalogsApi.getBulkUpdateVariantsJob(jobId: string, options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getUpdateVariantsJob(jobId: string, options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getCatalogVariantBulkUpdateJob(jobId: string, options)\n```\n_______________________________\n\n[Get Bulk Update Variants Jobs](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_update_variants_jobs)\n\n```typescript\nCatalogsApi.getBulkUpdateVariantsJobs(options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getUpdateVariantsJobs(options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getCatalogVariantBulkUpdateJobs(options)\n```\n_______________________________\n\n[Get Catalog Categories](https://developers.klaviyo.com/en/v2025-01-15/reference/get_catalog_categories)\n\n```typescript\nCatalogsApi.getCatalogCategories(options)\n```\n_______________________________\n\n[Get Catalog Category](https://developers.klaviyo.com/en/v2025-01-15/reference/get_catalog_category)\n\n```typescript\nCatalogsApi.getCatalogCategory(id: string, options)\n```\n_______________________________\n\n[Get Catalog Item](https://developers.klaviyo.com/en/v2025-01-15/reference/get_catalog_item)\n\n```typescript\nCatalogsApi.getCatalogItem(id: string, options)\n```\n_______________________________\n\n[Get Catalog Items](https://developers.klaviyo.com/en/v2025-01-15/reference/get_catalog_items)\n\n```typescript\nCatalogsApi.getCatalogItems(options)\n```\n_______________________________\n\n[Get Catalog Variant](https://developers.klaviyo.com/en/v2025-01-15/reference/get_catalog_variant)\n\n```typescript\nCatalogsApi.getCatalogVariant(id: string, options)\n```\n_______________________________\n\n[Get Catalog Variants](https://developers.klaviyo.com/en/v2025-01-15/reference/get_catalog_variants)\n\n```typescript\nCatalogsApi.getCatalogVariants(options)\n```\n_______________________________\n\n[Get Categories for Catalog Item](https://developers.klaviyo.com/en/v2025-01-15/reference/get_categories_for_catalog_item)\n\n```typescript\nCatalogsApi.getCategoriesForCatalogItem(id: string, options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getCatalogItemCategories(id: string, options)\n```\n_______________________________\n\n[Get Category IDs for Catalog Item](https://developers.klaviyo.com/en/v2025-01-15/reference/get_category_ids_for_catalog_item)\n\n```typescript\nCatalogsApi.getCategoryIdsForCatalogItem(id: string, options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getCatalogItemRelationshipsCategories(id: string, options)\n```\n_______________________________\n\n[Get Item IDs for Catalog Category](https://developers.klaviyo.com/en/v2025-01-15/reference/get_item_ids_for_catalog_category)\n\n```typescript\nCatalogsApi.getItemIdsForCatalogCategory(id: string, options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getCatalogCategoryRelationshipsItems(id: string, options)\n```\n_______________________________\n\n[Get Items for Catalog Category](https://developers.klaviyo.com/en/v2025-01-15/reference/get_items_for_catalog_category)\n\n```typescript\nCatalogsApi.getItemsForCatalogCategory(id: string, options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getCatalogCategoryItems(id: string, options)\n```\n_______________________________\n\n[Get Variant IDs for Catalog Item](https://developers.klaviyo.com/en/v2025-01-15/reference/get_variant_ids_for_catalog_item)\n\n```typescript\nCatalogsApi.getVariantIdsForCatalogItem(id: string, options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getCatalogItemRelationshipsVariants(id: string, options)\n```\n_______________________________\n\n[Get Variants for Catalog Item](https://developers.klaviyo.com/en/v2025-01-15/reference/get_variants_for_catalog_item)\n\n```typescript\nCatalogsApi.getVariantsForCatalogItem(id: string, options)\n```\n##### Method alias:\n```typescript\nCatalogsApi.getCatalogItemVariants(id: string, options)\n```\n_______________________________\n\n[Remove Categories from Catalog Item](https://developers.klaviyo.com/en/v2025-01-15/reference/remove_categories_from_catalog_item)\n\n```typescript\nCatalogsApi.removeCategoriesFromCatalogItem(id: string, catalogItemCategoryOp: CatalogItemCategoryOp)\n```\n##### Method alias:\n```typescript\nCatalogsApi.deleteCatalogItemRelationshipsCategories(id: string, catalogItemCategoryOp: CatalogItemCategoryOp)\n```\n_______________________________\n\n[Remove Items from Catalog Category](https://developers.klaviyo.com/en/v2025-01-15/reference/remove_items_from_catalog_category)\n\n```typescript\nCatalogsApi.removeItemsFromCatalogCategory(id: string, catalogCategoryItemOp: CatalogCategoryItemOp)\n```\n##### Method alias:\n```typescript\nCatalogsApi.deleteCatalogCategoryRelationshipsItems(id: string, catalogCategoryItemOp: CatalogCategoryItemOp)\n```\n_______________________________\n\n[Update Catalog Category](https://developers.klaviyo.com/en/v2025-01-15/reference/update_catalog_category)\n\n```typescript\nCatalogsApi.updateCatalogCategory(id: string, catalogCategoryUpdateQuery: CatalogCategoryUpdateQuery)\n```\n_______________________________\n\n[Update Catalog Item](https://developers.klaviyo.com/en/v2025-01-15/reference/update_catalog_item)\n\n```typescript\nCatalogsApi.updateCatalogItem(id: string, catalogItemUpdateQuery: CatalogItemUpdateQuery)\n```\n_______________________________\n\n[Update Catalog Variant](https://developers.klaviyo.com/en/v2025-01-15/reference/update_catalog_variant)\n\n```typescript\nCatalogsApi.updateCatalogVariant(id: string, catalogVariantUpdateQuery: CatalogVariantUpdateQuery)\n```\n_______________________________\n\n[Update Categories for Catalog Item](https://developers.klaviyo.com/en/v2025-01-15/reference/update_categories_for_catalog_item)\n\n```typescript\nCatalogsApi.updateCategoriesForCatalogItem(id: string, catalogItemCategoryOp: CatalogItemCategoryOp)\n```\n##### Method alias:\n```typescript\nCatalogsApi.updateCatalogItemRelationshipsCategories(id: string, catalogItemCategoryOp: CatalogItemCategoryOp)\n```\n_______________________________\n\n[Update Items for Catalog Category](https://developers.klaviyo.com/en/v2025-01-15/reference/update_items_for_catalog_category)\n\n```typescript\nCatalogsApi.updateItemsForCatalogCategory(id: string, catalogCategoryItemOp: CatalogCategoryItemOp)\n```\n##### Method alias:\n```typescript\nCatalogsApi.updateCatalogCategoryRelationshipsItems(id: string, catalogCategoryItemOp: CatalogCategoryItemOp)\n```\n_______________________________\n## CouponsApi\n_______________________________\n\n[Bulk Create Coupon Codes](https://developers.klaviyo.com/en/v2025-01-15/reference/bulk_create_coupon_codes)\n\n```typescript\nCouponsApi.bulkCreateCouponCodes(couponCodeCreateJobCreateQuery: CouponCodeCreateJobCreateQuery)\n```\n##### Method alias:\n```typescript\nCouponsApi.spawnCouponCodeBulkCreateJob(couponCodeCreateJobCreateQuery: CouponCodeCreateJobCreateQuery)\n```\n##### Method alias:\n```typescript\nCouponsApi.createCouponCodeBulkCreateJob(couponCodeCreateJobCreateQuery: CouponCodeCreateJobCreateQuery)\n```\n_______________________________\n\n[Create Coupon](https://developers.klaviyo.com/en/v2025-01-15/reference/create_coupon)\n\n```typescript\nCouponsApi.createCoupon(couponCreateQuery: CouponCreateQuery)\n```\n_______________________________\n\n[Create Coupon Code](https://developers.klaviyo.com/en/v2025-01-15/reference/create_coupon_code)\n\n```typescript\nCouponsApi.createCouponCode(couponCodeCreateQuery: CouponCodeCreateQuery)\n```\n_______________________________\n\n[Delete Coupon](https://developers.klaviyo.com/en/v2025-01-15/reference/delete_coupon)\n\n```typescript\nCouponsApi.deleteCoupon(id: string)\n```\n_______________________________\n\n[Delete Coupon Code](https://developers.klaviyo.com/en/v2025-01-15/reference/delete_coupon_code)\n\n```typescript\nCouponsApi.deleteCouponCode(id: string)\n```\n_______________________________\n\n[Get Bulk Create Coupon Code Jobs](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_create_coupon_code_jobs)\n\n```typescript\nCouponsApi.getBulkCreateCouponCodeJobs(options)\n```\n##### Method alias:\n```typescript\nCouponsApi.getCouponCodeBulkCreateJobs(options)\n```\n_______________________________\n\n[Get Bulk Create Coupon Codes Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_create_coupon_codes_job)\n\n```typescript\nCouponsApi.getBulkCreateCouponCodesJob(jobId: string, options)\n```\n##### Method alias:\n```typescript\nCouponsApi.getCouponCodeBulkCreateJob(jobId: string, options)\n```\n_______________________________\n\n[Get Coupon](https://developers.klaviyo.com/en/v2025-01-15/reference/get_coupon)\n\n```typescript\nCouponsApi.getCoupon(id: string, options)\n```\n_______________________________\n\n[Get Coupon Code](https://developers.klaviyo.com/en/v2025-01-15/reference/get_coupon_code)\n\n```typescript\nCouponsApi.getCouponCode(id: string, options)\n```\n_______________________________\n\n[Get Coupon Code IDs for Coupon](https://developers.klaviyo.com/en/v2025-01-15/reference/get_coupon_code_ids_for_coupon)\n\n```typescript\nCouponsApi.getCouponCodeIdsForCoupon(id: string, options)\n```\n##### Method alias:\n```typescript\nCouponsApi.getCouponCodeRelationshipsCoupon(id: string, options)\n```\n##### Method alias:\n```typescript\nCouponsApi.getCodeIdsForCoupon(id: string, options)\n```\n##### Method alias:\n```typescript\nCouponsApi.getCouponRelationshipsCodes(id: string, options)\n```\n_______________________________\n\n[Get Coupon Codes](https://developers.klaviyo.com/en/v2025-01-15/reference/get_coupon_codes)\n\n```typescript\nCouponsApi.getCouponCodes(filter: string, options)\n```\n_______________________________\n\n[Get Coupon Codes for Coupon](https://developers.klaviyo.com/en/v2025-01-15/reference/get_coupon_codes_for_coupon)\n\n```typescript\nCouponsApi.getCouponCodesForCoupon(id: string, options)\n```\n##### Method alias:\n```typescript\nCouponsApi.getCouponCouponCodes(id: string, options)\n```\n##### Method alias:\n```typescript\nCouponsApi.getCodesForCoupon(id: string, options)\n```\n_______________________________\n\n[Get Coupon For Coupon Code](https://developers.klaviyo.com/en/v2025-01-15/reference/get_coupon_for_coupon_code)\n\n```typescript\nCouponsApi.getCouponForCouponCode(id: string, options)\n```\n##### Method alias:\n```typescript\nCouponsApi.getCouponCodeCoupon(id: string, options)\n```\n_______________________________\n\n[Get Coupon ID for Coupon Code](https://developers.klaviyo.com/en/v2025-01-15/reference/get_coupon_id_for_coupon_code)\n\n```typescript\nCouponsApi.getCouponIdForCouponCode(id: string)\n```\n##### Method alias:\n```typescript\nCouponsApi.getCouponRelationshipsCouponCodes(id: string)\n```\n_______________________________\n\n[Get Coupons](https://developers.klaviyo.com/en/v2025-01-15/reference/get_coupons)\n\n```typescript\nCouponsApi.getCoupons(options)\n```\n_______________________________\n\n[Update Coupon](https://developers.klaviyo.com/en/v2025-01-15/reference/update_coupon)\n\n```typescript\nCouponsApi.updateCoupon(id: string, couponUpdateQuery: CouponUpdateQuery)\n```\n_______________________________\n\n[Update Coupon Code](https://developers.klaviyo.com/en/v2025-01-15/reference/update_coupon_code)\n\n```typescript\nCouponsApi.updateCouponCode(id: string, couponCodeUpdateQuery: CouponCodeUpdateQuery)\n```\n_______________________________\n## DataPrivacyApi\n_______________________________\n\n[Request Profile Deletion](https://developers.klaviyo.com/en/v2025-01-15/reference/request_profile_deletion)\n\n```typescript\nDataPrivacyApi.requestProfileDeletion(dataPrivacyCreateDeletionJobQuery: DataPrivacyCreateDeletionJobQuery)\n```\n##### Method alias:\n```typescript\nDataPrivacyApi.createDataPrivacyDeletionJob(dataPrivacyCreateDeletionJobQuery: DataPrivacyCreateDeletionJobQuery)\n```\n_______________________________\n## EventsApi\n_______________________________\n\n[Bulk Create Events](https://developers.klaviyo.com/en/v2025-01-15/reference/bulk_create_events)\n\n```typescript\nEventsApi.bulkCreateEvents(eventsBulkCreateJob: EventsBulkCreateJob)\n```\n##### Method alias:\n```typescript\nEventsApi.createEventBulkCreateJob(eventsBulkCreateJob: EventsBulkCreateJob)\n```\n_______________________________\n\n[Create Event](https://developers.klaviyo.com/en/v2025-01-15/reference/create_event)\n\n```typescript\nEventsApi.createEvent(eventCreateQueryV2: EventCreateQueryV2)\n```\n_______________________________\n\n[Get Event](https://developers.klaviyo.com/en/v2025-01-15/reference/get_event)\n\n```typescript\nEventsApi.getEvent(id: string, options)\n```\n_______________________________\n\n[Get Events](https://developers.klaviyo.com/en/v2025-01-15/reference/get_events)\n\n```typescript\nEventsApi.getEvents(options)\n```\n_______________________________\n\n[Get Metric for Event](https://developers.klaviyo.com/en/v2025-01-15/reference/get_metric_for_event)\n\n```typescript\nEventsApi.getMetricForEvent(id: string, options)\n```\n##### Method alias:\n```typescript\nEventsApi.getEventMetric(id: string, options)\n```\n_______________________________\n\n[Get Metric ID for Event](https://developers.klaviyo.com/en/v2025-01-15/reference/get_metric_id_for_event)\n\n```typescript\nEventsApi.getMetricIdForEvent(id: string)\n```\n##### Method alias:\n```typescript\nEventsApi.getEventRelationshipsMetric(id: string)\n```\n_______________________________\n\n[Get Profile for Event](https://developers.klaviyo.com/en/v2025-01-15/reference/get_profile_for_event)\n\n```typescript\nEventsApi.getProfileForEvent(id: string, options)\n```\n##### Method alias:\n```typescript\nEventsApi.getEventProfile(id: string, options)\n```\n_______________________________\n\n[Get Profile ID for Event](https://developers.klaviyo.com/en/v2025-01-15/reference/get_profile_id_for_event)\n\n```typescript\nEventsApi.getProfileIdForEvent(id: string)\n```\n##### Method alias:\n```typescript\nEventsApi.getEventRelationshipsProfile(id: string)\n```\n_______________________________\n## FlowsApi\n_______________________________\n\n[Create Flow](https://developers.klaviyo.com/en/v2025-01-15/reference/create_flow)\n\n```typescript\nFlowsApi.createFlow(flowCreateQuery: FlowCreateQuery, options)\n```\n_______________________________\n\n[Delete Flow](https://developers.klaviyo.com/en/v2025-01-15/reference/delete_flow)\n\n```typescript\nFlowsApi.deleteFlow(id: string)\n```\n_______________________________\n\n[Get Action for Flow Message](https://developers.klaviyo.com/en/v2025-01-15/reference/get_action_for_flow_message)\n\n```typescript\nFlowsApi.getActionForFlowMessage(id: string, options)\n```\n##### Method alias:\n```typescript\nFlowsApi.getFlowMessageAction(id: string, options)\n```\n_______________________________\n\n[Get Action ID for Flow Message](https://developers.klaviyo.com/en/v2025-01-15/reference/get_action_id_for_flow_message)\n\n```typescript\nFlowsApi.getActionIdForFlowMessage(id: string)\n```\n##### Method alias:\n```typescript\nFlowsApi.getFlowMessageRelationshipsAction(id: string)\n```\n_______________________________\n\n[Get Action IDs for Flow](https://developers.klaviyo.com/en/v2025-01-15/reference/get_action_ids_for_flow)\n\n```typescript\nFlowsApi.getActionIdsForFlow(id: string, options)\n```\n##### Method alias:\n```typescript\nFlowsApi.getFlowRelationshipsFlowActions(id: string, options)\n```\n##### Method alias:\n```typescript\nFlowsApi.getFlowRelationshipsActions(id: string, options)\n```\n_______________________________\n\n[Get Actions for Flow](https://developers.klaviyo.com/en/v2025-01-15/reference/get_actions_for_flow)\n\n```typescript\nFlowsApi.getActionsForFlow(id: string, options)\n```\n##### Method alias:\n```typescript\nFlowsApi.getFlowFlowActions(id: string, options)\n```\n##### Method alias:\n```typescript\nFlowsApi.getFlowActions(id: string, options)\n```\n_______________________________\n\n[Get Flow](https://developers.klaviyo.com/en/v2025-01-15/reference/get_flow)\n\n```typescript\nFlowsApi.getFlow(id: string, options)\n```\n_______________________________\n\n[Get Flow Action](https://developers.klaviyo.com/en/v2025-01-15/reference/get_flow_action)\n\n```typescript\nFlowsApi.getFlowAction(id: string, options)\n```\n_______________________________\n\n[Get Messages For Flow Action](https://developers.klaviyo.com/en/v2025-01-15/reference/get_flow_action_messages)\n\n```typescript\nFlowsApi.getFlowActionMessages(id: string, options)\n```\n##### Method alias:\n```typescript\nFlowsApi.getMessagesForFlowAction(id: string, options)\n```\n_______________________________\n\n[Get Flow for Flow Action](https://developers.klaviyo.com/en/v2025-01-15/reference/get_flow_for_flow_action)\n\n```typescript\nFlowsApi.getFlowForFlowAction(id: string, options)\n```\n##### Method alias:\n```typescript\nFlowsApi.getFlowActionFlow(id: string, options)\n```\n_______________________________\n\n[Get Flow ID for Flow Action](https://developers.klaviyo.com/en/v2025-01-15/reference/get_flow_id_for_flow_action)\n\n```typescript\nFlowsApi.getFlowIdForFlowAction(id: string)\n```\n##### Method alias:\n```typescript\nFlowsApi.getFlowActionRelationshipsFlow(id: string)\n```\n_______________________________\n\n[Get Flow Message](https://developers.klaviyo.com/en/v2025-01-15/reference/get_flow_message)\n\n```typescript\nFlowsApi.getFlowMessage(id: string, options)\n```\n_______________________________\n\n[Get Flows](https://developers.klaviyo.com/en/v2025-01-15/reference/get_flows)\n\n```typescript\nFlowsApi.getFlows(options)\n```\n_______________________________\n\n[Get Message IDs for Flow Action](https://developers.klaviyo.com/en/v2025-01-15/reference/get_message_ids_for_flow_action)\n\n```typescript\nFlowsApi.getMessageIdsForFlowAction(id: string, options)\n```\n##### Method alias:\n```typescript\nFlowsApi.getFlowActionRelationshipsMessages(id: string, options)\n```\n_______________________________\n\n[Get Tag IDs for Flow](https://developers.klaviyo.com/en/v2025-01-15/reference/get_tag_ids_for_flow)\n\n```typescript\nFlowsApi.getTagIdsForFlow(id: string)\n```\n##### Method alias:\n```typescript\nFlowsApi.getFlowRelationshipsTags(id: string)\n```\n_______________________________\n\n[Get Tags for Flow](https://developers.klaviyo.com/en/v2025-01-15/reference/get_tags_for_flow)\n\n```typescript\nFlowsApi.getTagsForFlow(id: string, options)\n```\n##### Method alias:\n```typescript\nFlowsApi.getFlowTags(id: string, options)\n```\n_______________________________\n\n[Get Template for Flow Message](https://developers.klaviyo.com/en/v2025-01-15/reference/get_template_for_flow_message)\n\n```typescript\nFlowsApi.getTemplateForFlowMessage(id: string, options)\n```\n##### Method alias:\n```typescript\nFlowsApi.getFlowMessageTemplate(id: string, options)\n```\n_______________________________\n\n[Get Template ID for Flow Message](https://developers.klaviyo.com/en/v2025-01-15/reference/get_template_id_for_flow_message)\n\n```typescript\nFlowsApi.getTemplateIdForFlowMessage(id: string)\n```\n##### Method alias:\n```typescript\nFlowsApi.getFlowMessageRelationshipsTemplate(id: string)\n```\n_______________________________\n\n[Update Flow Status](https://developers.klaviyo.com/en/v2025-01-15/reference/update_flow)\n\n```typescript\nFlowsApi.updateFlow(id: string, flowUpdateQuery: FlowUpdateQuery)\n```\n_______________________________\n## FormsApi\n_______________________________\n\n[Get Form](https://developers.klaviyo.com/en/v2025-01-15/reference/get_form)\n\n```typescript\nFormsApi.getForm(id: string, options)\n```\n_______________________________\n\n[Get Form for Form Version](https://developers.klaviyo.com/en/v2025-01-15/reference/get_form_for_form_version)\n\n```typescript\nFormsApi.getFormForFormVersion(id: string, options)\n```\n##### Method alias:\n```typescript\nFormsApi.getFormVersionForm(id: string, options)\n```\n_______________________________\n\n[Get Form ID for Form Version](https://developers.klaviyo.com/en/v2025-01-15/reference/get_form_id_for_form_version)\n\n```typescript\nFormsApi.getFormIdForFormVersion(id: string)\n```\n##### Method alias:\n```typescript\nFormsApi.getFormVersionRelationshipsForm(id: string)\n```\n_______________________________\n\n[Get Form Version](https://developers.klaviyo.com/en/v2025-01-15/reference/get_form_version)\n\n```typescript\nFormsApi.getFormVersion(id: string, options)\n```\n_______________________________\n\n[Get Forms](https://developers.klaviyo.com/en/v2025-01-15/reference/get_forms)\n\n```typescript\nFormsApi.getForms(options)\n```\n_______________________________\n\n[Get Version IDs for Form](https://developers.klaviyo.com/en/v2025-01-15/reference/get_version_ids_for_form)\n\n```typescript\nFormsApi.getVersionIdsForForm(id: string, options)\n```\n##### Method alias:\n```typescript\nFormsApi.getFormRelationshipsFormVersions(id: string, options)\n```\n##### Method alias:\n```typescript\nFormsApi.getFormRelationshipsVersions(id: string, options)\n```\n_______________________________\n\n[Get Versions for Form](https://developers.klaviyo.com/en/v2025-01-15/reference/get_versions_for_form)\n\n```typescript\nFormsApi.getVersionsForForm(id: string, options)\n```\n##### Method alias:\n```typescript\nFormsApi.getFormFormVersions(id: string, options)\n```\n##### Method alias:\n```typescript\nFormsApi.getFormVersions(id: string, options)\n```\n_______________________________\n## ImagesApi\n_______________________________\n\n[Get Image](https://developers.klaviyo.com/en/v2025-01-15/reference/get_image)\n\n```typescript\nImagesApi.getImage(id: string, options)\n```\n_______________________________\n\n[Get Images](https://developers.klaviyo.com/en/v2025-01-15/reference/get_images)\n\n```typescript\nImagesApi.getImages(options)\n```\n_______________________________\n\n[Update Image](https://developers.klaviyo.com/en/v2025-01-15/reference/update_image)\n\n```typescript\nImagesApi.updateImage(id: string, imagePartialUpdateQuery: ImagePartialUpdateQuery)\n```\n_______________________________\n\n[Upload Image From File](https://developers.klaviyo.com/en/v2025-01-15/reference/upload_image_from_file)\n\n```typescript\nImagesApi.uploadImageFromFile(file: RequestFile, )\n```\n##### Method alias:\n```typescript\nImagesApi.createImageUpload(file: RequestFile, )\n```\n_______________________________\n\n[Upload Image From URL](https://developers.klaviyo.com/en/v2025-01-15/reference/upload_image_from_url)\n\n```typescript\nImagesApi.uploadImageFromUrl(imageCreateQuery: ImageCreateQuery)\n```\n##### Method alias:\n```typescript\nImagesApi.createImage(imageCreateQuery: ImageCreateQuery)\n```\n_______________________________\n## ListsApi\n_______________________________\n\n[Add Profiles to List](https://developers.klaviyo.com/en/v2025-01-15/reference/add_profiles_to_list)\n\n```typescript\nListsApi.addProfilesToList(id: string, listMembersAddQuery: ListMembersAddQuery)\n```\n##### Method alias:\n```typescript\nListsApi.createListRelationships(id: string, listMembersAddQuery: ListMembersAddQuery)\n```\n##### Method alias:\n```typescript\nListsApi.createListRelationshipsProfile(id: string, listMembersAddQuery: ListMembersAddQuery)\n```\n##### Method alias:\n```typescript\nListsApi.createListRelationshipsProfiles(id: string, listMembersAddQuery: ListMembersAddQuery)\n```\n_______________________________\n\n[Create List](https://developers.klaviyo.com/en/v2025-01-15/reference/create_list)\n\n```typescript\nListsApi.createList(listCreateQuery: ListCreateQuery)\n```\n_______________________________\n\n[Delete List](https://developers.klaviyo.com/en/v2025-01-15/reference/delete_list)\n\n```typescript\nListsApi.deleteList(id: string)\n```\n_______________________________\n\n[Get Flows Triggered by List](https://developers.klaviyo.com/en/v2025-01-15/reference/get_flows_triggered_by_list)\n\n```typescript\nListsApi.getFlowsTriggeredByList(id: string, options)\n```\n##### Method alias:\n```typescript\nListsApi.getFlowTriggersForList(id: string, options)\n```\n##### Method alias:\n```typescript\nListsApi.getListFlowTriggers(id: string, options)\n```\n_______________________________\n\n[Get IDs for Flows Triggered by List](https://developers.klaviyo.com/en/v2025-01-15/reference/get_ids_for_flows_triggered_by_list)\n\n```typescript\nListsApi.getIdsForFlowsTriggeredByList(id: string)\n```\n##### Method alias:\n```typescript\nListsApi.getFlowTriggerIdsForList(id: string)\n```\n##### Method alias:\n```typescript\nListsApi.getListRelationshipsFlowTriggers(id: string)\n```\n_______________________________\n\n[Get List](https://developers.klaviyo.com/en/v2025-01-15/reference/get_list)\n\n```typescript\nListsApi.getList(id: string, options)\n```\n_______________________________\n\n[Get Lists](https://developers.klaviyo.com/en/v2025-01-15/reference/get_lists)\n\n```typescript\nListsApi.getLists(options)\n```\n_______________________________\n\n[Get Profile IDs for List](https://developers.klaviyo.com/en/v2025-01-15/reference/get_profile_ids_for_list)\n\n```typescript\nListsApi.getProfileIdsForList(id: string, options)\n```\n##### Method alias:\n```typescript\nListsApi.getListRelationshipsProfiles(id: string, options)\n```\n_______________________________\n\n[Get Profiles for List](https://developers.klaviyo.com/en/v2025-01-15/reference/get_profiles_for_list)\n\n```typescript\nListsApi.getProfilesForList(id: string, options)\n```\n##### Method alias:\n```typescript\nListsApi.getListProfiles(id: string, options)\n```\n_______________________________\n\n[Get Tag IDs for List](https://developers.klaviyo.com/en/v2025-01-15/reference/get_tag_ids_for_list)\n\n```typescript\nListsApi.getTagIdsForList(id: string)\n```\n##### Method alias:\n```typescript\nListsApi.getListRelationshipsTags(id: string)\n```\n_______________________________\n\n[Get Tags for List](https://developers.klaviyo.com/en/v2025-01-15/reference/get_tags_for_list)\n\n```typescript\nListsApi.getTagsForList(id: string, options)\n```\n##### Method alias:\n```typescript\nListsApi.getListTags(id: string, options)\n```\n_______________________________\n\n[Remove Profiles from List](https://developers.klaviyo.com/en/v2025-01-15/reference/remove_profiles_from_list)\n\n```typescript\nListsApi.removeProfilesFromList(id: string, listMembersDeleteQuery: ListMembersDeleteQuery)\n```\n##### Method alias:\n```typescript\nListsApi.deleteListRelationships(id: string, listMembersDeleteQuery: ListMembersDeleteQuery)\n```\n##### Method alias:\n```typescript\nListsApi.deleteListRelationshipsProfiles(id: string, listMembersDeleteQuery: ListMembersDeleteQuery)\n```\n_______________________________\n\n[Update List](https://developers.klaviyo.com/en/v2025-01-15/reference/update_list)\n\n```typescript\nListsApi.updateList(id: string, listPartialUpdateQuery: ListPartialUpdateQuery)\n```\n_______________________________\n## MetricsApi\n_______________________________\n\n[Get Flows Triggered by Metric](https://developers.klaviyo.com/en/v2025-01-15/reference/get_flows_triggered_by_metric)\n\n```typescript\nMetricsApi.getFlowsTriggeredByMetric(id: string, options)\n```\n##### Method alias:\n```typescript\nMetricsApi.getFlowTriggersForMetric(id: string, options)\n```\n##### Method alias:\n```typescript\nMetricsApi.getMetricFlowTriggers(id: string, options)\n```\n_______________________________\n\n[Get IDs for Flows Triggered by Metric](https://developers.klaviyo.com/en/v2025-01-15/reference/get_ids_for_flows_triggered_by_metric)\n\n```typescript\nMetricsApi.getIdsForFlowsTriggeredByMetric(id: string)\n```\n##### Method alias:\n```typescript\nMetricsApi.getFlowTriggerIdsForMetric(id: string)\n```\n##### Method alias:\n```typescript\nMetricsApi.getMetricRelationshipsFlowTriggers(id: string)\n```\n_______________________________\n\n[Get Metric](https://developers.klaviyo.com/en/v2025-01-15/reference/get_metric)\n\n```typescript\nMetricsApi.getMetric(id: string, options)\n```\n_______________________________\n\n[Get Metric for Metric Property](https://developers.klaviyo.com/en/v2025-01-15/reference/get_metric_for_metric_property)\n\n```typescript\nMetricsApi.getMetricForMetricProperty(id: string, options)\n```\n##### Method alias:\n```typescript\nMetricsApi.getMetricPropertyMetric(id: string, options)\n```\n_______________________________\n\n[Get Metric ID for Metric Property](https://developers.klaviyo.com/en/v2025-01-15/reference/get_metric_id_for_metric_property)\n\n```typescript\nMetricsApi.getMetricIdForMetricProperty(id: string)\n```\n##### Method alias:\n```typescript\nMetricsApi.getMetricPropertyRelationshipsMetric(id: string)\n```\n_______________________________\n\n[Get Metric Property](https://developers.klaviyo.com/en/v2025-01-15/reference/get_metric_property)\n\n```typescript\nMetricsApi.getMetricProperty(id: string, options)\n```\n_______________________________\n\n[Get Metrics](https://developers.klaviyo.com/en/v2025-01-15/reference/get_metrics)\n\n```typescript\nMetricsApi.getMetrics(options)\n```\n_______________________________\n\n[Get Properties for Metric](https://developers.klaviyo.com/en/v2025-01-15/reference/get_properties_for_metric)\n\n```typescript\nMetricsApi.getPropertiesForMetric(id: string, options)\n```\n##### Method alias:\n```typescript\nMetricsApi.getMetricMetricProperties(id: string, options)\n```\n##### Method alias:\n```typescript\nMetricsApi.getMetricProperties(id: string, options)\n```\n_______________________________\n\n[Get Property IDs for Metric](https://developers.klaviyo.com/en/v2025-01-15/reference/get_property_ids_for_metric)\n\n```typescript\nMetricsApi.getPropertyIdsForMetric(id: string)\n```\n##### Method alias:\n```typescript\nMetricsApi.getMetricRelationshipsMetricProperties(id: string)\n```\n##### Method alias:\n```typescript\nMetricsApi.getMetricRelationshipsProperties(id: string)\n```\n_______________________________\n\n[Query Metric Aggregates](https://developers.klaviyo.com/en/v2025-01-15/reference/query_metric_aggregates)\n\n```typescript\nMetricsApi.queryMetricAggregates(metricAggregateQuery: MetricAggregateQuery)\n```\n##### Method alias:\n```typescript\nMetricsApi.createMetricAggregate(metricAggregateQuery: MetricAggregateQuery)\n```\n_______________________________\n## ProfilesApi\n_______________________________\n\n[Bulk Import Profiles](https://developers.klaviyo.com/en/v2025-01-15/reference/bulk_import_profiles)\n\n```typescript\nProfilesApi.bulkImportProfiles(profileImportJobCreateQuery: ProfileImportJobCreateQuery)\n```\n##### Method alias:\n```typescript\nProfilesApi.spawnBulkProfileImportJob(profileImportJobCreateQuery: ProfileImportJobCreateQuery)\n```\n##### Method alias:\n```typescript\nProfilesApi.createProfileBulkImportJob(profileImportJobCreateQuery: ProfileImportJobCreateQuery)\n```\n_______________________________\n\n[Bulk Subscribe Profiles](https://developers.klaviyo.com/en/v2025-01-15/reference/bulk_subscribe_profiles)\n\n```typescript\nProfilesApi.bulkSubscribeProfiles(subscriptionCreateJobCreateQuery: SubscriptionCreateJobCreateQuery)\n```\n##### Method alias:\n```typescript\nProfilesApi.subscribeProfiles(subscriptionCreateJobCreateQuery: SubscriptionCreateJobCreateQuery)\n```\n##### Method alias:\n```typescript\nProfilesApi.createProfileSubscriptionBulkCreateJob(subscriptionCreateJobCreateQuery: SubscriptionCreateJobCreateQuery)\n```\n_______________________________\n\n[Bulk Suppress Profiles](https://developers.klaviyo.com/en/v2025-01-15/reference/bulk_suppress_profiles)\n\n```typescript\nProfilesApi.bulkSuppressProfiles(suppressionCreateJobCreateQuery: SuppressionCreateJobCreateQuery)\n```\n##### Method alias:\n```typescript\nProfilesApi.suppressProfiles(suppressionCreateJobCreateQuery: SuppressionCreateJobCreateQuery)\n```\n##### Method alias:\n```typescript\nProfilesApi.createProfileSuppressionBulkCreateJob(suppressionCreateJobCreateQuery: SuppressionCreateJobCreateQuery)\n```\n_______________________________\n\n[Bulk Unsubscribe Profiles](https://developers.klaviyo.com/en/v2025-01-15/reference/bulk_unsubscribe_profiles)\n\n```typescript\nProfilesApi.bulkUnsubscribeProfiles(subscriptionDeleteJobCreateQuery: SubscriptionDeleteJobCreateQuery)\n```\n##### Method alias:\n```typescript\nProfilesApi.unsubscribeProfiles(subscriptionDeleteJobCreateQuery: SubscriptionDeleteJobCreateQuery)\n```\n##### Method alias:\n```typescript\nProfilesApi.createProfileSubscriptionBulkDeleteJob(subscriptionDeleteJobCreateQuery: SubscriptionDeleteJobCreateQuery)\n```\n_______________________________\n\n[Bulk Unsuppress Profiles](https://developers.klaviyo.com/en/v2025-01-15/reference/bulk_unsuppress_profiles)\n\n```typescript\nProfilesApi.bulkUnsuppressProfiles(suppressionDeleteJobCreateQuery: SuppressionDeleteJobCreateQuery)\n```\n##### Method alias:\n```typescript\nProfilesApi.unsuppressProfiles(suppressionDeleteJobCreateQuery: SuppressionDeleteJobCreateQuery)\n```\n##### Method alias:\n```typescript\nProfilesApi.createProfileSuppressionBulkDeleteJob(suppressionDeleteJobCreateQuery: SuppressionDeleteJobCreateQuery)\n```\n_______________________________\n\n[Create or Update Profile](https://developers.klaviyo.com/en/v2025-01-15/reference/create_or_update_profile)\n\n```typescript\nProfilesApi.createOrUpdateProfile(profileUpsertQuery: ProfileUpsertQuery, options)\n```\n##### Method alias:\n```typescript\nProfilesApi.createProfileImport(profileUpsertQuery: ProfileUpsertQuery, options)\n```\n_______________________________\n\n[Create Profile](https://developers.klaviyo.com/en/v2025-01-15/reference/create_profile)\n\n```typescript\nProfilesApi.createProfile(profileCreateQuery: ProfileCreateQuery, options)\n```\n_______________________________\n\n[Create or Update Push Token](https://developers.klaviyo.com/en/v2025-01-15/reference/create_push_token)\n\n```typescript\nProfilesApi.createPushToken(pushTokenCreateQuery: PushTokenCreateQuery)\n```\n_______________________________\n\n[Get Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_import_profiles_job)\n\n```typescript\nProfilesApi.getBulkImportProfilesJob(jobId: string, options)\n```\n##### Method alias:\n```typescript\nProfilesApi.getBulkProfileImportJob(jobId: string, options)\n```\n##### Method alias:\n```typescript\nProfilesApi.getProfileBulkImportJob(jobId: string, options)\n```\n_______________________________\n\n[Get Bulk Import Profiles Jobs](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_import_profiles_jobs)\n\n```typescript\nProfilesApi.getBulkImportProfilesJobs(options)\n```\n##### Method alias:\n```typescript\nProfilesApi.getBulkProfileImportJobs(options)\n```\n##### Method alias:\n```typescript\nProfilesApi.getProfileBulkImportJobs(options)\n```\n_______________________________\n\n[Get Bulk Suppress Profiles Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_suppress_profiles_job)\n\n```typescript\nProfilesApi.getBulkSuppressProfilesJob(jobId: string, options)\n```\n##### Method alias:\n```typescript\nProfilesApi.getProfileSuppressionBulkCreateJob(jobId: string, options)\n```\n_______________________________\n\n[Get Bulk Suppress Profiles Jobs](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_suppress_profiles_jobs)\n\n```typescript\nProfilesApi.getBulkSuppressProfilesJobs(options)\n```\n##### Method alias:\n```typescript\nProfilesApi.getProfileSuppressionBulkCreateJobs(options)\n```\n_______________________________\n\n[Get Bulk Unsuppress Profiles Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_unsuppress_profiles_job)\n\n```typescript\nProfilesApi.getBulkUnsuppressProfilesJob(jobId: string, options)\n```\n##### Method alias:\n```typescript\nProfilesApi.getProfileSuppressionBulkDeleteJob(jobId: string, options)\n```\n_______________________________\n\n[Get Bulk Unsuppress Profiles Jobs](https://developers.klaviyo.com/en/v2025-01-15/reference/get_bulk_unsuppress_profiles_jobs)\n\n```typescript\nProfilesApi.getBulkUnsuppressProfilesJobs(options)\n```\n##### Method alias:\n```typescript\nProfilesApi.getProfileSuppressionBulkDeleteJobs(options)\n```\n_______________________________\n\n[Get Errors for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_errors_for_bulk_import_profiles_job)\n\n```typescript\nProfilesApi.getErrorsForBulkImportProfilesJob(id: string, options)\n```\n##### Method alias:\n```typescript\nProfilesApi.getBulkProfileImportJobImportErrors(id: string, options)\n```\n##### Method alias:\n```typescript\nProfilesApi.getImportErrorsForProfileBulkImportJob(id: string, options)\n```\n##### Method alias:\n```typescript\nProfilesApi.getProfileBulkImportJobImportErrors(id: string, options)\n```\n_______________________________\n\n[Get List for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_list_for_bulk_import_profiles_job)\n\n```typescript\nProfilesApi.getListForBulkImportProfilesJob(id: string, options)\n```\n##### Method alias:\n```typescript\nProfilesApi.getBulkProfileImportJobLists(id: string, options)\n```\n##### Method alias:\n```typescript\nProfilesApi.getListsForProfileBulkImportJob(id: string, options)\n```\n##### Method alias:\n```typescript\nProfilesApi.getProfileBulkImportJobLists(id: string, options)\n```\n_______________________________\n\n[Get List IDs for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_list_ids_for_bulk_import_profiles_job)\n\n```typescript\nProfilesApi.getListIdsForBulkImportProfilesJob(id: string)\n```\n##### Method alias:\n```typescript\nProfilesApi.getBulkProfileImportJobRelationshipsLists(id: string)\n```\n##### Method alias:\n```typescript\nProfilesApi.getListIdsForProfileBulkImportJob(id: string)\n```\n##### Method alias:\n```typescript\nProfilesApi.getProfileBulkImportJobRelationshipsLists(id: string)\n```\n_______________________________\n\n[Get List IDs for Profile](https://developers.klaviyo.com/en/v2025-01-15/reference/get_list_ids_for_profile)\n\n```typescript\nProfilesApi.getListIdsForProfile(id: string)\n```\n##### Method alias:\n```typescript\nProfilesApi.getProfileRelationshipsLists(id: string)\n```\n_______________________________\n\n[Get Lists for Profile](https://developers.klaviyo.com/en/v2025-01-15/reference/get_lists_for_profile)\n\n```typescript\nProfilesApi.getListsForProfile(id: string, options)\n```\n##### Method alias:\n```typescript\nProfilesApi.getProfileLists(id: string, options)\n```\n_______________________________\n\n[Get Profile](https://developers.klaviyo.com/en/v2025-01-15/reference/get_profile)\n\n```typescript\nProfilesApi.getProfile(id: string, options)\n```\n_______________________________\n\n[Get Profile IDs for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_profile_ids_for_bulk_import_profiles_job)\n\n```typescript\nProfilesApi.getProfileIdsForBulkImportProfilesJob(id: string, options)\n```\n##### Method alias:\n```typescript\nProfilesApi.getBulkProfileImportJobRelationshipsProfiles(id: string, options)\n```\n##### Method alias:\n```typescript\nProfilesApi.getProfileBulkImportJobRelationshipsProfiles(id: string, options)\n```\n##### Method alias:\n```typescript\nProfilesApi.getProfileIdsForProfileBulkImportJob(id: string, options)\n```\n_______________________________\n\n[Get Profiles](https://developers.klaviyo.com/en/v2025-01-15/reference/get_profiles)\n\n```typescript\nProfilesApi.getProfiles(options)\n```\n_______________________________\n\n[Get Profiles for Bulk Import Profiles Job](https://developers.klaviyo.com/en/v2025-01-15/reference/get_profiles_for_bulk_import_profiles_job)\n\n```typescript\nProfilesApi.getProfilesForBulkImportProfilesJob(id: string, options)\n```\n##### Method alias:\n```typescript\nProfilesApi.getBulkProfileImportJobProfiles(id: string, options)\n```\n##### Method alias:\n```typescript\nProfilesApi.getProfileBulkImportJobProfiles(id: string, options)\n```\n##### Method alias:\n```typescript\nProfilesApi.getProfilesForProfileBulkImportJob(id: string, options)\n```\n_______________________________\n\n[Get Segment IDs for Profile](https://developers.klaviyo.com/en/v2025-01-15/reference/get_segment_ids_for_profile)\n\n```typescript\nProfilesApi.getSegmentIdsForProfile(id: string)\n```\n##### Method alias:\n```typescript\nProfilesApi.getProfileRelationshipsSegments(id: string)\n```\n_______________________________\n\n[Get Segments for Profile](https://developers.klaviyo.com/en/v2025-01-15/reference/get_segments_for_profile)\n\n```typescript\nProfilesApi.getSegmentsForProfile(id: string, options)\n```\n##### Method alias:\n```typescript\nProfilesApi.getProfileSegments(id: string, options)\n```\n_______________________________\n\n[Merge Profiles](https://developers.klaviyo.com/en/v2025-01-15/reference/merge_profiles)\n\n```typescript\nProfilesApi.mergeProfiles(profileMergeQuery: ProfileMergeQuery)\n```\n##### Method alias:\n```typescript\nProfilesApi.createProfileMerge(profileMergeQuery: ProfileMergeQuery)\n```\n_______________________________\n\n[Update Profile](https://developers.klaviyo.com/en/v2025-01-15/reference/update_profile)\n\n```typescript\nProfilesApi.updateProfile(id: string, profilePartialUpdateQuery: ProfilePartialUpdateQuery, options)\n```\n_______________________________\n## ReportingApi\n_______________________________\n\n[Query Campaign Values](https://developers.klaviyo.com/en/v2025-01-15/reference/query_campaign_values)\n\n```typescript\nReportingApi.queryCampaignValues(campaignValuesRequestDTO: CampaignValuesRequestDTO, options)\n```\n##### Method alias:\n```typescript\nReportingApi.createCampaignValueReport(campaignValuesRequestDTO: CampaignValuesRequestDTO, options)\n```\n##### Method alias:\n```typescript\nReportingApi.createCampaignValuesReport(campaignValuesRequestDTO: CampaignValuesRequestDTO, options)\n```\n_______________________________\n\n[Query Flow Series](https://developers.klaviyo.com/en/v2025-01-15/reference/query_flow_series)\n\n```typescript\nReportingApi.queryFlowSeries(flowSeriesRequestDTO: FlowSeriesRequestDTO, options)\n```\n##### Method alias:\n```typescript\nReportingApi.createFlowSeryReport(flowSeriesRequestDTO: FlowSeriesRequestDTO, options)\n```\n##### Method alias:\n```typescript\nReportingApi.createFlowSeriesReport(flowSeriesRequestDTO: FlowSeriesRequestDTO, options)\n```\n_______________________________\n\n[Query Flow Values](https://developers.klaviyo.com/en/v2025-01-15/reference/query_flow_values)\n\n```typescript\nReportingApi.queryFlowValues(flowValuesRequestDTO: FlowValuesRequestDTO, options)\n```\n##### Method alias:\n```typescript\nReportingApi.createFlowValueReport(flowValuesRequestDTO: FlowValuesRequestDTO, options)\n```\n##### Method alias:\n```typescript\nReportingApi.createFlowValuesReport(flowValuesRequestDTO: FlowValuesRequestDTO, options)\n```\n_______________________________\n\n[Query Form Series](https://developers.klaviyo.com/en/v2025-01-15/reference/query_form_series)\n\n```typescript\nReportingApi.queryFormSeries(formSeriesRequestDTO: FormSeriesRequestDTO)\n```\n##### Method alias:\n```typescript\nReportingApi.createFormSeryReport(formSeriesRequestDTO: FormSeriesRequestDTO)\n```\n##### Method alias:\n```typescript\nReportingApi.createFormSeriesReport(formSeriesRequestDTO: FormSeriesRequestDTO)\n```\n_______________________________\n\n[Query Form Values](https://developers.klaviyo.com/en/v2025-01-15/reference/query_form_values)\n\n```typescript\nReportingApi.queryFormValues(formValuesRequestDTO: FormValuesRequestDTO)\n```\n##### Method alias:\n```typescript\nReportingApi.createFormValueReport(formValuesRequestDTO: FormValuesRequestDTO)\n```\n##### Method alias:\n```typescript\nReportingApi.createFormValuesReport(formValuesRequestDTO: FormValuesRequestDTO)\n```\n_______________________________\n\n[Query Segment Series](https://developers.klaviyo.com/en/v2025-01-15/reference/query_segment_series)\n\n```typescript\nReportingApi.querySegmentSeries(segmentSeriesRequestDTO: SegmentSeriesRequestDTO)\n```\n##### Method alias:\n```typescript\nReportingApi.createSegmentSeryReport(segmentSeriesRequestDTO: SegmentSeriesRequestDTO)\n```\n##### Method alias:\n```typescript\nReportingApi.createSegmentSeriesReport(segmentSeriesRequestDTO: SegmentSeriesRequestDTO)\n```\n_______________________________\n\n[Query Segment Values](https://developers.klaviyo.com/en/v2025-01-15/reference/query_segment_values)\n\n```typescript\nReportingApi.querySegmentValues(segmentValuesRequestDTO: SegmentValuesRequestDTO)\n```\n##### Method alias:\n```typescript\nReportingApi.createSegmentValueReport(segmentValuesRequestDTO: SegmentValuesRequestDTO)\n```\n##### Method alias:\n```typescript\nReportingApi.createSegmentValuesReport(segmentValuesRequestDTO: SegmentValuesRequestDTO)\n```\n_______________________________\n## ReviewsApi\n_______________________________\n\n[Get Review](https://developers.klaviyo.com/en/v2025-01-15/reference/get_review)\n\n```typescript\nReviewsApi.getReview(id: string, options)\n```\n_______________________________\n\n[Get Reviews](https://developers.klaviyo.com/en/v2025-01-15/reference/get_reviews)\n\n```typescript\nReviewsApi.getReviews(options)\n```\n_______________________________\n\n[Update Review](https://developers.klaviyo.com/en/v2025-01-15/reference/update_review)\n\n```typescript\nReviewsApi.updateReview(id: string, reviewPatchQuery: ReviewPatchQuery)\n```\n_______________________________\n## SegmentsApi\n_______________________________\n\n[Create Segment](https://developers.klaviyo.com/en/v2025-01-15/reference/create_segment)\n\n```typescript\nSegmentsApi.createSegment(segmentCreateQuery: SegmentCreateQuery)\n```\n_______________________________\n\n[Delete Segment](https://developers.klaviyo.com/en/v2025-01-15/reference/delete_segment)\n\n```typescript\nSegmentsApi.deleteSegment(id: string)\n```\n_______________________________\n\n[Get Flows Triggered by Segment](https://developers.klaviyo.com/en/v2025-01-15/reference/get_flows_triggered_by_segment)\n\n```typescript\nSegmentsApi.getFlowsTriggeredBySegment(id: string, options)\n```\n##### Method alias:\n```typescript\nSegmentsApi.getFlowTriggersForSegment(id: string, options)\n```\n##### Method alias:\n```typescript\nSegmentsApi.getSegmentFlowTriggers(id: string, options)\n```\n_______________________________\n\n[Get IDs for Flows Triggered by Segment](https://developers.klaviyo.com/en/v2025-01-15/reference/get_ids_for_flows_triggered_by_segment)\n\n```typescript\nSegmentsApi.getIdsForFlowsTriggeredBySegment(id: string)\n```\n##### Method alias:\n```typescript\nSegmentsApi.getFlowTriggerIdsForSegment(id: string)\n```\n##### Method alias:\n```typescript\nSegmentsApi.getSegmentRelationshipsFlowTriggers(id: string)\n```\n_______________________________\n\n[Get Profile IDs for Segment](https://developers.klaviyo.com/en/v2025-01-15/reference/get_profile_ids_for_segment)\n\n```typescript\nSegmentsApi.getProfileIdsForSegment(id: string, options)\n```\n##### Method alias:\n```typescript\nSegmentsApi.getSegmentRelationshipsProfiles(id: string, options)\n```\n_______________________________\n\n[Get Profiles for Segment](https://developers.klaviyo.com/en/v2025-01-15/reference/get_profiles_for_segment)\n\n```typescript\nSegmentsApi.getProfilesForSegment(id: string, options)\n```\n##### Method alias:\n```typescript\nSegmentsApi.getSegmentProfiles(id: string, options)\n```\n_______________________________\n\n[Get Segment](https://developers.klaviyo.com/en/v2025-01-15/reference/get_segment)\n\n```typescript\nSegmentsApi.getSegment(id: string, options)\n```\n_______________________________\n\n[Get Segments](https://developers.klaviyo.com/en/v2025-01-15/reference/get_segments)\n\n```typescript\nSegmentsApi.getSegments(options)\n```\n_______________________________\n\n[Get Tag IDs for Segment](https://developers.klaviyo.com/en/v2025-01-15/reference/get_tag_ids_for_segment)\n\n```typescript\nSegmentsApi.getTagIdsForSegment(id: string)\n```\n##### Method alias:\n```typescript\nSegmentsApi.getSegmentRelationshipsTags(id: string)\n```\n_______________________________\n\n[Get Tags for Segment](https://developers.klaviyo.com/en/v2025-01-15/reference/get_tags_for_segment)\n\n```typescript\nSegmentsApi.getTagsForSegment(id: string, options)\n```\n##### Method alias:\n```typescript\nSegmentsApi.getSegmentTags(id: string, options)\n```\n_______________________________\n\n[Update Segment](https://developers.klaviyo.com/en/v2025-01-15/reference/update_segment)\n\n```typescript\nSegmentsApi.updateSegment(id: string, segmentPartialUpdateQuery: SegmentPartialUpdateQuery)\n```\n_______________________________\n## TagsApi\n_______________________________\n\n[Create Tag](https://developers.klaviyo.com/en/v2025-01-15/reference/create_tag)\n\n```typescript\nTagsApi.createTag(tagCreateQuery: TagCreateQuery)\n```\n_______________________________\n\n[Create Tag Group](https://developers.klaviyo.com/en/v2025-01-15/reference/create_tag_group)\n\n```typescript\nTagsApi.createTagGroup(tagGroupCreateQuery: TagGroupCreateQuery)\n```\n_______________________________\n\n[Delete Tag](https://developers.klaviyo.com/en/v2025-01-15/reference/delete_tag)\n\n```typescript\nTagsApi.deleteTag(id: string)\n```\n_______________________________\n\n[Delete Tag Group](https://developers.klaviyo.com/en/v2025-01-15/reference/delete_tag_group)\n\n```typescript\nTagsApi.deleteTagGroup(id: string)\n```\n_______________________________\n\n[Get Campaign IDs for Tag](https://developers.klaviyo.com/en/v2025-01-15/reference/get_campaign_ids_for_tag)\n\n```typescript\nTagsApi.getCampaignIdsForTag(id: string)\n```\n##### Method alias:\n```typescript\nTagsApi.getTagRelationshipsCampaigns(id: string)\n```\n_______________________________\n\n[Get Flow IDs for Tag](https://developers.klaviyo.com/en/v2025-01-15/reference/get_flow_ids_for_tag)\n\n```typescript\nTagsApi.getFlowIdsForTag(id: string)\n```\n##### Method alias:\n```typescript\nTagsApi.getTagRelationshipsFlows(id: string)\n```\n_______________________________\n\n[Get List IDs for Tag](https://developers.klaviyo.com/en/v2025-01-15/reference/get_list_ids_for_tag)\n\n```typescript\nTagsApi.getListIdsForTag(id: string)\n```\n##### Method alias:\n```typescript\nTagsApi.getTagRelationshipsLists(id: string)\n```\n_______________________________\n\n[Get Segment IDs for Tag](https://developers.klaviyo.com/en/v2025-01-15/reference/get_segment_ids_for_tag)\n\n```typescript\nTagsApi.getSegmentIdsForTag(id: string)\n```\n##### Method alias:\n```typescript\nTagsApi.getTagRelationshipsSegments(id: string)\n```\n_______________________________\n\n[Get Tag](https://developers.klaviyo.com/en/v2025-01-15/reference/get_tag)\n\n```typescript\nTagsApi.getTag(id: string, options)\n```\n_______________________________\n\n[Get Tag Group](https://developers.klaviyo.com/en/v2025-01-15/reference/get_tag_group)\n\n```typescript\nTagsApi.getTagGroup(id: string, options)\n```\n_______________________________\n\n[Get Tag Group for Tag](https://developers.klaviyo.com/en/v2025-01-15/reference/get_tag_group_for_tag)\n\n```typescript\nTagsApi.getTagGroupForTag(id: string, options)\n```\n##### Method alias:\n```typescript\nTagsApi.getTagTagGroup(id: string, options)\n```\n##### Method alias:\n```typescript\nTagsApi.getGroupForTag(id: string, options)\n```\n_______________________________\n\n[Get Tag Group ID for Tag](https://developers.klaviyo.com/en/v2025-01-15/reference/get_tag_group_id_for_tag)\n\n```typescript\nTagsApi.getTagGroupIdForTag(id: string)\n```\n##### Method alias:\n```typescript\nTagsApi.getTagRelationshipsTagGroup(id: string)\n```\n##### Method alias:\n```typescript\nTagsApi.getGroupIdForTag(id: string)\n```\n##### Method alias:\n```typescript\nTagsApi.getTagRelationshipsGroup(id: string)\n```\n_______________________________\n\n[Get Tag Groups](https://developers.klaviyo.com/en/v2025-01-15/reference/get_tag_groups)\n\n```typescript\nTagsApi.getTagGroups(options)\n```\n_______________________________\n\n[Get Tag IDs for Tag Group](https://developers.klaviyo.com/en/v2025-01-15/reference/get_tag_ids_for_tag_group)\n\n```typescript\nTagsApi.getTagIdsForTagGroup(id: string)\n```\n##### Method alias:\n```typescript\nTagsApi.getTagGroupRelationshipsTags(id: string)\n```\n_______________________________\n\n[Get Tags](https://developers.klaviyo.com/en/v2025-01-15/reference/get_tags)\n\n```typescript\nTagsApi.getTags(options)\n```\n_______________________________\n\n[Get Tags for Tag Group](https://developers.klaviyo.com/en/v2025-01-15/reference/get_tags_for_tag_group)\n\n```typescript\nTagsApi.getTagsForTagGroup(id: string, options)\n```\n##### Method alias:\n```typescript\nTagsApi.getTagGroupTags(id: string, options)\n```\n_______________________________\n\n[Remove Ta","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fklaviyo%2Fklaviyo-api-node","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fklaviyo%2Fklaviyo-api-node","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fklaviyo%2Fklaviyo-api-node/lists"}