@outseta/api-client 0.1.1 → 0.2.1

package/src/generated/models/usageAddUsageBody.ts

@@ -0,0 +1,227 @@
+// @ts-nocheck
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * Outseta API
+ * # Outseta REST API
+
+The Outseta REST API enables you to perform a variety of powerful tasks such as creating and updating people, accounts, subscriptions, and invoices. Outseta uses standard HTTP protocols within a compliant architecture that is simple to integrate. You can use the API both on the client or the server side; see the authentication section below for each scenario.
+
+**Base URL:** `https://{your-domain}.outseta.com/api/v1/`
+
+## API Guidelines
+
+1. The API will only respond to secured communication done over **HTTPS**. HTTP requests will be sent a `301` redirect to the corresponding HTTPS resource.
+2. Responses are sent in **JSON** format. In case the API request results in an error, it is represented by an `"error": {}` key in the JSON response.
+3. The request method (verb) determines the nature of the action: **GET** fetches data, **POST** creates new records, **PUT** updates existing records.
+4. The API responds with appropriate **HTTP status codes** for all requests.
+5. Use `donotlog=1` as a query parameter on any API call where you don't want the action to be logged in the activity log.
+
+## Authentication
+
+All API requests require authentication via one of two methods:
+
+### Server-Side (API Keys)
+
+Use API keys for server-to-server integrations. Create keys at **Settings > Integrations > API Keys**. Make sure to record the secret key when you create it.
+
+```
+Authorization: Outseta {api_key}:{api_secret}
+```
+
+**Example:**
+```
+Authorization: Outseta ce08fd5a-e1ee-4472-9c5f-b7575d8369b2:74fc1d2242a4eb7336d34b0e40cfbc5f
+```
+
+> **Warning:** Never expose API keys in client-side code. The API key and secret combined give full access to all data in your account.
+
+### Client-Side (Bearer Token)
+
+Do **not** use API keys on the client side — they can be easily copied. Instead, obtain a JWT access token by calling the `POST /tokens` endpoint from the server side with your credentials, then use it on the client:
+
+```
+Authorization: bearer {access_token}
+```
+
+Tokens are JWTs containing claims such as `PersonUid`, `AccountUid`, and subscription details. Tokens expire after approximately one year.
+
+Verify tokens server-side using Outseta's [JWKS endpoint](https://{your-domain}.outseta.com/.well-known/jwks.json).
+
+## Field Selection
+
+When you make an API request, you'll automatically get all the basic information from the main object and its immediate child objects. Referenced objects beyond the first level are returned as `null`.
+
+Change this behavior using the `fields` query parameter:
+
+- **Go deeper** — Request fields lower down in the object tree: `?fields=CurrentSubscription.Plan.*`
+- **Go lighter** — Request only the essentials for faster performance: `?fields=Uid,Name`
+- **Combination** — `?fields=Uid,Name,CurrentSubscription.Plan.Uid`
+- **Wildcard** — Use `*` to get all fields in an object: `?fields=*` or `?fields=CurrentSubscription.Plan.*`
+
+> **Tip:** When expanding nested paths, include `*` and intermediate path segments (e.g., `PersonAccount.*`) to preserve root-level and intermediate fields.
+
+**Examples:**
+
+```
+# Get the current subscription plan UID for an account
+GET /crm/accounts/{uid}?fields=CurrentSubscription.Plan.Uid
+
+# Get the account UID and plan UID for a list of accounts
+GET /crm/accounts?fields=Uid,CurrentSubscription.Plan.Uid
+
+# Get the full plan object for an account's current subscription
+GET /crm/accounts/{uid}?fields=CurrentSubscription.Plan.*
+
+# Get a person with their account and subscription info
+GET /crm/people/{uid}?fields=Uid,PersonAccount.Account.CurrentSubscription.Plan.Uid
+```
+
+If your request includes fields from a child object you will be limited to retrieving **25 items** per page. The maximum for requests not expanding child object fields is **100 items**.
+
+## Pagination
+
+List endpoints return paginated results with a `metadata` object and an `items` array:
+
+```json
+{
+  "metadata": {
+    "limit": 25,
+    "offset": 0,
+    "total": 142
+  },
+  "items": [ ... ]
+}
+```
+
+| Parameter | Type | Default | Description |
+|-----------|------|---------|-------------|
+| `offset` | integer | `0` | Page number (zero-based) |
+| `limit` | integer | `25` | Maximum number of records per page |
+
+**Examples:**
+```
+?offset=0&limit=20    # returns results 1-20
+?offset=1&limit=20    # returns results 21-40
+```
+
+## Sorting
+
+Sort results using the `orderBy` parameter with a property name and direction:
+
+```
+?orderBy=PropertyName+DESC
+```
+
+## Filtering
+
+Filter results by passing entity properties as query parameters.
+
+### Basic Filtering
+
+Filter on any field using the field name as a query parameter:
+
+```
+GET /crm/people?Email=john@example.com
+GET /crm/accounts?AccountStage=2
+```
+
+### Wildcard Matching
+
+| Pattern | Match Type | Example |
+|---------|-----------|---------|
+| `*value` | Ends with | `?Email=*@example.com` |
+| `value*` | Starts with | `?Name=Acme*` |
+| `*value*` | Contains | `?Name=*corp*` |
+
+### Comparison Operators
+
+For advanced filtering, append comparison operators to field names:
+
+| Operator | Description | Example |
+|----------|-------------|---------|
+| `__gt` | Greater than | `Created__gt=2024-01-01` |
+| `__gte` | Greater than or equal | `Amount__gte=100` |
+| `__lt` | Less than | `Created__lt=2024-12-31` |
+| `__lte` | Less than or equal | `Amount__lte=500` |
+| `__ne` | Not equal | `Status__ne=Active` |
+| `__isnull` | Is null (true/false) | `ProfileImageS3Url__isnull=true` |
+
+**Examples:**
+
+```
+# Date filtering
+GET /crm/accounts?Created__gt=2024-01-01
+GET /billing/subscriptions?EndDate__lt=2024-08-01
+
+# Numeric filtering
+GET /billing/invoices?Amount__gte=1000
+
+# Null value filtering
+GET /crm/people?ProfileImageS3Url__isnull=true
+
+# Multiple filters combined with field selection
+GET /billing/subscriptions?StartDate__gte=2024-01-01&Rate__lt=100&DiscountCode__isnull=false&fields=Uid,Amount,StartDate,DiscountCode,Plan.Name
+```
+
+## Account Billing Stages
+
+Account stages reflect the financial standing of each account and are not directly editable — they change automatically based on subscription activity.
+
+| Value | Stage | Description |
+|-------|-------|-------------|
+| `2` | Trialing | Currently on a free trial or free plan |
+| `3` | Subscribing | Active paid subscription (contributes to MRR) |
+| `4` | Canceling | Customer has indicated intent to cancel |
+| `5` | Expired | Subscription has ended after cancellation |
+| `6` | Trial Expired | Free trial ended without conversion to paid |
+
+Filter by stage: `GET /crm/accounts?AccountStage=3` returns all actively subscribing accounts.
+
+## Webhooks
+
+Use **Activity Notifications** to receive real-time callbacks when events occur in Outseta. Configure webhooks at **Settings > Notifications**.
+
+Common events include:
+- `Person Created` / `Person Updated`
+- `Account Created` / `Account Updated`
+- `Subscription Created` / `Subscription Updated`
+
+Always verify webhook signatures using the SHA256 secret provided in the Outseta dashboard.
+
+## Error Responses
+
+| Status Code | Description |
+|-------------|-------------|
+| `200` | Success |
+| `301` | Redirect — HTTP requests are redirected to HTTPS |
+| `400` | Bad request — invalid parameters or Uid format |
+| `401` | Unauthorized — missing or invalid authentication |
+| `404` | Entity not found |
+| `4XX` / `5XX` | Client or server error |
+
+Validation errors return a JSON body with `ErrorMessage` and `PropertyName` fields:
+
+```json
+{
+  "ErrorMessage": "Invalid company email",
+  "PropertyName": "Email"
+}
+```
+
+## Rate Limits
+
+Requests authorized by an API Key should not exceed **4 requests/second**.
+
+## Support
+
+For help regarding the Outseta API please email [support@outseta.com](mailto:support@outseta.com).
+
+ * OpenAPI spec version: v1
+ */
+import type { Usage } from './usage';
+
+/**
+ * @nullable
+ */
+export type UsageAddUsageBody = Usage | null;

package/src/generated/support/support.ts

@@ -220,8 +220,14 @@ For help regarding the Outseta API please email [support@outseta.com](mailto:sup
  * OpenAPI spec version: v1
  */
 import type {
+  Article,
+  ArticleGetAllArticlesParams,
   Case,
-  CaseGetAllCasesParams
+  CaseAddCaseBody,
+  CaseAddCaseParams,
+  CaseGetAllCasesParams,
+  CaseHistory,
+  Category
 } from '.././models';
 
 import { customFetch } from '../../client';
@@ -282,3 +288,337 @@ export const caseGetAllCases = async (params?: CaseGetAllCasesParams, options?:
 );}
 
 
+/**
+ * @summary Adds a case into the support system.
+ */
+export type caseAddCaseResponse200 = {
+  data: Case
+  status: 200
+}
+
+export type caseAddCaseResponse401 = {
+  data: void
+  status: 401
+}
+    
+export type caseAddCaseResponseSuccess = (caseAddCaseResponse200) & {
+  headers: Headers;
+};
+export type caseAddCaseResponseError = (caseAddCaseResponse401) & {
+  headers: Headers;
+};
+
+export type caseAddCaseResponse = (caseAddCaseResponseSuccess | caseAddCaseResponseError)
+
+export const getCaseAddCaseUrl = (params?: CaseAddCaseParams,) => {
+  const normalizedParams = new URLSearchParams();
+
+  Object.entries(params || {}).forEach(([key, value]) => {
+    
+    if (value !== undefined) {
+      normalizedParams.append(key, value === null ? 'null' : value.toString())
+    }
+  });
+
+  const stringifiedParams = normalizedParams.toString();
+
+  return stringifiedParams.length > 0 ? `/api/v1/support/cases?${stringifiedParams}` : `/api/v1/support/cases`
+}
+
+export const caseAddCase = async (caseAddCaseBody: CaseAddCaseBody,
+    params?: CaseAddCaseParams, options?: RequestInit): Promise<caseAddCaseResponse> => {
+  
+  return customFetch<caseAddCaseResponse>(getCaseAddCaseUrl(params),
+  {      
+    ...options,
+    method: 'POST',
+    headers: { 'Content-Type': 'application/json', ...options?.headers },
+    body: JSON.stringify(
+      caseAddCaseBody,)
+  }
+);}
+
+
+/**
+ * @summary Retrieve a specific case
+ */
+export type caseGetCaseResponse200 = {
+  data: Case
+  status: 200
+}
+
+export type caseGetCaseResponse400 = {
+  data: void
+  status: 400
+}
+
+export type caseGetCaseResponse401 = {
+  data: void
+  status: 401
+}
+
+export type caseGetCaseResponse404 = {
+  data: void
+  status: 404
+}
+    
+export type caseGetCaseResponseSuccess = (caseGetCaseResponse200) & {
+  headers: Headers;
+};
+export type caseGetCaseResponseError = (caseGetCaseResponse400 | caseGetCaseResponse401 | caseGetCaseResponse404) & {
+  headers: Headers;
+};
+
+export type caseGetCaseResponse = (caseGetCaseResponseSuccess | caseGetCaseResponseError)
+
+export const getCaseGetCaseUrl = (caseUid: string | null,) => {
+
+
+  
+
+  return `/api/v1/support/cases/${caseUid}`
+}
+
+export const caseGetCase = async (caseUid: string | null, options?: RequestInit): Promise<caseGetCaseResponse> => {
+  
+  return customFetch<caseGetCaseResponse>(getCaseGetCaseUrl(caseUid),
+  {      
+    ...options,
+    method: 'GET'
+    
+    
+  }
+);}
+
+
+/**
+ * @summary Adds a reply from an agent to a support case.
+ */
+export type caseAddReplyResponse200 = {
+  data: Blob
+  status: 200
+}
+
+export type caseAddReplyResponse400 = {
+  data: void
+  status: 400
+}
+
+export type caseAddReplyResponse401 = {
+  data: void
+  status: 401
+}
+
+export type caseAddReplyResponse404 = {
+  data: void
+  status: 404
+}
+    
+export type caseAddReplyResponseSuccess = (caseAddReplyResponse200) & {
+  headers: Headers;
+};
+export type caseAddReplyResponseError = (caseAddReplyResponse400 | caseAddReplyResponse401 | caseAddReplyResponse404) & {
+  headers: Headers;
+};
+
+export type caseAddReplyResponse = (caseAddReplyResponseSuccess | caseAddReplyResponseError)
+
+export const getCaseAddReplyUrl = (caseUid: string | null,) => {
+
+
+  
+
+  return `/api/v1/support/cases/${caseUid}/replies`
+}
+
+export const caseAddReply = async (caseUid: string | null, options?: RequestInit): Promise<caseAddReplyResponse> => {
+  
+  return customFetch<caseAddReplyResponse>(getCaseAddReplyUrl(caseUid),
+  {      
+    ...options,
+    method: 'POST'
+    
+    
+  }
+);}
+
+
+/**
+ * @summary Adds a response to the case from the person that opened the case.
+ */
+export type caseAddClientResponseResponse200 = {
+  data: CaseHistory
+  status: 200
+}
+
+export type caseAddClientResponseResponse400 = {
+  data: void
+  status: 400
+}
+
+export type caseAddClientResponseResponse401 = {
+  data: void
+  status: 401
+}
+
+export type caseAddClientResponseResponse404 = {
+  data: void
+  status: 404
+}
+    
+export type caseAddClientResponseResponseSuccess = (caseAddClientResponseResponse200) & {
+  headers: Headers;
+};
+export type caseAddClientResponseResponseError = (caseAddClientResponseResponse400 | caseAddClientResponseResponse401 | caseAddClientResponseResponse404) & {
+  headers: Headers;
+};
+
+export type caseAddClientResponseResponse = (caseAddClientResponseResponseSuccess | caseAddClientResponseResponseError)
+
+export const getCaseAddClientResponseUrl = (caseUid: string | null,
+    comment: string | null,) => {
+
+
+  
+
+  return `/api/v1/support/cases/${caseUid}/clientresponse/${comment}`
+}
+
+export const caseAddClientResponse = async (caseUid: string | null,
+    comment: string | null, options?: RequestInit): Promise<caseAddClientResponseResponse> => {
+  
+  return customFetch<caseAddClientResponseResponse>(getCaseAddClientResponseUrl(caseUid,comment),
+  {      
+    ...options,
+    method: 'POST'
+    
+    
+  }
+);}
+
+
+/**
+ * @summary Retrieves all knowledge base articles.
+Matches on title or body of the article"
+ */
+export type articleGetAllArticlesResponse200 = {
+  data: Article[]
+  status: 200
+}
+    
+export type articleGetAllArticlesResponseSuccess = (articleGetAllArticlesResponse200) & {
+  headers: Headers;
+};
+;
+
+export type articleGetAllArticlesResponse = (articleGetAllArticlesResponseSuccess)
+
+export const getArticleGetAllArticlesUrl = (params?: ArticleGetAllArticlesParams,) => {
+  const normalizedParams = new URLSearchParams();
+
+  Object.entries(params || {}).forEach(([key, value]) => {
+    
+    if (value !== undefined) {
+      normalizedParams.append(key, value === null ? 'null' : value.toString())
+    }
+  });
+
+  const stringifiedParams = normalizedParams.toString();
+
+  return stringifiedParams.length > 0 ? `/api/v1/support/articles?${stringifiedParams}` : `/api/v1/support/articles`
+}
+
+export const articleGetAllArticles = async (params?: ArticleGetAllArticlesParams, options?: RequestInit): Promise<articleGetAllArticlesResponse> => {
+  
+  return customFetch<articleGetAllArticlesResponse>(getArticleGetAllArticlesUrl(params),
+  {      
+    ...options,
+    method: 'GET'
+    
+    
+  }
+);}
+
+
+/**
+ * @summary Retrieves a knowledge base article.
+ */
+export type articleGetArticleResponse200 = {
+  data: Article
+  status: 200
+}
+
+export type articleGetArticleResponse400 = {
+  data: void
+  status: 400
+}
+
+export type articleGetArticleResponse404 = {
+  data: void
+  status: 404
+}
+    
+export type articleGetArticleResponseSuccess = (articleGetArticleResponse200) & {
+  headers: Headers;
+};
+export type articleGetArticleResponseError = (articleGetArticleResponse400 | articleGetArticleResponse404) & {
+  headers: Headers;
+};
+
+export type articleGetArticleResponse = (articleGetArticleResponseSuccess | articleGetArticleResponseError)
+
+export const getArticleGetArticleUrl = (articleUid: string | null,) => {
+
+
+  
+
+  return `/api/v1/support/articles/${articleUid}`
+}
+
+export const articleGetArticle = async (articleUid: string | null, options?: RequestInit): Promise<articleGetArticleResponse> => {
+  
+  return customFetch<articleGetArticleResponse>(getArticleGetArticleUrl(articleUid),
+  {      
+    ...options,
+    method: 'GET'
+    
+    
+  }
+);}
+
+
+/**
+ * @summary Retrieves all knowledge base categories.
+ */
+export type categoryGetAllCategoriesResponse200 = {
+  data: Category[]
+  status: 200
+}
+    
+export type categoryGetAllCategoriesResponseSuccess = (categoryGetAllCategoriesResponse200) & {
+  headers: Headers;
+};
+;
+
+export type categoryGetAllCategoriesResponse = (categoryGetAllCategoriesResponseSuccess)
+
+export const getCategoryGetAllCategoriesUrl = () => {
+
+
+  
+
+  return `/api/v1/support/categories`
+}
+
+export const categoryGetAllCategories = async ( options?: RequestInit): Promise<categoryGetAllCategoriesResponse> => {
+  
+  return customFetch<categoryGetAllCategoriesResponse>(getCategoryGetAllCategoriesUrl(),
+  {      
+    ...options,
+    method: 'GET'
+    
+    
+  }
+);}
+
+

package/src/index.ts

@@ -1,5 +1,11 @@
 export { createClient, customFetch } from "./client.js";
-export type { OutsetaCredentials } from "./client.js";
+export type {
+  OutsetaCredentials,
+  OutsetaApiKeyCredentials,
+  OutsetaBearerCredentials,
+  OutsetaClient,
+  OutsetaRequestInit,
+} from "./client.js";
 
 // Re-export generated types and functions once generated
 // export * from "./generated/index.js";