From 0ea3ee6d7d97d844f0746ba7e154e343991fceb6 Mon Sep 17 00:00:00 2001 From: Travis Fischer Date: Tue, 25 Mar 2025 19:26:15 +0800 Subject: [PATCH] feat: add integration tests to openapi-to-ts --- .../fixtures/generated/firecrawl-client.ts | 57 +- .../fixtures/generated/notion-client.ts | 84 +- .../fixtures/generated/pet-store-client.ts | 9 +- .../generated/petstore-expanded-client.ts | 179 + .../fixtures/generated/security-client.ts | 439 + .../fixtures/generated/stripe-client.ts | 19772 +++++++--------- .../fixtures/generated/tic-tac-toe-client.ts | 138 + .../fixtures/openapi/3.1/pet-store.json | 988 - .../fixtures/openapi/3.1/security.json | 397 - .../fixtures/openapi/{3.0 => }/firecrawl.json | 0 .../fixtures/openapi/{3.0 => }/github.json | 0 .../fixtures/openapi/{3.0 => }/notion.json | 0 .../fixtures/openapi/{3.0 => }/pet-store.json | 0 .../openapi/{3.0 => }/petstore-expanded.json | 0 .../fixtures/openapi/{3.0 => }/readme.json | 0 .../fixtures/openapi/{3.0 => }/security.json | 0 .../fixtures/openapi/{3.0 => }/stripe.json | 0 .../openapi/{3.0 => }/tic-tac-toe.json | 0 packages/openapi-to-ts/package.json | 3 +- .../generate-ts-from-openapi.test.ts.snap | 6963 ++++++ .../src/generate-ts-from-openapi.test.ts | 40 + .../src/generate-ts-from-openapi.ts | 5 +- 22 files changed, 16955 insertions(+), 12119 deletions(-) create mode 100644 packages/openapi-to-ts/fixtures/generated/petstore-expanded-client.ts create mode 100644 packages/openapi-to-ts/fixtures/generated/security-client.ts create mode 100644 packages/openapi-to-ts/fixtures/generated/tic-tac-toe-client.ts delete mode 100644 packages/openapi-to-ts/fixtures/openapi/3.1/pet-store.json delete mode 100644 packages/openapi-to-ts/fixtures/openapi/3.1/security.json rename packages/openapi-to-ts/fixtures/openapi/{3.0 => }/firecrawl.json (100%) rename packages/openapi-to-ts/fixtures/openapi/{3.0 => }/github.json (100%) rename packages/openapi-to-ts/fixtures/openapi/{3.0 => }/notion.json (100%) rename packages/openapi-to-ts/fixtures/openapi/{3.0 => }/pet-store.json (100%) rename packages/openapi-to-ts/fixtures/openapi/{3.0 => }/petstore-expanded.json (100%) rename packages/openapi-to-ts/fixtures/openapi/{3.0 => }/readme.json (100%) rename packages/openapi-to-ts/fixtures/openapi/{3.0 => }/security.json (100%) rename packages/openapi-to-ts/fixtures/openapi/{3.0 => }/stripe.json (100%) rename packages/openapi-to-ts/fixtures/openapi/{3.0 => }/tic-tac-toe.json (100%) create mode 100644 packages/openapi-to-ts/src/__snapshots__/generate-ts-from-openapi.test.ts.snap create mode 100644 packages/openapi-to-ts/src/generate-ts-from-openapi.test.ts diff --git a/packages/openapi-to-ts/fixtures/generated/firecrawl-client.ts b/packages/openapi-to-ts/fixtures/generated/firecrawl-client.ts index 32ae615..267e1dc 100644 --- a/packages/openapi-to-ts/fixtures/generated/firecrawl-client.ts +++ b/packages/openapi-to-ts/fixtures/generated/firecrawl-client.ts @@ -5,7 +5,13 @@ * This file was auto-generated from an OpenAPI spec. */ -import { aiFunction, AIFunctionsProvider, assert, getEnv } from '@agentic/core' +import { + aiFunction, + AIFunctionsProvider, + assert, + getEnv, + pick +} from '@agentic/core' import defaultKy, { type KyInstance } from 'ky' import { z } from 'zod' @@ -21,7 +27,6 @@ export namespace firecrawl { /** Warning message to let you know of any issues. */ warning: z .string() - .nullable() .describe('Warning message to let you know of any issues.') .optional(), data: z @@ -29,7 +34,6 @@ export namespace firecrawl { /** Markdown content of the page if the `markdown` format was specified (default) */ markdown: z .string() - .nullable() .describe( 'Markdown content of the page if the `markdown` format was specified (default)' ) @@ -37,7 +41,6 @@ export namespace firecrawl { /** HTML version of the content on page if the `html` format was specified */ html: z .string() - .nullable() .describe( 'HTML version of the content on page if the `html` format was specified' ) @@ -45,7 +48,6 @@ export namespace firecrawl { /** Raw HTML content of the page if the `rawHtml` format was specified */ rawHtml: z .string() - .nullable() .describe( 'Raw HTML content of the page if the `rawHtml` format was specified' ) @@ -53,13 +55,11 @@ export namespace firecrawl { /** Links on the page if the `links` format was specified */ links: z .array(z.string().url()) - .nullable() .describe('Links on the page if the `links` format was specified') .optional(), /** URL of the screenshot of the page if the `screenshot` or `screenshot@fullSize` format was specified */ screenshot: z .string() - .nullable() .describe( 'URL of the screenshot of the page if the `screenshot` or `screenshot@fullSize` format was specified' ) @@ -68,7 +68,7 @@ export namespace firecrawl { .object({ title: z.string().optional(), description: z.string().optional(), - language: z.string().nullable().optional(), + language: z.string().optional(), sourceURL: z.string().url().optional(), ' ': z.string().optional(), /** The status code of the page */ @@ -80,7 +80,6 @@ export namespace firecrawl { /** The error message of the page */ error: z .string() - .nullable() .describe('The error message of the page') .optional() }) @@ -107,7 +106,6 @@ export namespace firecrawl { /** Markdown content of the page if the `markdown` format was specified (default) */ markdown: z .string() - .nullable() .describe( 'Markdown content of the page if the `markdown` format was specified (default)' ) @@ -115,7 +113,6 @@ export namespace firecrawl { /** HTML version of the content on page if the `html` format was specified */ html: z .string() - .nullable() .describe( 'HTML version of the content on page if the `html` format was specified' ) @@ -123,7 +120,6 @@ export namespace firecrawl { /** Raw HTML content of the page if the `rawHtml` format was specified */ rawHtml: z .string() - .nullable() .describe( 'Raw HTML content of the page if the `rawHtml` format was specified' ) @@ -131,13 +127,11 @@ export namespace firecrawl { /** Links on the page if the `links` format was specified */ links: z .array(z.string().url()) - .nullable() .describe('Links on the page if the `links` format was specified') .optional(), /** URL of the screenshot of the page if the `screenshot` or `screenshot@fullSize` format was specified */ screenshot: z .string() - .nullable() .describe( 'URL of the screenshot of the page if the `screenshot` or `screenshot@fullSize` format was specified' ) @@ -146,7 +140,7 @@ export namespace firecrawl { .object({ title: z.string().optional(), description: z.string().optional(), - language: z.string().nullable().optional(), + language: z.string().optional(), sourceURL: z.string().url().optional(), ' ': z.string().optional(), /** The status code of the page */ @@ -156,11 +150,7 @@ export namespace firecrawl { .describe('The status code of the page') .optional(), /** The error message of the page */ - error: z - .string() - .nullable() - .describe('The error message of the page') - .optional() + error: z.string().describe('The error message of the page').optional() }) .optional() }) @@ -535,7 +525,7 @@ export class FirecrawlClient extends AIFunctionsProvider { */ @aiFunction({ name: 'scrape', - description: 'Scrape a single URL.', + description: `Scrape a single URL.`, inputSchema: firecrawl.ScrapeParamsSchema }) async scrape( @@ -543,7 +533,17 @@ export class FirecrawlClient extends AIFunctionsProvider { ): Promise { return this.ky .post('/scrape', { - json: params + json: pick( + params, + 'url', + 'formats', + 'headers', + 'includeTags', + 'excludeTags', + 'onlyMainContent', + 'timeout', + 'waitFor' + ) }) .json() } @@ -553,7 +553,7 @@ export class FirecrawlClient extends AIFunctionsProvider { */ @aiFunction({ name: 'crawl_urls', - description: 'Crawl multiple URLs based on options.', + description: `Crawl multiple URLs based on options.`, inputSchema: firecrawl.CrawlUrlsParamsSchema }) async crawlUrls( @@ -561,7 +561,7 @@ export class FirecrawlClient extends AIFunctionsProvider { ): Promise { return this.ky .post('/crawl', { - json: params + json: pick(params, 'url', 'crawlerOptions', 'pageOptions') }) .json() } @@ -571,8 +571,7 @@ export class FirecrawlClient extends AIFunctionsProvider { */ @aiFunction({ name: 'search_google', - description: - 'Search for a keyword in Google, returns top page results with markdown content for each page.', + description: `Search for a keyword in Google, returns top page results with markdown content for each page.`, inputSchema: firecrawl.SearchGoogleParamsSchema }) async searchGoogle( @@ -580,7 +579,7 @@ export class FirecrawlClient extends AIFunctionsProvider { ): Promise { return this.ky .post('/search', { - json: params + json: pick(params, 'query', 'pageOptions', 'searchOptions') }) .json() } @@ -590,7 +589,7 @@ export class FirecrawlClient extends AIFunctionsProvider { */ @aiFunction({ name: 'get_crawl_status', - description: 'Get the status of a crawl job.', + description: `Get the status of a crawl job.`, inputSchema: firecrawl.GetCrawlStatusParamsSchema }) async getCrawlStatus( @@ -606,7 +605,7 @@ export class FirecrawlClient extends AIFunctionsProvider { */ @aiFunction({ name: 'cancel_crawl_job', - description: 'Cancel a crawl job.', + description: `Cancel a crawl job.`, inputSchema: firecrawl.CancelCrawlJobParamsSchema }) async cancelCrawlJob( diff --git a/packages/openapi-to-ts/fixtures/generated/notion-client.ts b/packages/openapi-to-ts/fixtures/generated/notion-client.ts index 0d47592..2075bfa 100644 --- a/packages/openapi-to-ts/fixtures/generated/notion-client.ts +++ b/packages/openapi-to-ts/fixtures/generated/notion-client.ts @@ -1506,7 +1506,7 @@ export class NotionClient extends AIFunctionsProvider { */ @aiFunction({ name: 'get_self', - description: 'Get current user.', + description: `Get current user.`, inputSchema: notion.GetSelfParamsSchema }) async getSelf( @@ -1520,7 +1520,7 @@ export class NotionClient extends AIFunctionsProvider { */ @aiFunction({ name: 'get_user', - description: 'Get user.', + description: `Get user.`, inputSchema: notion.GetUserParamsSchema }) async getUser(params: notion.GetUserParams): Promise { @@ -1534,7 +1534,7 @@ export class NotionClient extends AIFunctionsProvider { */ @aiFunction({ name: 'list_users', - description: 'List users.', + description: `List users.`, inputSchema: notion.ListUsersParamsSchema }) async listUsers( @@ -1542,7 +1542,9 @@ export class NotionClient extends AIFunctionsProvider { ): Promise { return this.ky .get('/users', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick(params, 'start_cursor', 'page_size') + ) }) .json() } @@ -1552,7 +1554,7 @@ export class NotionClient extends AIFunctionsProvider { */ @aiFunction({ name: 'create_page', - description: 'Create page.', + description: `Create page.`, inputSchema: notion.CreatePageParamsSchema }) async createPage( @@ -1560,7 +1562,7 @@ export class NotionClient extends AIFunctionsProvider { ): Promise { return this.ky .post('/pages', { - json: params + json: pick(params, 'parent', 'properties') }) .json() } @@ -1570,7 +1572,7 @@ export class NotionClient extends AIFunctionsProvider { */ @aiFunction({ name: 'get_page', - description: 'Get page.', + description: `Get page.`, inputSchema: notion.GetPageParamsSchema }) async getPage(params: notion.GetPageParams): Promise { @@ -1586,7 +1588,7 @@ export class NotionClient extends AIFunctionsProvider { */ @aiFunction({ name: 'update_page', - description: 'Update page.', + description: `Update page.`, inputSchema: notion.UpdatePageParamsSchema }) async updatePage( @@ -1604,7 +1606,7 @@ export class NotionClient extends AIFunctionsProvider { */ @aiFunction({ name: 'get_page_property', - description: 'Get page property.', + description: `Get page property.`, inputSchema: notion.GetPagePropertyParamsSchema }) async getPageProperty( @@ -1624,7 +1626,7 @@ export class NotionClient extends AIFunctionsProvider { */ @aiFunction({ name: 'get_block', - description: 'Get block.', + description: `Get block.`, inputSchema: notion.GetBlockParamsSchema }) async getBlock( @@ -1640,7 +1642,7 @@ export class NotionClient extends AIFunctionsProvider { */ @aiFunction({ name: 'delete_block', - description: 'Delete block.', + description: `Delete block.`, inputSchema: notion.DeleteBlockParamsSchema }) async deleteBlock( @@ -1656,7 +1658,7 @@ export class NotionClient extends AIFunctionsProvider { */ @aiFunction({ name: 'update_block', - description: 'Update block.', + description: `Update block.`, inputSchema: notion.UpdateBlockParamsSchema }) async updateBlock( @@ -1701,7 +1703,7 @@ export class NotionClient extends AIFunctionsProvider { */ @aiFunction({ name: 'list_block_children', - description: 'List block children.', + description: `List block children.`, inputSchema: notion.ListBlockChildrenParamsSchema }) async listBlockChildren( @@ -1721,7 +1723,7 @@ export class NotionClient extends AIFunctionsProvider { */ @aiFunction({ name: 'append_block_children', - description: 'Append block children.', + description: `Append block children.`, inputSchema: notion.AppendBlockChildrenParamsSchema }) async appendBlockChildren( @@ -1739,7 +1741,7 @@ export class NotionClient extends AIFunctionsProvider { */ @aiFunction({ name: 'get_database', - description: 'Get database.', + description: `Get database.`, inputSchema: notion.GetDatabaseParamsSchema }) async getDatabase( @@ -1755,7 +1757,7 @@ export class NotionClient extends AIFunctionsProvider { */ @aiFunction({ name: 'update_database', - description: 'Update database.', + description: `Update database.`, inputSchema: notion.UpdateDatabaseParamsSchema }) async updateDatabase( @@ -1782,7 +1784,7 @@ export class NotionClient extends AIFunctionsProvider { */ @aiFunction({ name: 'query_database', - description: 'Query database.', + description: `Query database.`, inputSchema: notion.QueryDatabaseParamsSchema }) async queryDatabase( @@ -1808,7 +1810,7 @@ export class NotionClient extends AIFunctionsProvider { */ @aiFunction({ name: 'list_databases', - description: 'List databases.', + description: `List databases.`, inputSchema: notion.ListDatabasesParamsSchema }) async listDatabases( @@ -1816,7 +1818,9 @@ export class NotionClient extends AIFunctionsProvider { ): Promise { return this.ky .get('/databases', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick(params, 'start_cursor', 'page_size') + ) }) .json() } @@ -1826,7 +1830,7 @@ export class NotionClient extends AIFunctionsProvider { */ @aiFunction({ name: 'create_database', - description: 'Create database.', + description: `Create database.`, inputSchema: notion.CreateDatabaseParamsSchema }) async createDatabase( @@ -1834,7 +1838,16 @@ export class NotionClient extends AIFunctionsProvider { ): Promise { return this.ky .post('/databases', { - json: params + json: pick( + params, + 'parent', + 'properties', + 'icon', + 'cover', + 'title', + 'description', + 'is_inline' + ) }) .json() } @@ -1844,13 +1857,20 @@ export class NotionClient extends AIFunctionsProvider { */ @aiFunction({ name: 'search', - description: 'Search.', + description: `Search.`, inputSchema: notion.SearchParamsSchema }) async search(params: notion.SearchParams): Promise { return this.ky .post('/search', { - json: params + json: pick( + params, + 'query', + 'sort', + 'filter', + 'start_cursor', + 'page_size' + ) }) .json() } @@ -1860,7 +1880,7 @@ export class NotionClient extends AIFunctionsProvider { */ @aiFunction({ name: 'list_comments', - description: 'List comments.', + description: `List comments.`, inputSchema: notion.ListCommentsParamsSchema }) async listComments( @@ -1868,7 +1888,9 @@ export class NotionClient extends AIFunctionsProvider { ): Promise { return this.ky .get('/comments', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick(params, 'block_id', 'start_cursor', 'page_size') + ) }) .json() } @@ -1878,7 +1900,7 @@ export class NotionClient extends AIFunctionsProvider { */ @aiFunction({ name: 'create_comment', - description: 'Create comment.', + description: `Create comment.`, // TODO: Improve handling of union params inputSchema: notion.CreateCommentParamsSchema as any }) @@ -1897,7 +1919,7 @@ export class NotionClient extends AIFunctionsProvider { */ @aiFunction({ name: 'oauth_token', - description: 'OAuth token.', + description: `OAuth token.`, inputSchema: notion.OauthTokenParamsSchema }) async oauthToken( @@ -1905,7 +1927,13 @@ export class NotionClient extends AIFunctionsProvider { ): Promise { return this.ky .post('/oauth/token', { - json: params + json: pick( + params, + 'grant_type', + 'code', + 'redirect_uri', + 'external_account' + ) }) .json() } diff --git a/packages/openapi-to-ts/fixtures/generated/pet-store-client.ts b/packages/openapi-to-ts/fixtures/generated/pet-store-client.ts index 27122bf..913c09f 100644 --- a/packages/openapi-to-ts/fixtures/generated/pet-store-client.ts +++ b/packages/openapi-to-ts/fixtures/generated/pet-store-client.ts @@ -8,6 +8,7 @@ import { aiFunction, AIFunctionsProvider, + pick, sanitizeSearchParams } from '@agentic/core' import defaultKy, { type KyInstance } from 'ky' @@ -93,7 +94,7 @@ export class PetStoreClient extends AIFunctionsProvider { */ @aiFunction({ name: 'list_pets', - description: 'List all pets.', + description: `List all pets.`, inputSchema: petstore.ListPetsParamsSchema }) async listPets( @@ -111,7 +112,7 @@ export class PetStoreClient extends AIFunctionsProvider { */ @aiFunction({ name: 'create_pets', - description: 'Create a pet.', + description: `Create a pet.`, inputSchema: petstore.CreatePetsParamsSchema }) async createPets( @@ -119,7 +120,7 @@ export class PetStoreClient extends AIFunctionsProvider { ): Promise { return this.ky .post('/pets', { - json: params + json: pick(params, 'id', 'name', 'tag') }) .json() } @@ -129,7 +130,7 @@ export class PetStoreClient extends AIFunctionsProvider { */ @aiFunction({ name: 'show_pet_by_id', - description: 'Info for a specific pet.', + description: `Info for a specific pet.`, inputSchema: petstore.ShowPetByIdParamsSchema }) async showPetById( diff --git a/packages/openapi-to-ts/fixtures/generated/petstore-expanded-client.ts b/packages/openapi-to-ts/fixtures/generated/petstore-expanded-client.ts new file mode 100644 index 0000000..b8f73db --- /dev/null +++ b/packages/openapi-to-ts/fixtures/generated/petstore-expanded-client.ts @@ -0,0 +1,179 @@ +/* eslint-disable unicorn/no-unreadable-iife */ +/* eslint-disable unicorn/no-array-reduce */ + +/** + * This file was auto-generated from an OpenAPI spec. + */ + +import { + aiFunction, + AIFunctionsProvider, + pick, + sanitizeSearchParams +} from '@agentic/core' +import defaultKy, { type KyInstance } from 'ky' +import { z } from 'zod' + +export namespace petstoreexpanded { + export const apiBaseUrl = 'http://petstore.swagger.io/api' + + // ----------------------------------------------------------------------------- + // Component schemas + // ----------------------------------------------------------------------------- + + export const NewPetSchema = z.object({ + name: z.string(), + tag: z.string().optional() + }) + export type NewPet = z.infer + + export const PetSchema = z.intersection( + NewPetSchema, + z.object({ id: z.number().int() }) + ) + export type Pet = z.infer + + // ----------------------------------------------------------------------------- + // Operation schemas + // ----------------------------------------------------------------------------- + + export const FindPetsParamsSchema = z.object({ + /** tags to filter by */ + tags: z.array(z.string()).describe('tags to filter by').optional(), + /** maximum number of results to return */ + limit: z + .number() + .int() + .describe('maximum number of results to return') + .optional() + }) + export type FindPetsParams = z.infer + + export const FindPetsResponseSchema = z.array(PetSchema) + export type FindPetsResponse = z.infer + + export const AddPetParamsSchema = NewPetSchema + export type AddPetParams = z.infer + + export const AddPetResponseSchema = PetSchema + export type AddPetResponse = z.infer + + export const FindPetByIdParamsSchema = z.object({ + /** ID of pet to fetch */ + id: z.number().int().describe('ID of pet to fetch') + }) + export type FindPetByIdParams = z.infer + + export const FindPetByIdResponseSchema = PetSchema + export type FindPetByIdResponse = z.infer + + export const DeletePetParamsSchema = z.object({ + /** ID of pet to delete */ + id: z.number().int().describe('ID of pet to delete') + }) + export type DeletePetParams = z.infer + + export type DeletePetResponse = undefined +} + +/** + * Agentic PetstoreExpanded client. + * + * A sample API that uses a petstore as an example to demonstrate features in the OpenAPI 3.0 specification. + */ +export class PetstoreExpandedClient extends AIFunctionsProvider { + protected readonly ky: KyInstance + + protected readonly apiBaseUrl: string + + constructor({ + apiBaseUrl = petstoreexpanded.apiBaseUrl, + ky = defaultKy + }: { + apiKey?: string + apiBaseUrl?: string + ky?: KyInstance + } = {}) { + super() + + this.apiBaseUrl = apiBaseUrl + + this.ky = ky.extend({ + prefixUrl: apiBaseUrl + }) + } + + /** + * Returns all pets from the system that the user has access to +Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia. + +Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien. + */ + @aiFunction({ + name: 'find_pets', + description: `Returns all pets from the system that the user has access to +Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia. + +Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.`, + inputSchema: petstoreexpanded.FindPetsParamsSchema + }) + async findPets( + params: petstoreexpanded.FindPetsParams + ): Promise { + return this.ky + .get('/pets', { + searchParams: sanitizeSearchParams(pick(params, 'tags', 'limit')) + }) + .json() + } + + /** + * Creates a new pet in the store. Duplicates are allowed. + */ + @aiFunction({ + name: 'add_pet', + description: `Creates a new pet in the store. Duplicates are allowed.`, + inputSchema: petstoreexpanded.AddPetParamsSchema + }) + async addPet( + params: petstoreexpanded.AddPetParams + ): Promise { + return this.ky + .post('/pets', { + json: pick(params, 'name', 'tag') + }) + .json() + } + + /** + * Returns a user based on a single ID, if the user does not have access to the pet. + */ + @aiFunction({ + name: 'find_pet_by_id', + description: `Returns a user based on a single ID, if the user does not have access to the pet.`, + inputSchema: petstoreexpanded.FindPetByIdParamsSchema + }) + async findPetById( + params: petstoreexpanded.FindPetByIdParams + ): Promise { + return this.ky + .get(`/pets/${params.id}`) + .json() + } + + /** + * deletes a single pet based on the ID supplied. + */ + @aiFunction({ + name: 'delete_pet', + description: `deletes a single pet based on the ID supplied.`, + inputSchema: petstoreexpanded.DeletePetParamsSchema + }) + async deletePet( + params: petstoreexpanded.DeletePetParams + ): Promise { + return this.ky + .delete(`/pets/${params.id}`) + .json() + } +} diff --git a/packages/openapi-to-ts/fixtures/generated/security-client.ts b/packages/openapi-to-ts/fixtures/generated/security-client.ts new file mode 100644 index 0000000..224103d --- /dev/null +++ b/packages/openapi-to-ts/fixtures/generated/security-client.ts @@ -0,0 +1,439 @@ +/* eslint-disable unicorn/no-unreadable-iife */ +/* eslint-disable unicorn/no-array-reduce */ + +/** + * This file was auto-generated from an OpenAPI spec. + */ + +import { aiFunction,AIFunctionsProvider } from '@agentic/core' +import defaultKy, { type KyInstance } from 'ky' +import { z } from 'zod' + +export namespace security { + export const apiBaseUrl = 'https://httpbin.org' + + // ----------------------------------------------------------------------------- + // Operation schemas + // ----------------------------------------------------------------------------- + + export const GetAnythingApiKeyParamsSchema = z.object({}) + export type GetAnythingApiKeyParams = z.infer< + typeof GetAnythingApiKeyParamsSchema + > + + export type GetAnythingApiKeyResponse = undefined + + export const PostAnythingApiKeyParamsSchema = z.object({}) + export type PostAnythingApiKeyParams = z.infer< + typeof PostAnythingApiKeyParamsSchema + > + + export type PostAnythingApiKeyResponse = undefined + + export const PutAnythingApiKeyParamsSchema = z.object({}) + export type PutAnythingApiKeyParams = z.infer< + typeof PutAnythingApiKeyParamsSchema + > + + export type PutAnythingApiKeyResponse = undefined + + export const PostAnythingBasicParamsSchema = z.object({}) + export type PostAnythingBasicParams = z.infer< + typeof PostAnythingBasicParamsSchema + > + + export type PostAnythingBasicResponse = undefined + + export const PostAnythingBearerParamsSchema = z.object({}) + export type PostAnythingBearerParams = z.infer< + typeof PostAnythingBearerParamsSchema + > + + export type PostAnythingBearerResponse = undefined + + export const PutAnythingBearerParamsSchema = z.object({}) + export type PutAnythingBearerParams = z.infer< + typeof PutAnythingBearerParamsSchema + > + + export type PutAnythingBearerResponse = undefined + + export const GetAnythingOauth2ParamsSchema = z.object({}) + export type GetAnythingOauth2Params = z.infer< + typeof GetAnythingOauth2ParamsSchema + > + + export type GetAnythingOauth2Response = undefined + + export const PostAnythingOauth2ParamsSchema = z.object({}) + export type PostAnythingOauth2Params = z.infer< + typeof PostAnythingOauth2ParamsSchema + > + + export type PostAnythingOauth2Response = undefined + + export const PutAnythingOauth2ParamsSchema = z.object({}) + export type PutAnythingOauth2Params = z.infer< + typeof PutAnythingOauth2ParamsSchema + > + + export type PutAnythingOauth2Response = undefined + + export const DeleteAnythingOauth2ParamsSchema = z.object({}) + export type DeleteAnythingOauth2Params = z.infer< + typeof DeleteAnythingOauth2ParamsSchema + > + + export type DeleteAnythingOauth2Response = undefined + + export const PatchAnythingOauth2ParamsSchema = z.object({}) + export type PatchAnythingOauth2Params = z.infer< + typeof PatchAnythingOauth2ParamsSchema + > + + export type PatchAnythingOauth2Response = undefined + + export const PostAnythingOpenIdConnectParamsSchema = z.object({}) + export type PostAnythingOpenIdConnectParams = z.infer< + typeof PostAnythingOpenIdConnectParamsSchema + > + + export type PostAnythingOpenIdConnectResponse = undefined + + export const PostAnythingNoAuthParamsSchema = z.object({}) + export type PostAnythingNoAuthParams = z.infer< + typeof PostAnythingNoAuthParamsSchema + > + + export type PostAnythingNoAuthResponse = undefined + + export const GetAnythingOptionalAuthParamsSchema = z.object({}) + export type GetAnythingOptionalAuthParams = z.infer< + typeof GetAnythingOptionalAuthParamsSchema + > + + export type GetAnythingOptionalAuthResponse = undefined + + export const PostStatus401ParamsSchema = z.object({}) + export type PostStatus401Params = z.infer + + export type PostStatus401Response = undefined +} + +/** + * Agentic Security client. + * + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#securitySchemeObject. + */ +export class SecurityClient extends AIFunctionsProvider { + protected readonly ky: KyInstance + + protected readonly apiBaseUrl: string + + constructor({ + apiBaseUrl = security.apiBaseUrl, + ky = defaultKy + }: { + apiKey?: string + apiBaseUrl?: string + ky?: KyInstance + } = {}) { + super() + + this.apiBaseUrl = apiBaseUrl + + this.ky = ky.extend({ + prefixUrl: apiBaseUrl + }) + } + + /** + * `apiKey` auth will be supplied within an `apiKey` query parameter. + */ + @aiFunction({ + name: 'get_anything_api_key', + description: `\`apiKey\` auth will be supplied within an \`apiKey\` query parameter.`, + inputSchema: security.GetAnythingApiKeyParamsSchema + }) + async getAnythingApiKey( + _params: security.GetAnythingApiKeyParams + ): Promise { + return this.ky + .get('/anything/apiKey') + .json() + } + + /** + * `apiKey` auth will be supplied within an `api_key` cookie. + */ + @aiFunction({ + name: 'post_anything_api_key', + description: `\`apiKey\` auth will be supplied within an \`api_key\` cookie.`, + inputSchema: security.PostAnythingApiKeyParamsSchema + }) + async postAnythingApiKey( + _params: security.PostAnythingApiKeyParams + ): Promise { + return this.ky + .post('/anything/apiKey') + .json() + } + + /** + * `apiKey` auth will be supplied within an `X-API-KEY` header. + */ + @aiFunction({ + name: 'put_anything_api_key', + description: `\`apiKey\` auth will be supplied within an \`X-API-KEY\` header.`, + inputSchema: security.PutAnythingApiKeyParamsSchema + }) + async putAnythingApiKey( + _params: security.PutAnythingApiKeyParams + ): Promise { + return this.ky + .put('/anything/apiKey') + .json() + } + + /** + * Authentication credentials will be supplied within a `Basic` `Authorization` header. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample. + */ + @aiFunction({ + name: 'post_anything_basic', + description: `Authentication credentials will be supplied within a \`Basic\` \`Authorization\` header. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample.`, + inputSchema: security.PostAnythingBasicParamsSchema + }) + async postAnythingBasic( + _params: security.PostAnythingBasicParams + ): Promise { + return this.ky + .post('/anything/basic') + .json() + } + + /** + * Authentication credentials will be supplied within a `Bearer` `Authorization` header. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample. + */ + @aiFunction({ + name: 'post_anything_bearer', + description: `Authentication credentials will be supplied within a \`Bearer\` \`Authorization\` header. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample.`, + inputSchema: security.PostAnythingBearerParamsSchema + }) + async postAnythingBearer( + _params: security.PostAnythingBearerParams + ): Promise { + return this.ky + .post('/anything/bearer') + .json() + } + + /** + * Authentication credentials will be supplied within a `Bearer` `Authorization` header, but its data should be controlled as a JWT. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample + +> ℹ️ +> We currently do not support any special handling for this so they're handled as a standard `Bearer` authentication token. + */ + @aiFunction({ + name: 'put_anything_bearer', + description: `Authentication credentials will be supplied within a \`Bearer\` \`Authorization\` header, but its data should be controlled as a JWT. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample + +> ℹ️ +> We currently do not support any special handling for this so they're handled as a standard \`Bearer\` authentication token.`, + inputSchema: security.PutAnythingBearerParamsSchema + }) + async putAnythingBearer( + _params: security.PutAnythingBearerParams + ): Promise { + return this.ky + .put('/anything/bearer') + .json() + } + + /** + * > ℹ️ +> We currently do not handle OAuth 2 authentication flows so if an operation has an `oauth2` requirement we assume that the user, or the projects JWT, has a qualified `bearer` token and will use that. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23. + */ + @aiFunction({ + name: 'get_anything_oauth2', + description: `> ℹ️ +> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23.`, + inputSchema: security.GetAnythingOauth2ParamsSchema + }) + async getAnythingOauth2( + _params: security.GetAnythingOauth2Params + ): Promise { + return this.ky + .get('/anything/oauth2') + .json() + } + + /** + * > ℹ️ +> We currently do not handle OAuth 2 authentication flows so if an operation has an `oauth2` requirement we assume that the user, or the projects JWT, has a qualified `bearer` token and will use that. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23. + */ + @aiFunction({ + name: 'post_anything_oauth2', + description: `> ℹ️ +> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23.`, + inputSchema: security.PostAnythingOauth2ParamsSchema + }) + async postAnythingOauth2( + _params: security.PostAnythingOauth2Params + ): Promise { + return this.ky + .post('/anything/oauth2') + .json() + } + + /** + * > ℹ️ +> We currently do not handle OAuth 2 authentication flows so if an operation has an `oauth2` requirement we assume that the user, or the projects JWT, has a qualified `bearer` token and will use that. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23. + */ + @aiFunction({ + name: 'put_anything_oauth2', + description: `> ℹ️ +> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23.`, + inputSchema: security.PutAnythingOauth2ParamsSchema + }) + async putAnythingOauth2( + _params: security.PutAnythingOauth2Params + ): Promise { + return this.ky + .put('/anything/oauth2') + .json() + } + + /** + * > ℹ️ +> We currently do not handle OAuth 2 authentication flows so if an operation has an `oauth2` requirement we assume that the user, or the projects JWT, has a qualified `bearer` token and will use that. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23. + */ + @aiFunction({ + name: 'delete_anything_oauth2', + description: `> ℹ️ +> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23.`, + inputSchema: security.DeleteAnythingOauth2ParamsSchema + }) + async deleteAnythingOauth2( + _params: security.DeleteAnythingOauth2Params + ): Promise { + return this.ky + .delete('/anything/oauth2') + .json() + } + + /** + * > ℹ️ +> We currently do not handle OAuth 2 authentication flows so if an operation has an `oauth2` requirement we assume that the user, or the projects JWT, has a qualified `bearer` token and will use that. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23. + */ + @aiFunction({ + name: 'patch_anything_oauth2', + description: `> ℹ️ +> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23.`, + inputSchema: security.PatchAnythingOauth2ParamsSchema + }) + async patchAnythingOauth2( + _params: security.PatchAnythingOauth2Params + ): Promise { + return this.ky + .patch('/anything/oauth2') + .json() + } + + /** + * 🚧 This is not supported. + */ + @aiFunction({ + name: 'post_anything_open_id_connect', + description: `🚧 This is not supported.`, + inputSchema: security.PostAnythingOpenIdConnectParamsSchema + }) + async postAnythingOpenIdConnect( + _params: security.PostAnythingOpenIdConnectParams + ): Promise { + return this.ky + .post('/anything/openIdConnect') + .json() + } + + /** + * This operation does not have any authentication requirements. + */ + @aiFunction({ + name: 'post_anything_no_auth', + description: `This operation does not have any authentication requirements.`, + inputSchema: security.PostAnythingNoAuthParamsSchema + }) + async postAnythingNoAuth( + _params: security.PostAnythingNoAuthParams + ): Promise { + return this.ky + .post('/anything/no-auth') + .json() + } + + /** + * The `apiKey` query parameter auth on this operation is optional. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-requirement-object. + */ + @aiFunction({ + name: 'get_anything_optional_auth', + description: `The \`apiKey\` query parameter auth on this operation is optional. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-requirement-object.`, + inputSchema: security.GetAnythingOptionalAuthParamsSchema + }) + async getAnythingOptionalAuth( + _params: security.GetAnythingOptionalAuthParams + ): Promise { + return this.ky + .get('/anything/optional-auth') + .json() + } + + /** + * This endpoint requires an authentication header but making any request to it will forcefully return a 401 status code for invalid auth. + */ + @aiFunction({ + name: 'post_status401', + description: `This endpoint requires an authentication header but making any request to it will forcefully return a 401 status code for invalid auth.`, + inputSchema: security.PostStatus401ParamsSchema + }) + async postStatus401( + _params: security.PostStatus401Params + ): Promise { + return this.ky.post('/status/401').json() + } +} diff --git a/packages/openapi-to-ts/fixtures/generated/stripe-client.ts b/packages/openapi-to-ts/fixtures/generated/stripe-client.ts index b71fa1e..8b97435 100644 --- a/packages/openapi-to-ts/fixtures/generated/stripe-client.ts +++ b/packages/openapi-to-ts/fixtures/generated/stripe-client.ts @@ -24,28 +24,25 @@ export namespace stripe { // ----------------------------------------------------------------------------- export const AccountAnnualRevenueSchema = z.object({ - /** A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal). */ + /**A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal).*/ amount: z .number() .int() - .nullable() .describe( 'A non-negative integer representing the amount in the [smallest currency unit](/currencies#zero-decimal).' ) .optional(), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() - .nullable() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ) .optional(), - /** The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023. */ + /**The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023.*/ fiscal_year_end: z .string() .max(5000) - .nullable() .describe( 'The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023.' ) @@ -54,14 +51,14 @@ export namespace stripe { export type AccountAnnualRevenue = z.infer export const AccountMonthlyEstimatedRevenueSchema = z.object({ - /** A non-negative integer representing how much to charge in the [smallest currency unit](/currencies#zero-decimal). */ + /**A non-negative integer representing how much to charge in the [smallest currency unit](/currencies#zero-decimal).*/ amount: z .number() .int() .describe( 'A non-negative integer representing how much to charge in the [smallest currency unit](/currencies#zero-decimal).' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( @@ -73,424 +70,418 @@ export namespace stripe { > export const AddressSchema = z.object({ - /** City, district, suburb, town, or village. */ + /**City, district, suburb, town, or village.*/ city: z .string() .max(5000) - .nullable() .describe('City, district, suburb, town, or village.') .optional(), - /** Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ + /**Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).*/ country: z .string() .max(5000) - .nullable() .describe( 'Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).' ) .optional(), - /** Address line 1 (e.g., street, PO Box, or company name). */ + /**Address line 1 (e.g., street, PO Box, or company name).*/ line1: z .string() .max(5000) - .nullable() .describe('Address line 1 (e.g., street, PO Box, or company name).') .optional(), - /** Address line 2 (e.g., apartment, suite, unit, or building). */ + /**Address line 2 (e.g., apartment, suite, unit, or building).*/ line2: z .string() .max(5000) - .nullable() .describe('Address line 2 (e.g., apartment, suite, unit, or building).') .optional(), - /** ZIP or postal code. */ + /**ZIP or postal code.*/ postal_code: z .string() .max(5000) - .nullable() .describe('ZIP or postal code.') .optional(), - /** State, county, province, or region. */ + /**State, county, province, or region.*/ state: z .string() .max(5000) - .nullable() .describe('State, county, province, or region.') .optional() }) export type Address = z.infer export const AccountCapabilitiesSchema = z.object({ - /** The status of the Canadian pre-authorized debits payments capability of the account, or whether the account can directly process Canadian pre-authorized debits charges. */ + /**The status of the Canadian pre-authorized debits payments capability of the account, or whether the account can directly process Canadian pre-authorized debits charges.*/ acss_debit_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the Canadian pre-authorized debits payments capability of the account, or whether the account can directly process Canadian pre-authorized debits charges.' ) .optional(), - /** The status of the Affirm capability of the account, or whether the account can directly process Affirm charges. */ + /**The status of the Affirm capability of the account, or whether the account can directly process Affirm charges.*/ affirm_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the Affirm capability of the account, or whether the account can directly process Affirm charges.' ) .optional(), - /** The status of the Afterpay Clearpay capability of the account, or whether the account can directly process Afterpay Clearpay charges. */ + /**The status of the Afterpay Clearpay capability of the account, or whether the account can directly process Afterpay Clearpay charges.*/ afterpay_clearpay_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the Afterpay Clearpay capability of the account, or whether the account can directly process Afterpay Clearpay charges.' ) .optional(), - /** The status of the Alma capability of the account, or whether the account can directly process Alma payments. */ + /**The status of the Alma capability of the account, or whether the account can directly process Alma payments.*/ alma_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the Alma capability of the account, or whether the account can directly process Alma payments.' ) .optional(), - /** The status of the AmazonPay capability of the account, or whether the account can directly process AmazonPay payments. */ + /**The status of the AmazonPay capability of the account, or whether the account can directly process AmazonPay payments.*/ amazon_pay_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the AmazonPay capability of the account, or whether the account can directly process AmazonPay payments.' ) .optional(), - /** The status of the BECS Direct Debit (AU) payments capability of the account, or whether the account can directly process BECS Direct Debit (AU) charges. */ + /**The status of the BECS Direct Debit (AU) payments capability of the account, or whether the account can directly process BECS Direct Debit (AU) charges.*/ au_becs_debit_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the BECS Direct Debit (AU) payments capability of the account, or whether the account can directly process BECS Direct Debit (AU) charges.' ) .optional(), - /** The status of the Bacs Direct Debits payments capability of the account, or whether the account can directly process Bacs Direct Debits charges. */ + /**The status of the Bacs Direct Debits payments capability of the account, or whether the account can directly process Bacs Direct Debits charges.*/ bacs_debit_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the Bacs Direct Debits payments capability of the account, or whether the account can directly process Bacs Direct Debits charges.' ) .optional(), - /** The status of the Bancontact payments capability of the account, or whether the account can directly process Bancontact charges. */ + /**The status of the Bancontact payments capability of the account, or whether the account can directly process Bancontact charges.*/ bancontact_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the Bancontact payments capability of the account, or whether the account can directly process Bancontact charges.' ) .optional(), - /** The status of the customer_balance payments capability of the account, or whether the account can directly process customer_balance charges. */ + /**The status of the customer_balance payments capability of the account, or whether the account can directly process customer_balance charges.*/ bank_transfer_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the customer_balance payments capability of the account, or whether the account can directly process customer_balance charges.' ) .optional(), - /** The status of the blik payments capability of the account, or whether the account can directly process blik charges. */ + /**The status of the blik payments capability of the account, or whether the account can directly process blik charges.*/ blik_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the blik payments capability of the account, or whether the account can directly process blik charges.' ) .optional(), - /** The status of the boleto payments capability of the account, or whether the account can directly process boleto charges. */ + /**The status of the boleto payments capability of the account, or whether the account can directly process boleto charges.*/ boleto_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the boleto payments capability of the account, or whether the account can directly process boleto charges.' ) .optional(), - /** The status of the card issuing capability of the account, or whether you can use Issuing to distribute funds on cards */ + /**The status of the card issuing capability of the account, or whether you can use Issuing to distribute funds on cards*/ card_issuing: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the card issuing capability of the account, or whether you can use Issuing to distribute funds on cards' ) .optional(), - /** The status of the card payments capability of the account, or whether the account can directly process credit and debit card charges. */ + /**The status of the card payments capability of the account, or whether the account can directly process credit and debit card charges.*/ card_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the card payments capability of the account, or whether the account can directly process credit and debit card charges.' ) .optional(), - /** The status of the Cartes Bancaires payments capability of the account, or whether the account can directly process Cartes Bancaires card charges in EUR currency. */ + /**The status of the Cartes Bancaires payments capability of the account, or whether the account can directly process Cartes Bancaires card charges in EUR currency.*/ cartes_bancaires_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the Cartes Bancaires payments capability of the account, or whether the account can directly process Cartes Bancaires card charges in EUR currency.' ) .optional(), - /** The status of the Cash App Pay capability of the account, or whether the account can directly process Cash App Pay payments. */ + /**The status of the Cash App Pay capability of the account, or whether the account can directly process Cash App Pay payments.*/ cashapp_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the Cash App Pay capability of the account, or whether the account can directly process Cash App Pay payments.' ) .optional(), - /** The status of the EPS payments capability of the account, or whether the account can directly process EPS charges. */ + /**The status of the EPS payments capability of the account, or whether the account can directly process EPS charges.*/ eps_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the EPS payments capability of the account, or whether the account can directly process EPS charges.' ) .optional(), - /** The status of the FPX payments capability of the account, or whether the account can directly process FPX charges. */ + /**The status of the FPX payments capability of the account, or whether the account can directly process FPX charges.*/ fpx_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the FPX payments capability of the account, or whether the account can directly process FPX charges.' ) .optional(), - /** The status of the GB customer_balance payments (GBP currency) capability of the account, or whether the account can directly process GB customer_balance charges. */ + /**The status of the GB customer_balance payments (GBP currency) capability of the account, or whether the account can directly process GB customer_balance charges.*/ gb_bank_transfer_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the GB customer_balance payments (GBP currency) capability of the account, or whether the account can directly process GB customer_balance charges.' ) .optional(), - /** The status of the giropay payments capability of the account, or whether the account can directly process giropay charges. */ + /**The status of the giropay payments capability of the account, or whether the account can directly process giropay charges.*/ giropay_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the giropay payments capability of the account, or whether the account can directly process giropay charges.' ) .optional(), - /** The status of the GrabPay payments capability of the account, or whether the account can directly process GrabPay charges. */ + /**The status of the GrabPay payments capability of the account, or whether the account can directly process GrabPay charges.*/ grabpay_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the GrabPay payments capability of the account, or whether the account can directly process GrabPay charges.' ) .optional(), - /** The status of the iDEAL payments capability of the account, or whether the account can directly process iDEAL charges. */ + /**The status of the iDEAL payments capability of the account, or whether the account can directly process iDEAL charges.*/ ideal_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the iDEAL payments capability of the account, or whether the account can directly process iDEAL charges.' ) .optional(), - /** The status of the india_international_payments capability of the account, or whether the account can process international charges (non INR) in India. */ + /**The status of the india_international_payments capability of the account, or whether the account can process international charges (non INR) in India.*/ india_international_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the india_international_payments capability of the account, or whether the account can process international charges (non INR) in India.' ) .optional(), - /** The status of the JCB payments capability of the account, or whether the account (Japan only) can directly process JCB credit card charges in JPY currency. */ + /**The status of the JCB payments capability of the account, or whether the account (Japan only) can directly process JCB credit card charges in JPY currency.*/ jcb_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the JCB payments capability of the account, or whether the account (Japan only) can directly process JCB credit card charges in JPY currency.' ) .optional(), - /** The status of the Japanese customer_balance payments (JPY currency) capability of the account, or whether the account can directly process Japanese customer_balance charges. */ + /**The status of the Japanese customer_balance payments (JPY currency) capability of the account, or whether the account can directly process Japanese customer_balance charges.*/ jp_bank_transfer_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the Japanese customer_balance payments (JPY currency) capability of the account, or whether the account can directly process Japanese customer_balance charges.' ) .optional(), - /** The status of the KakaoPay capability of the account, or whether the account can directly process KakaoPay payments. */ + /**The status of the KakaoPay capability of the account, or whether the account can directly process KakaoPay payments.*/ kakao_pay_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the KakaoPay capability of the account, or whether the account can directly process KakaoPay payments.' ) .optional(), - /** The status of the Klarna payments capability of the account, or whether the account can directly process Klarna charges. */ + /**The status of the Klarna payments capability of the account, or whether the account can directly process Klarna charges.*/ klarna_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the Klarna payments capability of the account, or whether the account can directly process Klarna charges.' ) .optional(), - /** The status of the konbini payments capability of the account, or whether the account can directly process konbini charges. */ + /**The status of the konbini payments capability of the account, or whether the account can directly process konbini charges.*/ konbini_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the konbini payments capability of the account, or whether the account can directly process konbini charges.' ) .optional(), - /** The status of the KrCard capability of the account, or whether the account can directly process KrCard payments. */ + /**The status of the KrCard capability of the account, or whether the account can directly process KrCard payments.*/ kr_card_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the KrCard capability of the account, or whether the account can directly process KrCard payments.' ) .optional(), - /** The status of the legacy payments capability of the account. */ + /**The status of the legacy payments capability of the account.*/ legacy_payments: z .enum(['active', 'inactive', 'pending']) .describe('The status of the legacy payments capability of the account.') .optional(), - /** The status of the link_payments capability of the account, or whether the account can directly process Link charges. */ + /**The status of the link_payments capability of the account, or whether the account can directly process Link charges.*/ link_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the link_payments capability of the account, or whether the account can directly process Link charges.' ) .optional(), - /** The status of the MobilePay capability of the account, or whether the account can directly process MobilePay charges. */ + /**The status of the MobilePay capability of the account, or whether the account can directly process MobilePay charges.*/ mobilepay_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the MobilePay capability of the account, or whether the account can directly process MobilePay charges.' ) .optional(), - /** The status of the Multibanco payments capability of the account, or whether the account can directly process Multibanco charges. */ + /**The status of the Multibanco payments capability of the account, or whether the account can directly process Multibanco charges.*/ multibanco_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the Multibanco payments capability of the account, or whether the account can directly process Multibanco charges.' ) .optional(), - /** The status of the Mexican customer_balance payments (MXN currency) capability of the account, or whether the account can directly process Mexican customer_balance charges. */ + /**The status of the Mexican customer_balance payments (MXN currency) capability of the account, or whether the account can directly process Mexican customer_balance charges.*/ mx_bank_transfer_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the Mexican customer_balance payments (MXN currency) capability of the account, or whether the account can directly process Mexican customer_balance charges.' ) .optional(), - /** The status of the NaverPay capability of the account, or whether the account can directly process NaverPay payments. */ + /**The status of the NaverPay capability of the account, or whether the account can directly process NaverPay payments.*/ naver_pay_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the NaverPay capability of the account, or whether the account can directly process NaverPay payments.' ) .optional(), - /** The status of the OXXO payments capability of the account, or whether the account can directly process OXXO charges. */ + /**The status of the OXXO payments capability of the account, or whether the account can directly process OXXO charges.*/ oxxo_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the OXXO payments capability of the account, or whether the account can directly process OXXO charges.' ) .optional(), - /** The status of the P24 payments capability of the account, or whether the account can directly process P24 charges. */ + /**The status of the P24 payments capability of the account, or whether the account can directly process P24 charges.*/ p24_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the P24 payments capability of the account, or whether the account can directly process P24 charges.' ) .optional(), - /** The status of the pay_by_bank payments capability of the account, or whether the account can directly process pay_by_bank charges. */ + /**The status of the pay_by_bank payments capability of the account, or whether the account can directly process pay_by_bank charges.*/ pay_by_bank_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the pay_by_bank payments capability of the account, or whether the account can directly process pay_by_bank charges.' ) .optional(), - /** The status of the Payco capability of the account, or whether the account can directly process Payco payments. */ + /**The status of the Payco capability of the account, or whether the account can directly process Payco payments.*/ payco_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the Payco capability of the account, or whether the account can directly process Payco payments.' ) .optional(), - /** The status of the paynow payments capability of the account, or whether the account can directly process paynow charges. */ + /**The status of the paynow payments capability of the account, or whether the account can directly process paynow charges.*/ paynow_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the paynow payments capability of the account, or whether the account can directly process paynow charges.' ) .optional(), - /** The status of the promptpay payments capability of the account, or whether the account can directly process promptpay charges. */ + /**The status of the promptpay payments capability of the account, or whether the account can directly process promptpay charges.*/ promptpay_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the promptpay payments capability of the account, or whether the account can directly process promptpay charges.' ) .optional(), - /** The status of the RevolutPay capability of the account, or whether the account can directly process RevolutPay payments. */ + /**The status of the RevolutPay capability of the account, or whether the account can directly process RevolutPay payments.*/ revolut_pay_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the RevolutPay capability of the account, or whether the account can directly process RevolutPay payments.' ) .optional(), - /** The status of the SamsungPay capability of the account, or whether the account can directly process SamsungPay payments. */ + /**The status of the SamsungPay capability of the account, or whether the account can directly process SamsungPay payments.*/ samsung_pay_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the SamsungPay capability of the account, or whether the account can directly process SamsungPay payments.' ) .optional(), - /** The status of the SEPA customer_balance payments (EUR currency) capability of the account, or whether the account can directly process SEPA customer_balance charges. */ + /**The status of the SEPA customer_balance payments (EUR currency) capability of the account, or whether the account can directly process SEPA customer_balance charges.*/ sepa_bank_transfer_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the SEPA customer_balance payments (EUR currency) capability of the account, or whether the account can directly process SEPA customer_balance charges.' ) .optional(), - /** The status of the SEPA Direct Debits payments capability of the account, or whether the account can directly process SEPA Direct Debits charges. */ + /**The status of the SEPA Direct Debits payments capability of the account, or whether the account can directly process SEPA Direct Debits charges.*/ sepa_debit_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the SEPA Direct Debits payments capability of the account, or whether the account can directly process SEPA Direct Debits charges.' ) .optional(), - /** The status of the Sofort payments capability of the account, or whether the account can directly process Sofort charges. */ + /**The status of the Sofort payments capability of the account, or whether the account can directly process Sofort charges.*/ sofort_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the Sofort payments capability of the account, or whether the account can directly process Sofort charges.' ) .optional(), - /** The status of the Swish capability of the account, or whether the account can directly process Swish payments. */ + /**The status of the Swish capability of the account, or whether the account can directly process Swish payments.*/ swish_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the Swish capability of the account, or whether the account can directly process Swish payments.' ) .optional(), - /** The status of the tax reporting 1099-K (US) capability of the account. */ + /**The status of the tax reporting 1099-K (US) capability of the account.*/ tax_reporting_us_1099_k: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the tax reporting 1099-K (US) capability of the account.' ) .optional(), - /** The status of the tax reporting 1099-MISC (US) capability of the account. */ + /**The status of the tax reporting 1099-MISC (US) capability of the account.*/ tax_reporting_us_1099_misc: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the tax reporting 1099-MISC (US) capability of the account.' ) .optional(), - /** The status of the transfers capability of the account, or whether your platform can transfer funds to the account. */ + /**The status of the transfers capability of the account, or whether your platform can transfer funds to the account.*/ transfers: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the transfers capability of the account, or whether your platform can transfer funds to the account.' ) .optional(), - /** The status of the banking capability, or whether the account can have bank accounts. */ + /**The status of the banking capability, or whether the account can have bank accounts.*/ treasury: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the banking capability, or whether the account can have bank accounts.' ) .optional(), - /** The status of the TWINT capability of the account, or whether the account can directly process TWINT charges. */ + /**The status of the TWINT capability of the account, or whether the account can directly process TWINT charges.*/ twint_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the TWINT capability of the account, or whether the account can directly process TWINT charges.' ) .optional(), - /** The status of the US bank account ACH payments capability of the account, or whether the account can directly process US bank account charges. */ + /**The status of the US bank account ACH payments capability of the account, or whether the account can directly process US bank account charges.*/ us_bank_account_ach_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the US bank account ACH payments capability of the account, or whether the account can directly process US bank account charges.' ) .optional(), - /** The status of the US customer_balance payments (USD currency) capability of the account, or whether the account can directly process US customer_balance charges. */ + /**The status of the US customer_balance payments (USD currency) capability of the account, or whether the account can directly process US customer_balance charges.*/ us_bank_transfer_payments: z .enum(['active', 'inactive', 'pending']) .describe( 'The status of the US customer_balance payments (USD currency) capability of the account, or whether the account can directly process US customer_balance charges.' ) .optional(), - /** The status of the Zip capability of the account, or whether the account can directly process Zip charges. */ + /**The status of the Zip capability of the account, or whether the account can directly process Zip charges.*/ zip_payments: z .enum(['active', 'inactive', 'pending']) .describe( @@ -501,71 +492,56 @@ export namespace stripe { export type AccountCapabilities = z.infer export const LegalEntityJapanAddressSchema = z.object({ - /** City/Ward. */ - city: z.string().max(5000).nullable().describe('City/Ward.').optional(), - /** Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ + /**City/Ward.*/ + city: z.string().max(5000).describe('City/Ward.').optional(), + /**Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).*/ country: z .string() .max(5000) - .nullable() .describe( 'Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).' ) .optional(), - /** Block/Building number. */ - line1: z - .string() - .max(5000) - .nullable() - .describe('Block/Building number.') - .optional(), - /** Building details. */ - line2: z - .string() - .max(5000) - .nullable() - .describe('Building details.') - .optional(), - /** ZIP or postal code. */ + /**Block/Building number.*/ + line1: z.string().max(5000).describe('Block/Building number.').optional(), + /**Building details.*/ + line2: z.string().max(5000).describe('Building details.').optional(), + /**ZIP or postal code.*/ postal_code: z .string() .max(5000) - .nullable() .describe('ZIP or postal code.') .optional(), - /** Prefecture. */ - state: z.string().max(5000).nullable().describe('Prefecture.').optional(), - /** Town/cho-me. */ - town: z.string().max(5000).nullable().describe('Town/cho-me.').optional() + /**Prefecture.*/ + state: z.string().max(5000).describe('Prefecture.').optional(), + /**Town/cho-me.*/ + town: z.string().max(5000).describe('Town/cho-me.').optional() }) export type LegalEntityJapanAddress = z.infer< typeof LegalEntityJapanAddressSchema > export const LegalEntityDirectorshipDeclarationSchema = z.object({ - /** The Unix timestamp marking when the directorship declaration attestation was made. */ + /**The Unix timestamp marking when the directorship declaration attestation was made.*/ date: z .number() .int() - .nullable() .describe( 'The Unix timestamp marking when the directorship declaration attestation was made.' ) .optional(), - /** The IP address from which the directorship declaration attestation was made. */ + /**The IP address from which the directorship declaration attestation was made.*/ ip: z .string() .max(5000) - .nullable() .describe( 'The IP address from which the directorship declaration attestation was made.' ) .optional(), - /** The user-agent string from the browser where the directorship declaration attestation was made. */ + /**The user-agent string from the browser where the directorship declaration attestation was made.*/ user_agent: z .string() .max(5000) - .nullable() .describe( 'The user-agent string from the browser where the directorship declaration attestation was made.' ) @@ -576,29 +552,26 @@ export namespace stripe { > export const LegalEntityUboDeclarationSchema = z.object({ - /** The Unix timestamp marking when the beneficial owner attestation was made. */ + /**The Unix timestamp marking when the beneficial owner attestation was made.*/ date: z .number() .int() - .nullable() .describe( 'The Unix timestamp marking when the beneficial owner attestation was made.' ) .optional(), - /** The IP address from which the beneficial owner attestation was made. */ + /**The IP address from which the beneficial owner attestation was made.*/ ip: z .string() .max(5000) - .nullable() .describe( 'The IP address from which the beneficial owner attestation was made.' ) .optional(), - /** The user-agent string from the browser where the beneficial owner attestation was made. */ + /**The user-agent string from the browser where the beneficial owner attestation was made.*/ user_agent: z .string() .max(5000) - .nullable() .describe( 'The user-agent string from the browser where the beneficial owner attestation was made.' ) @@ -609,7 +582,7 @@ export namespace stripe { > export const AccountUnificationAccountControllerFeesSchema = z.object({ - /** A value indicating the responsible payer of a bundle of Stripe fees for pricing-control eligible products on this account. Learn more about [fee behavior on connected accounts](https://docs.stripe.com/connect/direct-charges-fee-payer-behavior). */ + /**A value indicating the responsible payer of a bundle of Stripe fees for pricing-control eligible products on this account. Learn more about [fee behavior on connected accounts](https://docs.stripe.com/connect/direct-charges-fee-payer-behavior).*/ payer: z .enum([ 'account', @@ -626,7 +599,7 @@ export namespace stripe { > export const AccountUnificationAccountControllerLossesSchema = z.object({ - /** A value indicating who is liable when this account can't pay back negative balances from payments. */ + /**A value indicating who is liable when this account can't pay back negative balances from payments.*/ payments: z .enum(['application', 'stripe']) .describe( @@ -639,7 +612,7 @@ export namespace stripe { export const AccountUnificationAccountControllerStripeDashboardSchema = z.object({ - /** A value indicating the Stripe dashboard this account has access to independent of the Connect application. */ + /**A value indicating the Stripe dashboard this account has access to independent of the Connect application.*/ type: z .enum(['express', 'full', 'none']) .describe( @@ -651,13 +624,13 @@ export namespace stripe { > export const CustomerBalanceCustomerBalanceSettingsSchema = z.object({ - /** The configuration for how funds that land in the customer cash balance are reconciled. */ + /**The configuration for how funds that land in the customer cash balance are reconciled.*/ reconciliation_mode: z .enum(['automatic', 'manual']) .describe( 'The configuration for how funds that land in the customer cash balance are reconciled.' ), - /** A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance */ + /**A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance*/ using_merchant_default: z .boolean() .describe( @@ -669,11 +642,11 @@ export namespace stripe { > export const DeletedCustomerSchema = z.object({ - /** Always true for a deleted object */ + /**Always true for a deleted object*/ deleted: z.literal(true).describe('Always true for a deleted object'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('customer') .describe( @@ -683,11 +656,10 @@ export namespace stripe { export type DeletedCustomer = z.infer export const TokenCardNetworksSchema = z.object({ - /** The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card. */ + /**The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card.*/ preferred: z .string() .max(5000) - .nullable() .describe( 'The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card.' ) @@ -696,109 +668,109 @@ export namespace stripe { export type TokenCardNetworks = z.infer export const SourceTypeAchCreditTransferSchema = z.object({ - account_number: z.string().nullable().optional(), - bank_name: z.string().nullable().optional(), - fingerprint: z.string().nullable().optional(), - refund_account_holder_name: z.string().nullable().optional(), - refund_account_holder_type: z.string().nullable().optional(), - refund_routing_number: z.string().nullable().optional(), - routing_number: z.string().nullable().optional(), - swift_code: z.string().nullable().optional() + account_number: z.string().optional(), + bank_name: z.string().optional(), + fingerprint: z.string().optional(), + refund_account_holder_name: z.string().optional(), + refund_account_holder_type: z.string().optional(), + refund_routing_number: z.string().optional(), + routing_number: z.string().optional(), + swift_code: z.string().optional() }) export type SourceTypeAchCreditTransfer = z.infer< typeof SourceTypeAchCreditTransferSchema > export const SourceTypeAchDebitSchema = z.object({ - bank_name: z.string().nullable().optional(), - country: z.string().nullable().optional(), - fingerprint: z.string().nullable().optional(), - last4: z.string().nullable().optional(), - routing_number: z.string().nullable().optional(), - type: z.string().nullable().optional() + bank_name: z.string().optional(), + country: z.string().optional(), + fingerprint: z.string().optional(), + last4: z.string().optional(), + routing_number: z.string().optional(), + type: z.string().optional() }) export type SourceTypeAchDebit = z.infer export const SourceTypeAcssDebitSchema = z.object({ - bank_address_city: z.string().nullable().optional(), - bank_address_line_1: z.string().nullable().optional(), - bank_address_line_2: z.string().nullable().optional(), - bank_address_postal_code: z.string().nullable().optional(), - bank_name: z.string().nullable().optional(), - category: z.string().nullable().optional(), - country: z.string().nullable().optional(), - fingerprint: z.string().nullable().optional(), - last4: z.string().nullable().optional(), - routing_number: z.string().nullable().optional() + bank_address_city: z.string().optional(), + bank_address_line_1: z.string().optional(), + bank_address_line_2: z.string().optional(), + bank_address_postal_code: z.string().optional(), + bank_name: z.string().optional(), + category: z.string().optional(), + country: z.string().optional(), + fingerprint: z.string().optional(), + last4: z.string().optional(), + routing_number: z.string().optional() }) export type SourceTypeAcssDebit = z.infer export const SourceTypeAlipaySchema = z.object({ - data_string: z.string().nullable().optional(), - native_url: z.string().nullable().optional(), - statement_descriptor: z.string().nullable().optional() + data_string: z.string().optional(), + native_url: z.string().optional(), + statement_descriptor: z.string().optional() }) export type SourceTypeAlipay = z.infer export const SourceTypeAuBecsDebitSchema = z.object({ - bsb_number: z.string().nullable().optional(), - fingerprint: z.string().nullable().optional(), - last4: z.string().nullable().optional() + bsb_number: z.string().optional(), + fingerprint: z.string().optional(), + last4: z.string().optional() }) export type SourceTypeAuBecsDebit = z.infer< typeof SourceTypeAuBecsDebitSchema > export const SourceTypeBancontactSchema = z.object({ - bank_code: z.string().nullable().optional(), - bank_name: z.string().nullable().optional(), - bic: z.string().nullable().optional(), - iban_last4: z.string().nullable().optional(), - preferred_language: z.string().nullable().optional(), - statement_descriptor: z.string().nullable().optional() + bank_code: z.string().optional(), + bank_name: z.string().optional(), + bic: z.string().optional(), + iban_last4: z.string().optional(), + preferred_language: z.string().optional(), + statement_descriptor: z.string().optional() }) export type SourceTypeBancontact = z.infer export const SourceTypeCardSchema = z.object({ - address_line1_check: z.string().nullable().optional(), - address_zip_check: z.string().nullable().optional(), - brand: z.string().nullable().optional(), - country: z.string().nullable().optional(), - cvc_check: z.string().nullable().optional(), - dynamic_last4: z.string().nullable().optional(), - exp_month: z.number().int().nullable().optional(), - exp_year: z.number().int().nullable().optional(), + address_line1_check: z.string().optional(), + address_zip_check: z.string().optional(), + brand: z.string().optional(), + country: z.string().optional(), + cvc_check: z.string().optional(), + dynamic_last4: z.string().optional(), + exp_month: z.number().int().optional(), + exp_year: z.number().int().optional(), fingerprint: z.string().optional(), - funding: z.string().nullable().optional(), - last4: z.string().nullable().optional(), - name: z.string().nullable().optional(), + funding: z.string().optional(), + last4: z.string().optional(), + name: z.string().optional(), three_d_secure: z.string().optional(), - tokenization_method: z.string().nullable().optional() + tokenization_method: z.string().optional() }) export type SourceTypeCard = z.infer export const SourceTypeCardPresentSchema = z.object({ application_cryptogram: z.string().optional(), application_preferred_name: z.string().optional(), - authorization_code: z.string().nullable().optional(), + authorization_code: z.string().optional(), authorization_response_code: z.string().optional(), - brand: z.string().nullable().optional(), - country: z.string().nullable().optional(), + brand: z.string().optional(), + country: z.string().optional(), cvm_type: z.string().optional(), - data_type: z.string().nullable().optional(), + data_type: z.string().optional(), dedicated_file_name: z.string().optional(), emv_auth_data: z.string().optional(), - evidence_customer_signature: z.string().nullable().optional(), - evidence_transaction_certificate: z.string().nullable().optional(), - exp_month: z.number().int().nullable().optional(), - exp_year: z.number().int().nullable().optional(), + evidence_customer_signature: z.string().optional(), + evidence_transaction_certificate: z.string().optional(), + exp_month: z.number().int().optional(), + exp_year: z.number().int().optional(), fingerprint: z.string().optional(), - funding: z.string().nullable().optional(), - last4: z.string().nullable().optional(), - pos_device_id: z.string().nullable().optional(), + funding: z.string().optional(), + last4: z.string().optional(), + pos_device_id: z.string().optional(), pos_entry_mode: z.string().optional(), - read_method: z.string().nullable().optional(), - reader: z.string().nullable().optional(), + read_method: z.string().optional(), + reader: z.string().optional(), terminal_verification_results: z.string().optional(), transaction_status_information: z.string().optional() }) @@ -807,14 +779,14 @@ export namespace stripe { > export const SourceCodeVerificationFlowSchema = z.object({ - /** The number of attempts remaining to authenticate the source object with a verification code. */ + /**The number of attempts remaining to authenticate the source object with a verification code.*/ attempts_remaining: z .number() .int() .describe( 'The number of attempts remaining to authenticate the source object with a verification code.' ), - /** The status of the code verification, either `pending` (awaiting verification, `attempts_remaining` should be greater than 0), `succeeded` (successful verification) or `failed` (failed verification, cannot be verified anymore as `attempts_remaining` should be 0). */ + /**The status of the code verification, either `pending` (awaiting verification, `attempts_remaining` should be greater than 0), `succeeded` (successful verification) or `failed` (failed verification, cannot be verified anymore as `attempts_remaining` should be 0).*/ status: z .string() .max(5000) @@ -827,30 +799,30 @@ export namespace stripe { > export const SourceTypeEpsSchema = z.object({ - reference: z.string().nullable().optional(), - statement_descriptor: z.string().nullable().optional() + reference: z.string().optional(), + statement_descriptor: z.string().optional() }) export type SourceTypeEps = z.infer export const SourceTypeGiropaySchema = z.object({ - bank_code: z.string().nullable().optional(), - bank_name: z.string().nullable().optional(), - bic: z.string().nullable().optional(), - statement_descriptor: z.string().nullable().optional() + bank_code: z.string().optional(), + bank_name: z.string().optional(), + bic: z.string().optional(), + statement_descriptor: z.string().optional() }) export type SourceTypeGiropay = z.infer export const SourceTypeIdealSchema = z.object({ - bank: z.string().nullable().optional(), - bic: z.string().nullable().optional(), - iban_last4: z.string().nullable().optional(), - statement_descriptor: z.string().nullable().optional() + bank: z.string().optional(), + bic: z.string().optional(), + iban_last4: z.string().optional(), + statement_descriptor: z.string().optional() }) export type SourceTypeIdeal = z.infer export const SourceTypeKlarnaSchema = z.object({ background_image_url: z.string().optional(), - client_token: z.string().nullable().optional(), + client_token: z.string().optional(), first_name: z.string().optional(), last_name: z.string().optional(), locale: z.string().optional(), @@ -879,63 +851,62 @@ export namespace stripe { export type SourceTypeKlarna = z.infer export const SourceTypeMultibancoSchema = z.object({ - entity: z.string().nullable().optional(), - reference: z.string().nullable().optional(), - refund_account_holder_address_city: z.string().nullable().optional(), - refund_account_holder_address_country: z.string().nullable().optional(), - refund_account_holder_address_line1: z.string().nullable().optional(), - refund_account_holder_address_line2: z.string().nullable().optional(), - refund_account_holder_address_postal_code: z.string().nullable().optional(), - refund_account_holder_address_state: z.string().nullable().optional(), - refund_account_holder_name: z.string().nullable().optional(), - refund_iban: z.string().nullable().optional() + entity: z.string().optional(), + reference: z.string().optional(), + refund_account_holder_address_city: z.string().optional(), + refund_account_holder_address_country: z.string().optional(), + refund_account_holder_address_line1: z.string().optional(), + refund_account_holder_address_line2: z.string().optional(), + refund_account_holder_address_postal_code: z.string().optional(), + refund_account_holder_address_state: z.string().optional(), + refund_account_holder_name: z.string().optional(), + refund_iban: z.string().optional() }) export type SourceTypeMultibanco = z.infer export const SourceTypeP24Schema = z.object({ - reference: z.string().nullable().optional() + reference: z.string().optional() }) export type SourceTypeP24 = z.infer export const SourceReceiverFlowSchema = z.object({ - /** The address of the receiver source. This is the value that should be communicated to the customer to send their funds to. */ + /**The address of the receiver source. This is the value that should be communicated to the customer to send their funds to.*/ address: z .string() .max(5000) - .nullable() .describe( 'The address of the receiver source. This is the value that should be communicated to the customer to send their funds to.' ) .optional(), - /** The total amount that was moved to your balance. This is almost always equal to the amount charged. In rare cases when customers deposit excess funds and we are unable to refund those, those funds get moved to your balance and show up in amount_charged as well. The amount charged is expressed in the source's currency. */ + /**The total amount that was moved to your balance. This is almost always equal to the amount charged. In rare cases when customers deposit excess funds and we are unable to refund those, those funds get moved to your balance and show up in amount_charged as well. The amount charged is expressed in the source's currency.*/ amount_charged: z .number() .int() .describe( "The total amount that was moved to your balance. This is almost always equal to the amount charged. In rare cases when customers deposit excess funds and we are unable to refund those, those funds get moved to your balance and show up in amount_charged as well. The amount charged is expressed in the source's currency." ), - /** The total amount received by the receiver source. `amount_received = amount_returned + amount_charged` should be true for consumed sources unless customers deposit excess funds. The amount received is expressed in the source's currency. */ + /**The total amount received by the receiver source. `amount_received = amount_returned + amount_charged` should be true for consumed sources unless customers deposit excess funds. The amount received is expressed in the source's currency.*/ amount_received: z .number() .int() .describe( "The total amount received by the receiver source. `amount_received = amount_returned + amount_charged` should be true for consumed sources unless customers deposit excess funds. The amount received is expressed in the source's currency." ), - /** The total amount that was returned to the customer. The amount returned is expressed in the source's currency. */ + /**The total amount that was returned to the customer. The amount returned is expressed in the source's currency.*/ amount_returned: z .number() .int() .describe( "The total amount that was returned to the customer. The amount returned is expressed in the source's currency." ), - /** Type of refund attribute method, one of `email`, `manual`, or `none`. */ + /**Type of refund attribute method, one of `email`, `manual`, or `none`.*/ refund_attributes_method: z .string() .max(5000) .describe( 'Type of refund attribute method, one of `email`, `manual`, or `none`.' ), - /** Type of refund attribute status, one of `missing`, `requested`, or `available`. */ + /**Type of refund attribute status, one of `missing`, `requested`, or `available`.*/ refund_attributes_status: z .string() .max(5000) @@ -946,30 +917,29 @@ export namespace stripe { export type SourceReceiverFlow = z.infer export const SourceRedirectFlowSchema = z.object({ - /** The failure reason for the redirect, either `user_abort` (the customer aborted or dropped out of the redirect flow), `declined` (the authentication failed or the transaction was declined), or `processing_error` (the redirect failed due to a technical error). Present only if the redirect status is `failed`. */ + /**The failure reason for the redirect, either `user_abort` (the customer aborted or dropped out of the redirect flow), `declined` (the authentication failed or the transaction was declined), or `processing_error` (the redirect failed due to a technical error). Present only if the redirect status is `failed`.*/ failure_reason: z .string() .max(5000) - .nullable() .describe( 'The failure reason for the redirect, either `user_abort` (the customer aborted or dropped out of the redirect flow), `declined` (the authentication failed or the transaction was declined), or `processing_error` (the redirect failed due to a technical error). Present only if the redirect status is `failed`.' ) .optional(), - /** The URL you provide to redirect the customer to after they authenticated their payment. */ + /**The URL you provide to redirect the customer to after they authenticated their payment.*/ return_url: z .string() .max(5000) .describe( 'The URL you provide to redirect the customer to after they authenticated their payment.' ), - /** The status of the redirect, either `pending` (ready to be used by your customer to authenticate the transaction), `succeeded` (succesful authentication, cannot be reused) or `not_required` (redirect should not be used) or `failed` (failed authentication, cannot be reused). */ + /**The status of the redirect, either `pending` (ready to be used by your customer to authenticate the transaction), `succeeded` (succesful authentication, cannot be reused) or `not_required` (redirect should not be used) or `failed` (failed authentication, cannot be reused).*/ status: z .string() .max(5000) .describe( 'The status of the redirect, either `pending` (ready to be used by your customer to authenticate the transaction), `succeeded` (succesful authentication, cannot be reused) or `not_required` (redirect should not be used) or `failed` (failed authentication, cannot be reused).' ), - /** The URL provided to you to redirect a customer to as part of a `redirect` authentication flow. */ + /**The URL provided to you to redirect a customer to as part of a `redirect` authentication flow.*/ url: z .string() .max(2048) @@ -980,61 +950,57 @@ export namespace stripe { export type SourceRedirectFlow = z.infer export const SourceTypeSepaDebitSchema = z.object({ - bank_code: z.string().nullable().optional(), - branch_code: z.string().nullable().optional(), - country: z.string().nullable().optional(), - fingerprint: z.string().nullable().optional(), - last4: z.string().nullable().optional(), - mandate_reference: z.string().nullable().optional(), - mandate_url: z.string().nullable().optional() + bank_code: z.string().optional(), + branch_code: z.string().optional(), + country: z.string().optional(), + fingerprint: z.string().optional(), + last4: z.string().optional(), + mandate_reference: z.string().optional(), + mandate_url: z.string().optional() }) export type SourceTypeSepaDebit = z.infer export const SourceTypeSofortSchema = z.object({ - bank_code: z.string().nullable().optional(), - bank_name: z.string().nullable().optional(), - bic: z.string().nullable().optional(), - country: z.string().nullable().optional(), - iban_last4: z.string().nullable().optional(), - preferred_language: z.string().nullable().optional(), - statement_descriptor: z.string().nullable().optional() + bank_code: z.string().optional(), + bank_name: z.string().optional(), + bic: z.string().optional(), + country: z.string().optional(), + iban_last4: z.string().optional(), + preferred_language: z.string().optional(), + statement_descriptor: z.string().optional() }) export type SourceTypeSofort = z.infer export const SourceOrderItemSchema = z.object({ - /** The amount (price) for this order item. */ + /**The amount (price) for this order item.*/ amount: z .number() .int() - .nullable() .describe('The amount (price) for this order item.') .optional(), - /** This currency of this order item. Required when `amount` is present. */ + /**This currency of this order item. Required when `amount` is present.*/ currency: z .string() .max(5000) - .nullable() .describe( 'This currency of this order item. Required when `amount` is present.' ) .optional(), - /** Human-readable description for this order item. */ + /**Human-readable description for this order item.*/ description: z .string() .max(5000) - .nullable() .describe('Human-readable description for this order item.') .optional(), - /** The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU). */ + /**The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU).*/ parent: z .string() .max(5000) - .nullable() .describe( 'The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU).' ) .optional(), - /** The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered. */ + /**The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered.*/ quantity: z .number() .int() @@ -1042,11 +1008,10 @@ export namespace stripe { 'The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered.' ) .optional(), - /** The type of this order item. Must be `sku`, `tax`, or `shipping`. */ + /**The type of this order item. Must be `sku`, `tax`, or `shipping`.*/ type: z .string() .max(5000) - .nullable() .describe( 'The type of this order item. Must be `sku`, `tax`, or `shipping`.' ) @@ -1055,23 +1020,23 @@ export namespace stripe { export type SourceOrderItem = z.infer export const SourceTypeThreeDSecureSchema = z.object({ - address_line1_check: z.string().nullable().optional(), - address_zip_check: z.string().nullable().optional(), - authenticated: z.boolean().nullable().optional(), - brand: z.string().nullable().optional(), - card: z.string().nullable().optional(), - country: z.string().nullable().optional(), - customer: z.string().nullable().optional(), - cvc_check: z.string().nullable().optional(), - dynamic_last4: z.string().nullable().optional(), - exp_month: z.number().int().nullable().optional(), - exp_year: z.number().int().nullable().optional(), + address_line1_check: z.string().optional(), + address_zip_check: z.string().optional(), + authenticated: z.boolean().optional(), + brand: z.string().optional(), + card: z.string().optional(), + country: z.string().optional(), + customer: z.string().optional(), + cvc_check: z.string().optional(), + dynamic_last4: z.string().optional(), + exp_month: z.number().int().optional(), + exp_year: z.number().int().optional(), fingerprint: z.string().optional(), - funding: z.string().nullable().optional(), - last4: z.string().nullable().optional(), - name: z.string().nullable().optional(), + funding: z.string().optional(), + last4: z.string().optional(), + name: z.string().optional(), three_d_secure: z.string().optional(), - tokenization_method: z.string().nullable().optional() + tokenization_method: z.string().optional() }) export type SourceTypeThreeDSecure = z.infer< typeof SourceTypeThreeDSecureSchema @@ -1079,13 +1044,13 @@ export namespace stripe { export const SourceTypeWechatSchema = z.object({ prepay_id: z.string().optional(), - qr_code_url: z.string().nullable().optional(), + qr_code_url: z.string().optional(), statement_descriptor: z.string().optional() }) export type SourceTypeWechat = z.infer export const CouponAppliesToSchema = z.object({ - /** A list of product IDs this coupon applies to */ + /**A list of product IDs this coupon applies to*/ products: z .array(z.string().max(5000)) .describe('A list of product IDs this coupon applies to') @@ -1093,7 +1058,7 @@ export namespace stripe { export type CouponAppliesTo = z.infer export const CouponCurrencyOptionSchema = z.object({ - /** Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer. */ + /**Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer.*/ amount_off: z .number() .int() @@ -1104,7 +1069,7 @@ export namespace stripe { export type CouponCurrencyOption = z.infer export const PromotionCodeCurrencyOptionSchema = z.object({ - /** Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work). */ + /**Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).*/ minimum_amount: z .number() .int() @@ -1117,9 +1082,9 @@ export namespace stripe { > export const InvoiceSettingCustomFieldSchema = z.object({ - /** The name of the custom field. */ + /**The name of the custom field.*/ name: z.string().max(5000).describe('The name of the custom field.'), - /** The value of the custom field. */ + /**The value of the custom field.*/ value: z.string().max(5000).describe('The value of the custom field.') }) export type InvoiceSettingCustomField = z.infer< @@ -1127,41 +1092,36 @@ export namespace stripe { > export const PaymentMethodAcssDebitSchema = z.object({ - /** Name of the bank associated with the bank account. */ + /**Name of the bank associated with the bank account.*/ bank_name: z .string() .max(5000) - .nullable() .describe('Name of the bank associated with the bank account.') .optional(), - /** Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /**Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.*/ fingerprint: z .string() .max(5000) - .nullable() .describe( 'Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.' ) .optional(), - /** Institution number of the bank account. */ + /**Institution number of the bank account.*/ institution_number: z .string() .max(5000) - .nullable() .describe('Institution number of the bank account.') .optional(), - /** Last four digits of the bank account number. */ + /**Last four digits of the bank account number.*/ last4: z .string() .max(5000) - .nullable() .describe('Last four digits of the bank account number.') .optional(), - /** Transit number of the bank account. */ + /**Transit number of the bank account.*/ transit_number: z .string() .max(5000) - .nullable() .describe('Transit number of the bank account.') .optional() }) @@ -1191,29 +1151,26 @@ export namespace stripe { > export const PaymentMethodAuBecsDebitSchema = z.object({ - /** Six-digit number identifying bank and branch associated with this bank account. */ + /**Six-digit number identifying bank and branch associated with this bank account.*/ bsb_number: z .string() .max(5000) - .nullable() .describe( 'Six-digit number identifying bank and branch associated with this bank account.' ) .optional(), - /** Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /**Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.*/ fingerprint: z .string() .max(5000) - .nullable() .describe( 'Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.' ) .optional(), - /** Last four digits of the bank account number. */ + /**Last four digits of the bank account number.*/ last4: z .string() .max(5000) - .nullable() .describe('Last four digits of the bank account number.') .optional() }) @@ -1222,27 +1179,24 @@ export namespace stripe { > export const PaymentMethodBacsDebitSchema = z.object({ - /** Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /**Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.*/ fingerprint: z .string() .max(5000) - .nullable() .describe( 'Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.' ) .optional(), - /** Last four digits of the bank account number. */ + /**Last four digits of the bank account number.*/ last4: z .string() .max(5000) - .nullable() .describe('Last four digits of the bank account number.') .optional(), - /** Sort code of the bank account. (e.g., `10-20-30`) */ + /**Sort code of the bank account. (e.g., `10-20-30`)*/ sort_code: z .string() .max(5000) - .nullable() .describe('Sort code of the bank account. (e.g., `10-20-30`)') .optional() }) @@ -1259,7 +1213,7 @@ export namespace stripe { export type PaymentMethodBlik = z.infer export const PaymentMethodBoletoSchema = z.object({ - /** Uniquely identifies the customer tax id (CNPJ or CPF) */ + /**Uniquely identifies the customer tax id (CNPJ or CPF)*/ tax_id: z .string() .max(5000) @@ -1268,29 +1222,26 @@ export namespace stripe { export type PaymentMethodBoleto = z.infer export const PaymentMethodCardChecksSchema = z.object({ - /** If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ + /**If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.*/ address_line1_check: z .string() .max(5000) - .nullable() .describe( 'If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.' ) .optional(), - /** If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ + /**If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.*/ address_postal_code_check: z .string() .max(5000) - .nullable() .describe( 'If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.' ) .optional(), - /** If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ + /**If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.*/ cvc_check: z .string() .max(5000) - .nullable() .describe( 'If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.' ) @@ -1301,17 +1252,15 @@ export namespace stripe { > export const PaymentMethodDetailsCardPresentOfflineSchema = z.object({ - /** Time at which the payment was collected while offline */ + /**Time at which the payment was collected while offline*/ stored_at: z .number() .int() - .nullable() .describe('Time at which the payment was collected while offline') .optional(), - /** The method used to process this payment method offline. Only deferred is allowed. */ + /**The method used to process this payment method offline. Only deferred is allowed.*/ type: z .literal('deferred') - .nullable() .describe( 'The method used to process this payment method offline. Only deferred is allowed.' ) @@ -1322,73 +1271,65 @@ export namespace stripe { > export const PaymentMethodDetailsCardPresentReceiptSchema = z.object({ - /** The type of account being debited or credited */ + /**The type of account being debited or credited*/ account_type: z .enum(['checking', 'credit', 'prepaid', 'unknown']) .describe('The type of account being debited or credited') .optional(), - /** EMV tag 9F26, cryptogram generated by the integrated circuit chip. */ + /**EMV tag 9F26, cryptogram generated by the integrated circuit chip.*/ application_cryptogram: z .string() .max(5000) - .nullable() .describe( 'EMV tag 9F26, cryptogram generated by the integrated circuit chip.' ) .optional(), - /** Mnenomic of the Application Identifier. */ + /**Mnenomic of the Application Identifier.*/ application_preferred_name: z .string() .max(5000) - .nullable() .describe('Mnenomic of the Application Identifier.') .optional(), - /** Identifier for this transaction. */ + /**Identifier for this transaction.*/ authorization_code: z .string() .max(5000) - .nullable() .describe('Identifier for this transaction.') .optional(), - /** EMV tag 8A. A code returned by the card issuer. */ + /**EMV tag 8A. A code returned by the card issuer.*/ authorization_response_code: z .string() .max(5000) - .nullable() .describe('EMV tag 8A. A code returned by the card issuer.') .optional(), - /** Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`. */ + /**Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`.*/ cardholder_verification_method: z .string() .max(5000) - .nullable() .describe( 'Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`.' ) .optional(), - /** EMV tag 84. Similar to the application identifier stored on the integrated circuit chip. */ + /**EMV tag 84. Similar to the application identifier stored on the integrated circuit chip.*/ dedicated_file_name: z .string() .max(5000) - .nullable() .describe( 'EMV tag 84. Similar to the application identifier stored on the integrated circuit chip.' ) .optional(), - /** The outcome of a series of EMV functions performed by the card reader. */ + /**The outcome of a series of EMV functions performed by the card reader.*/ terminal_verification_results: z .string() .max(5000) - .nullable() .describe( 'The outcome of a series of EMV functions performed by the card reader.' ) .optional(), - /** An indication of various EMV functions performed during the transaction. */ + /**An indication of various EMV functions performed during the transaction.*/ transaction_status_information: z .string() .max(5000) - .nullable() .describe( 'An indication of various EMV functions performed during the transaction.' ) @@ -1400,7 +1341,7 @@ export namespace stripe { export const PaymentFlowsPrivatePaymentMethodsCardPresentCommonWalletSchema = z.object({ - /** The type of mobile wallet, one of `apple_pay`, `google_pay`, `samsung_pay`, or `unknown`. */ + /**The type of mobile wallet, one of `apple_pay`, `google_pay`, `samsung_pay`, or `unknown`.*/ type: z .enum(['apple_pay', 'google_pay', 'samsung_pay', 'unknown']) .describe( @@ -1413,16 +1354,15 @@ export namespace stripe { > export const ApplicationSchema = z.object({ - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** The name of the application. */ + /**The name of the application.*/ name: z .string() .max(5000) - .nullable() .describe('The name of the application.') .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('application') .describe( @@ -1455,18 +1395,16 @@ export namespace stripe { export type OfflineAcceptance = z.infer export const OnlineAcceptanceSchema = z.object({ - /** The customer accepts the mandate from this IP address. */ + /**The customer accepts the mandate from this IP address.*/ ip_address: z .string() .max(5000) - .nullable() .describe('The customer accepts the mandate from this IP address.') .optional(), - /** The customer accepts the mandate using the user agent of the browser. */ + /**The customer accepts the mandate using the user agent of the browser.*/ user_agent: z .string() .max(5000) - .nullable() .describe( 'The customer accepts the mandate using the user agent of the browser.' ) @@ -1478,27 +1416,26 @@ export namespace stripe { export type MandateMultiUse = z.infer export const MandateAcssDebitSchema = z.object({ - /** List of Stripe products where this mandate can be selected automatically. */ + /**List of Stripe products where this mandate can be selected automatically.*/ default_for: z .array(z.enum(['invoice', 'subscription'])) .describe( 'List of Stripe products where this mandate can be selected automatically.' ) .optional(), - /** Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. */ + /**Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.*/ interval_description: z .string() .max(5000) - .nullable() .describe( "Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'." ) .optional(), - /** Payment schedule for the mandate. */ + /**Payment schedule for the mandate.*/ payment_schedule: z .enum(['combined', 'interval', 'sporadic']) .describe('Payment schedule for the mandate.'), - /** Transaction type of the mandate. */ + /**Transaction type of the mandate.*/ transaction_type: z .enum(['business', 'personal']) .describe('Transaction type of the mandate.') @@ -1509,7 +1446,7 @@ export namespace stripe { export type MandateAmazonPay = z.infer export const MandateAuBecsDebitSchema = z.object({ - /** The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively. */ + /**The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively.*/ url: z .string() .max(5000) @@ -1520,20 +1457,20 @@ export namespace stripe { export type MandateAuBecsDebit = z.infer export const MandateBacsDebitSchema = z.object({ - /** The status of the mandate on the Bacs network. Can be one of `pending`, `revoked`, `refused`, or `accepted`. */ + /**The status of the mandate on the Bacs network. Can be one of `pending`, `revoked`, `refused`, or `accepted`.*/ network_status: z .enum(['accepted', 'pending', 'refused', 'revoked']) .describe( 'The status of the mandate on the Bacs network. Can be one of `pending`, `revoked`, `refused`, or `accepted`.' ), - /** The unique reference identifying the mandate on the Bacs network. */ + /**The unique reference identifying the mandate on the Bacs network.*/ reference: z .string() .max(5000) .describe( 'The unique reference identifying the mandate on the Bacs network.' ), - /** When the mandate is revoked on the Bacs network this field displays the reason for the revocation. */ + /**When the mandate is revoked on the Bacs network this field displays the reason for the revocation.*/ revocation_reason: z .enum([ 'account_closed', @@ -1542,12 +1479,11 @@ export namespace stripe { 'could_not_process', 'debit_not_authorized' ]) - .nullable() .describe( 'When the mandate is revoked on the Bacs network this field displays the reason for the revocation.' ) .optional(), - /** The URL that will contain the mandate that the customer has signed. */ + /**The URL that will contain the mandate that the customer has signed.*/ url: z .string() .max(5000) @@ -1575,20 +1511,18 @@ export namespace stripe { export type MandateLink = z.infer export const MandatePaypalSchema = z.object({ - /** The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer. */ + /**The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.*/ billing_agreement_id: z .string() .max(5000) - .nullable() .describe( 'The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.' ) .optional(), - /** PayPal account PayerID. This identifier uniquely identifies the PayPal customer. */ + /**PayPal account PayerID. This identifier uniquely identifies the PayPal customer.*/ payer_id: z .string() .max(5000) - .nullable() .describe( 'PayPal account PayerID. This identifier uniquely identifies the PayPal customer.' ) @@ -1600,12 +1534,12 @@ export namespace stripe { export type MandateRevolutPay = z.infer export const MandateSepaDebitSchema = z.object({ - /** The unique reference of the mandate. */ + /**The unique reference of the mandate.*/ reference: z .string() .max(5000) .describe('The unique reference of the mandate.'), - /** The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively. */ + /**The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively.*/ url: z .string() .max(5000) @@ -1616,7 +1550,7 @@ export namespace stripe { export type MandateSepaDebit = z.infer export const MandateUsBankAccountSchema = z.object({ - /** Mandate collection method */ + /**Mandate collection method*/ collection_method: z .literal('paper') .describe('Mandate collection method') @@ -1625,12 +1559,12 @@ export namespace stripe { export type MandateUsBankAccount = z.infer export const MandateSingleUseSchema = z.object({ - /** The amount of the payment on a single use mandate. */ + /**The amount of the payment on a single use mandate.*/ amount: z .number() .int() .describe('The amount of the payment on a single use mandate.'), - /** The currency of the payment on a single use mandate. */ + /**The currency of the payment on a single use mandate.*/ currency: z .string() .describe('The currency of the payment on a single use mandate.') @@ -1643,29 +1577,26 @@ export namespace stripe { > export const SetupAttemptPaymentMethodDetailsCardChecksSchema = z.object({ - /** If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ + /**If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.*/ address_line1_check: z .string() .max(5000) - .nullable() .describe( 'If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.' ) .optional(), - /** If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ + /**If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.*/ address_postal_code_check: z .string() .max(5000) - .nullable() .describe( 'If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.' ) .optional(), - /** If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ + /**If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.*/ cvc_check: z .string() .max(5000) - .nullable() .describe( 'If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.' ) @@ -1682,7 +1613,6 @@ export namespace stripe { */ authentication_flow: z .enum(['challenge', 'frictionless']) - .nullable() .describe( 'For authenticated transactions: how the customer was authenticated by\nthe issuing bank.' ) @@ -1693,12 +1623,11 @@ export namespace stripe { */ electronic_commerce_indicator: z .enum(['01', '02', '05', '06', '07']) - .nullable() .describe( 'The Electronic Commerce Indicator (ECI). A protocol-level field\nindicating what degree of authentication was performed.' ) .optional(), - /** Indicates the outcome of 3D Secure authentication. */ + /**Indicates the outcome of 3D Secure authentication.*/ result: z .enum([ 'attempt_acknowledged', @@ -1708,7 +1637,6 @@ export namespace stripe { 'not_supported', 'processing_error' ]) - .nullable() .describe('Indicates the outcome of 3D Secure authentication.') .optional(), /** @@ -1725,7 +1653,6 @@ export namespace stripe { 'protocol_error', 'rejected' ]) - .nullable() .describe( 'Additional information about why 3D Secure succeeded or failed based\non the `result`.' ) @@ -1737,15 +1664,13 @@ export namespace stripe { transaction_id: z .string() .max(5000) - .nullable() .describe( 'The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID\n(dsTransId) for this payment.' ) .optional(), - /** The version of 3D Secure that was used. */ + /**The version of 3D Secure that was used.*/ version: z .enum(['1.0.2', '2.1.0', '2.2.0']) - .nullable() .describe('The version of 3D Secure that was used.') .optional() }) @@ -1809,7 +1734,7 @@ export namespace stripe { > export const PaymentFlowsAmountDetailsClientResourceTipSchema = z.object({ - /** Portion of the amount that corresponds to a tip. */ + /**Portion of the amount that corresponds to a tip.*/ amount: z .number() .int() @@ -1833,7 +1758,7 @@ export namespace stripe { "Controls whether this PaymentIntent will accept redirect-based payment methods.\n\nRedirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/payment_intents/confirm) this PaymentIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the payment." ) .optional(), - /** Automatically calculates compatible payment methods */ + /**Automatically calculates compatible payment methods*/ enabled: z .boolean() .describe('Automatically calculates compatible payment methods') @@ -1843,35 +1768,29 @@ export namespace stripe { > export const TaxIdVerificationSchema = z.object({ - /** Verification status, one of `pending`, `verified`, `unverified`, or `unavailable`. */ + /**Verification status, one of `pending`, `verified`, `unverified`, or `unavailable`.*/ status: z .enum(['pending', 'unavailable', 'unverified', 'verified']) .describe( 'Verification status, one of `pending`, `verified`, `unverified`, or `unavailable`.' ), - /** Verified address. */ + /**Verified address.*/ verified_address: z .string() .max(5000) - .nullable() .describe('Verified address.') .optional(), - /** Verified name. */ - verified_name: z - .string() - .max(5000) - .nullable() - .describe('Verified name.') - .optional() + /**Verified name.*/ + verified_name: z.string().max(5000).describe('Verified name.').optional() }) export type TaxIdVerification = z.infer export const DeletedTaxIdSchema = z.object({ - /** Always true for a deleted object */ + /**Always true for a deleted object*/ deleted: z.literal(true).describe('Always true for a deleted object'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('tax_id') .describe( @@ -1881,18 +1800,17 @@ export namespace stripe { export type DeletedTaxId = z.infer export const DeletedApplicationSchema = z.object({ - /** Always true for a deleted object */ + /**Always true for a deleted object*/ deleted: z.literal(true).describe('Always true for a deleted object'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** The name of the application. */ + /**The name of the application.*/ name: z .string() .max(5000) - .nullable() .describe('The name of the application.') .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('application') .describe( @@ -1902,31 +1820,29 @@ export namespace stripe { export type DeletedApplication = z.infer export const FeeSchema = z.object({ - /** Amount of the fee, in cents. */ + /**Amount of the fee, in cents.*/ amount: z.number().int().describe('Amount of the fee, in cents.'), - /** ID of the Connect application that earned the fee. */ + /**ID of the Connect application that earned the fee.*/ application: z .string() .max(5000) - .nullable() .describe('ID of the Connect application that earned the fee.') .optional(), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** An arbitrary string attached to the object. Often useful for displaying to users. */ + /**An arbitrary string attached to the object. Often useful for displaying to users.*/ description: z .string() .max(5000) - .nullable() .describe( 'An arbitrary string attached to the object. Often useful for displaying to users.' ) .optional(), - /** Type of the fee, one of: `application_fee`, `payment_method_passthrough_fee`, `stripe_fee` or `tax`. */ + /**Type of the fee, one of: `application_fee`, `payment_method_passthrough_fee`, `stripe_fee` or `tax`.*/ type: z .string() .max(5000) @@ -1938,25 +1854,22 @@ export namespace stripe { export const CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceEuBankTransferSchema = z.object({ - /** The BIC of the bank of the sender of the funding. */ + /**The BIC of the bank of the sender of the funding.*/ bic: z .string() .max(5000) - .nullable() .describe('The BIC of the bank of the sender of the funding.') .optional(), - /** The last 4 digits of the IBAN of the sender of the funding. */ + /**The last 4 digits of the IBAN of the sender of the funding.*/ iban_last4: z .string() .max(5000) - .nullable() .describe('The last 4 digits of the IBAN of the sender of the funding.') .optional(), - /** The full name of the sender, as supplied by the sending bank. */ + /**The full name of the sender, as supplied by the sending bank.*/ sender_name: z .string() .max(5000) - .nullable() .describe( 'The full name of the sender, as supplied by the sending bank.' ) @@ -1969,29 +1882,26 @@ export namespace stripe { export const CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceGbBankTransferSchema = z.object({ - /** The last 4 digits of the account number of the sender of the funding. */ + /**The last 4 digits of the account number of the sender of the funding.*/ account_number_last4: z .string() .max(5000) - .nullable() .describe( 'The last 4 digits of the account number of the sender of the funding.' ) .optional(), - /** The full name of the sender, as supplied by the sending bank. */ + /**The full name of the sender, as supplied by the sending bank.*/ sender_name: z .string() .max(5000) - .nullable() .describe( 'The full name of the sender, as supplied by the sending bank.' ) .optional(), - /** The sort code of the bank of the sender of the funding */ + /**The sort code of the bank of the sender of the funding*/ sort_code: z .string() .max(5000) - .nullable() .describe('The sort code of the bank of the sender of the funding') .optional() }) @@ -2002,25 +1912,22 @@ export namespace stripe { export const CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceJpBankTransferSchema = z.object({ - /** The name of the bank of the sender of the funding. */ + /**The name of the bank of the sender of the funding.*/ sender_bank: z .string() .max(5000) - .nullable() .describe('The name of the bank of the sender of the funding.') .optional(), - /** The name of the bank branch of the sender of the funding. */ + /**The name of the bank branch of the sender of the funding.*/ sender_branch: z .string() .max(5000) - .nullable() .describe('The name of the bank branch of the sender of the funding.') .optional(), - /** The full name of the sender, as supplied by the sending bank. */ + /**The full name of the sender, as supplied by the sending bank.*/ sender_name: z .string() .max(5000) - .nullable() .describe( 'The full name of the sender, as supplied by the sending bank.' ) @@ -2033,16 +1940,15 @@ export namespace stripe { export const CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceUsBankTransferSchema = z.object({ - /** The banking network used for this funding. */ + /**The banking network used for this funding.*/ network: z .enum(['ach', 'domestic_wire_us', 'swift']) .describe('The banking network used for this funding.') .optional(), - /** The full name of the sender, as supplied by the sending bank. */ + /**The full name of the sender, as supplied by the sending bank.*/ sender_name: z .string() .max(5000) - .nullable() .describe( 'The full name of the sender, as supplied by the sending bank.' ) @@ -2059,27 +1965,24 @@ export namespace stripe { > export const RefundDestinationDetailsBlikSchema = z.object({ - /** For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed. */ + /**For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed.*/ network_decline_code: z .string() .max(5000) - .nullable() .describe( 'For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed.' ) .optional(), - /** The reference assigned to the refund. */ + /**The reference assigned to the refund.*/ reference: z .string() .max(5000) - .nullable() .describe('The reference assigned to the refund.') .optional(), - /** Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + /**Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.*/ reference_status: z .string() .max(5000) - .nullable() .describe( 'Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.' ) @@ -2090,18 +1993,16 @@ export namespace stripe { > export const RefundDestinationDetailsBrBankTransferSchema = z.object({ - /** The reference assigned to the refund. */ + /**The reference assigned to the refund.*/ reference: z .string() .max(5000) - .nullable() .describe('The reference assigned to the refund.') .optional(), - /** Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + /**Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.*/ reference_status: z .string() .max(5000) - .nullable() .describe( 'Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.' ) @@ -2112,13 +2013,13 @@ export namespace stripe { > export const RefundDestinationDetailsCardSchema = z.object({ - /** Value of the reference number assigned to the refund. */ + /**Value of the reference number assigned to the refund.*/ reference: z .string() .max(5000) .describe('Value of the reference number assigned to the refund.') .optional(), - /** Status of the reference number on the refund. This can be `pending`, `available` or `unavailable`. */ + /**Status of the reference number on the refund. This can be `pending`, `available` or `unavailable`.*/ reference_status: z .string() .max(5000) @@ -2126,13 +2027,13 @@ export namespace stripe { 'Status of the reference number on the refund. This can be `pending`, `available` or `unavailable`.' ) .optional(), - /** Type of the reference number assigned to the refund. */ + /**Type of the reference number assigned to the refund.*/ reference_type: z .string() .max(5000) .describe('Type of the reference number assigned to the refund.') .optional(), - /** The type of refund. This can be `refund`, `reversal`, or `pending`. */ + /**The type of refund. This can be `refund`, `reversal`, or `pending`.*/ type: z .enum(['pending', 'refund', 'reversal']) .describe( @@ -2144,18 +2045,16 @@ export namespace stripe { > export const RefundDestinationDetailsEuBankTransferSchema = z.object({ - /** The reference assigned to the refund. */ + /**The reference assigned to the refund.*/ reference: z .string() .max(5000) - .nullable() .describe('The reference assigned to the refund.') .optional(), - /** Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + /**Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.*/ reference_status: z .string() .max(5000) - .nullable() .describe( 'Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.' ) @@ -2166,18 +2065,16 @@ export namespace stripe { > export const RefundDestinationDetailsGbBankTransferSchema = z.object({ - /** The reference assigned to the refund. */ + /**The reference assigned to the refund.*/ reference: z .string() .max(5000) - .nullable() .describe('The reference assigned to the refund.') .optional(), - /** Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + /**Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.*/ reference_status: z .string() .max(5000) - .nullable() .describe( 'Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.' ) @@ -2188,18 +2085,16 @@ export namespace stripe { > export const RefundDestinationDetailsJpBankTransferSchema = z.object({ - /** The reference assigned to the refund. */ + /**The reference assigned to the refund.*/ reference: z .string() .max(5000) - .nullable() .describe('The reference assigned to the refund.') .optional(), - /** Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + /**Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.*/ reference_status: z .string() .max(5000) - .nullable() .describe( 'Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.' ) @@ -2210,18 +2105,16 @@ export namespace stripe { > export const RefundDestinationDetailsMultibancoSchema = z.object({ - /** The reference assigned to the refund. */ + /**The reference assigned to the refund.*/ reference: z .string() .max(5000) - .nullable() .describe('The reference assigned to the refund.') .optional(), - /** Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + /**Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.*/ reference_status: z .string() .max(5000) - .nullable() .describe( 'Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.' ) @@ -2232,18 +2125,16 @@ export namespace stripe { > export const RefundDestinationDetailsMxBankTransferSchema = z.object({ - /** The reference assigned to the refund. */ + /**The reference assigned to the refund.*/ reference: z .string() .max(5000) - .nullable() .describe('The reference assigned to the refund.') .optional(), - /** Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + /**Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.*/ reference_status: z .string() .max(5000) - .nullable() .describe( 'Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.' ) @@ -2254,18 +2145,16 @@ export namespace stripe { > export const RefundDestinationDetailsP24Schema = z.object({ - /** The reference assigned to the refund. */ + /**The reference assigned to the refund.*/ reference: z .string() .max(5000) - .nullable() .describe('The reference assigned to the refund.') .optional(), - /** Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + /**Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.*/ reference_status: z .string() .max(5000) - .nullable() .describe( 'Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.' ) @@ -2276,27 +2165,24 @@ export namespace stripe { > export const RefundDestinationDetailsSwishSchema = z.object({ - /** For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed. */ + /**For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed.*/ network_decline_code: z .string() .max(5000) - .nullable() .describe( 'For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed.' ) .optional(), - /** The reference assigned to the refund. */ + /**The reference assigned to the refund.*/ reference: z .string() .max(5000) - .nullable() .describe('The reference assigned to the refund.') .optional(), - /** Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + /**Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.*/ reference_status: z .string() .max(5000) - .nullable() .describe( 'Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.' ) @@ -2307,18 +2193,16 @@ export namespace stripe { > export const RefundDestinationDetailsThBankTransferSchema = z.object({ - /** The reference assigned to the refund. */ + /**The reference assigned to the refund.*/ reference: z .string() .max(5000) - .nullable() .describe('The reference assigned to the refund.') .optional(), - /** Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + /**Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.*/ reference_status: z .string() .max(5000) - .nullable() .describe( 'Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.' ) @@ -2329,18 +2213,16 @@ export namespace stripe { > export const RefundDestinationDetailsUsBankTransferSchema = z.object({ - /** The reference assigned to the refund. */ + /**The reference assigned to the refund.*/ reference: z .string() .max(5000) - .nullable() .describe('The reference assigned to the refund.') .optional(), - /** Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + /**Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.*/ reference_status: z .string() .max(5000) - .nullable() .describe( 'Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.' ) @@ -2351,12 +2233,12 @@ export namespace stripe { > export const EmailSentSchema = z.object({ - /** The timestamp when the email was sent. */ + /**The timestamp when the email was sent.*/ email_sent_at: z .number() .int() .describe('The timestamp when the email was sent.'), - /** The recipient's email address. */ + /**The recipient's email address.*/ email_sent_to: z .string() .max(5000) @@ -2365,48 +2247,42 @@ export namespace stripe { export type EmailSent = z.infer export const DisputeTransactionShippingAddressSchema = z.object({ - /** City, district, suburb, town, or village. */ + /**City, district, suburb, town, or village.*/ city: z .string() .max(5000) - .nullable() .describe('City, district, suburb, town, or village.') .optional(), - /** Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ + /**Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).*/ country: z .string() .max(5000) - .nullable() .describe( 'Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).' ) .optional(), - /** Address line 1 (e.g., street, PO Box, or company name). */ + /**Address line 1 (e.g., street, PO Box, or company name).*/ line1: z .string() .max(5000) - .nullable() .describe('Address line 1 (e.g., street, PO Box, or company name).') .optional(), - /** Address line 2 (e.g., apartment, suite, unit, or building). */ + /**Address line 2 (e.g., apartment, suite, unit, or building).*/ line2: z .string() .max(5000) - .nullable() .describe('Address line 2 (e.g., apartment, suite, unit, or building).') .optional(), - /** ZIP or postal code. */ + /**ZIP or postal code.*/ postal_code: z .string() .max(5000) - .nullable() .describe('ZIP or postal code.') .optional(), - /** State, county, province, or region. */ + /**State, county, province, or region.*/ state: z .string() .max(5000) - .nullable() .describe('State, county, province, or region.') .optional() }) @@ -2415,7 +2291,7 @@ export namespace stripe { > export const DisputeEnhancedEvidenceVisaComplianceSchema = z.object({ - /** A field acknowledging the fee incurred when countering a Visa compliance dispute. If this field is set to true, evidence can be submitted for the compliance dispute. Stripe collects a 500 USD (or local equivalent) amount to cover the network costs associated with resolving compliance disputes. Stripe refunds the 500 USD network fee if you win the dispute. */ + /**A field acknowledging the fee incurred when countering a Visa compliance dispute. If this field is set to true, evidence can be submitted for the compliance dispute. Stripe collects a 500 USD (or local equivalent) amount to cover the network costs associated with resolving compliance disputes. Stripe refunds the 500 USD network fee if you win the dispute.*/ fee_acknowledged: z .boolean() .describe( @@ -2428,7 +2304,7 @@ export namespace stripe { export const DisputeEnhancedEligibilityVisaCompellingEvidence3Schema = z.object({ - /** List of actions required to qualify dispute for Visa Compelling Evidence 3.0 evidence submission. */ + /**List of actions required to qualify dispute for Visa Compelling Evidence 3.0 evidence submission.*/ required_actions: z .array( z.enum([ @@ -2442,7 +2318,7 @@ export namespace stripe { .describe( 'List of actions required to qualify dispute for Visa Compelling Evidence 3.0 evidence submission.' ), - /** Visa Compelling Evidence 3.0 eligibility status. */ + /**Visa Compelling Evidence 3.0 eligibility status.*/ status: z .enum(['not_qualified', 'qualified', 'requires_action']) .describe('Visa Compelling Evidence 3.0 eligibility status.') @@ -2452,7 +2328,7 @@ export namespace stripe { > export const DisputeEnhancedEligibilityVisaComplianceSchema = z.object({ - /** Visa compliance eligibility status. */ + /**Visa compliance eligibility status.*/ status: z .enum(['fee_acknowledged', 'requires_fee_acknowledgement']) .describe('Visa compliance eligibility status.') @@ -2462,10 +2338,9 @@ export namespace stripe { > export const DisputePaymentMethodDetailsAmazonPaySchema = z.object({ - /** The AmazonPay dispute type, chargeback or claim */ + /**The AmazonPay dispute type, chargeback or claim*/ dispute_type: z .enum(['chargeback', 'claim']) - .nullable() .describe('The AmazonPay dispute type, chargeback or claim') .optional() }) @@ -2474,24 +2349,23 @@ export namespace stripe { > export const DisputePaymentMethodDetailsCardSchema = z.object({ - /** Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /**Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.*/ brand: z .string() .max(5000) .describe( 'Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.' ), - /** The type of dispute opened. Different case types may have varying fees and financial impact. */ + /**The type of dispute opened. Different case types may have varying fees and financial impact.*/ case_type: z .enum(['chargeback', 'inquiry']) .describe( 'The type of dispute opened. Different case types may have varying fees and financial impact.' ), - /** The card network's specific dispute reason code, which maps to one of Stripe's primary dispute categories to simplify response guidance. The [Network code map](https://stripe.com/docs/disputes/categories#network-code-map) lists all available dispute reason codes by network. */ + /**The card network's specific dispute reason code, which maps to one of Stripe's primary dispute categories to simplify response guidance. The [Network code map](https://stripe.com/docs/disputes/categories#network-code-map) lists all available dispute reason codes by network.*/ network_reason_code: z .string() .max(5000) - .nullable() .describe( "The card network's specific dispute reason code, which maps to one of Stripe's primary dispute categories to simplify response guidance. The [Network code map](https://stripe.com/docs/disputes/categories#network-code-map) lists all available dispute reason codes by network." ) @@ -2502,11 +2376,10 @@ export namespace stripe { > export const DisputePaymentMethodDetailsKlarnaSchema = z.object({ - /** The reason for the dispute as defined by Klarna */ + /**The reason for the dispute as defined by Klarna*/ reason_code: z .string() .max(5000) - .nullable() .describe('The reason for the dispute as defined by Klarna') .optional() }) @@ -2515,18 +2388,16 @@ export namespace stripe { > export const DisputePaymentMethodDetailsPaypalSchema = z.object({ - /** The ID of the dispute in PayPal. */ + /**The ID of the dispute in PayPal.*/ case_id: z .string() .max(5000) - .nullable() .describe('The ID of the dispute in PayPal.') .optional(), - /** The reason for the dispute as defined by PayPal */ + /**The reason for the dispute as defined by PayPal*/ reason_code: z .string() .max(5000) - .nullable() .describe('The reason for the dispute as defined by PayPal') .optional() }) @@ -2535,18 +2406,16 @@ export namespace stripe { > export const IssuingAuthorizationAmountDetailsSchema = z.object({ - /** The fee charged by the ATM for the cash withdrawal. */ + /**The fee charged by the ATM for the cash withdrawal.*/ atm_fee: z .number() .int() - .nullable() .describe('The fee charged by the ATM for the cash withdrawal.') .optional(), - /** The amount of cash requested by the cardholder. */ + /**The amount of cash requested by the cardholder.*/ cashback_amount: z .number() .int() - .nullable() .describe('The amount of cash requested by the cardholder.') .optional() }) @@ -2555,7 +2424,7 @@ export namespace stripe { > export const IssuingCardholderCompanySchema = z.object({ - /** Whether the company's business ID number was provided. */ + /**Whether the company's business ID number was provided.*/ tax_id_provided: z .boolean() .describe("Whether the company's business ID number was provided.") @@ -2565,29 +2434,26 @@ export namespace stripe { > export const IssuingCardholderUserTermsAcceptanceSchema = z.object({ - /** The Unix timestamp marking when the cardholder accepted the Authorized User Terms. */ + /**The Unix timestamp marking when the cardholder accepted the Authorized User Terms.*/ date: z .number() .int() - .nullable() .describe( 'The Unix timestamp marking when the cardholder accepted the Authorized User Terms.' ) .optional(), - /** The IP address from which the cardholder accepted the Authorized User Terms. */ + /**The IP address from which the cardholder accepted the Authorized User Terms.*/ ip: z .string() .max(5000) - .nullable() .describe( 'The IP address from which the cardholder accepted the Authorized User Terms.' ) .optional(), - /** The user agent of the browser from which the cardholder accepted the Authorized User Terms. */ + /**The user agent of the browser from which the cardholder accepted the Authorized User Terms.*/ user_agent: z .string() .max(5000) - .nullable() .describe( 'The user agent of the browser from which the cardholder accepted the Authorized User Terms.' ) @@ -2598,34 +2464,27 @@ export namespace stripe { > export const IssuingCardholderIndividualDobSchema = z.object({ - /** The day of birth, between 1 and 31. */ + /**The day of birth, between 1 and 31.*/ day: z .number() .int() - .nullable() .describe('The day of birth, between 1 and 31.') .optional(), - /** The month of birth, between 1 and 12. */ + /**The month of birth, between 1 and 12.*/ month: z .number() .int() - .nullable() .describe('The month of birth, between 1 and 12.') .optional(), - /** The four-digit year of birth. */ - year: z - .number() - .int() - .nullable() - .describe('The four-digit year of birth.') - .optional() + /**The four-digit year of birth.*/ + year: z.number().int().describe('The four-digit year of birth.').optional() }) export type IssuingCardholderIndividualDob = z.infer< typeof IssuingCardholderIndividualDobSchema > export const IssuingCardholderRequirementsSchema = z.object({ - /** If `disabled_reason` is present, all cards will decline authorizations with `cardholder_verification_required` reason. */ + /**If `disabled_reason` is present, all cards will decline authorizations with `cardholder_verification_required` reason.*/ disabled_reason: z .enum([ 'listed', @@ -2633,12 +2492,11 @@ export namespace stripe { 'requirements.past_due', 'under_review' ]) - .nullable() .describe( 'If `disabled_reason` is present, all cards will decline authorizations with `cardholder_verification_required` reason.' ) .optional(), - /** Array of fields that need to be collected in order to verify and re-enable the cardholder. */ + /**Array of fields that need to be collected in order to verify and re-enable the cardholder.*/ past_due: z .array( z.enum([ @@ -2653,7 +2511,6 @@ export namespace stripe { 'individual.verification.document' ]) ) - .nullable() .describe( 'Array of fields that need to be collected in order to verify and re-enable the cardholder.' ) @@ -2664,14 +2521,14 @@ export namespace stripe { > export const IssuingCardholderSpendingLimitSchema = z.object({ - /** Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /**Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).*/ amount: z .number() .int() .describe( "Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal)." ), - /** Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. */ + /**Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories.*/ categories: z .array( z.enum([ @@ -2972,12 +2829,11 @@ export namespace stripe { 'wrecking_and_salvage_yards' ]) ) - .nullable() .describe( 'Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories.' ) .optional(), - /** Interval (or event) to which the amount applies. */ + /**Interval (or event) to which the amount applies.*/ interval: z .enum([ 'all_time', @@ -2994,32 +2850,28 @@ export namespace stripe { > export const IssuingPersonalizationDesignCarrierTextSchema = z.object({ - /** The footer body text of the carrier letter. */ + /**The footer body text of the carrier letter.*/ footer_body: z .string() .max(5000) - .nullable() .describe('The footer body text of the carrier letter.') .optional(), - /** The footer title text of the carrier letter. */ + /**The footer title text of the carrier letter.*/ footer_title: z .string() .max(5000) - .nullable() .describe('The footer title text of the carrier letter.') .optional(), - /** The header body text of the carrier letter. */ + /**The header body text of the carrier letter.*/ header_body: z .string() .max(5000) - .nullable() .describe('The header body text of the carrier letter.') .optional(), - /** The header title text of the carrier letter. */ + /**The header title text of the carrier letter.*/ header_title: z .string() .max(5000) - .nullable() .describe('The header title text of the carrier letter.') .optional() }) @@ -3028,19 +2880,19 @@ export namespace stripe { > export const IssuingPhysicalBundleFeaturesSchema = z.object({ - /** The policy for how to use card logo images in a card design with this physical bundle. */ + /**The policy for how to use card logo images in a card design with this physical bundle.*/ card_logo: z .enum(['optional', 'required', 'unsupported']) .describe( 'The policy for how to use card logo images in a card design with this physical bundle.' ), - /** The policy for how to use carrier letter text in a card design with this physical bundle. */ + /**The policy for how to use carrier letter text in a card design with this physical bundle.*/ carrier_text: z .enum(['optional', 'required', 'unsupported']) .describe( 'The policy for how to use carrier letter text in a card design with this physical bundle.' ), - /** The policy for how to use a second line on a card with this physical bundle. */ + /**The policy for how to use a second line on a card with this physical bundle.*/ second_line: z .enum(['optional', 'required', 'unsupported']) .describe( @@ -3052,16 +2904,15 @@ export namespace stripe { > export const IssuingPersonalizationDesignPreferencesSchema = z.object({ - /** Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design. */ + /**Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design.*/ is_default: z .boolean() .describe( "Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design." ), - /** Whether this personalization design is used to create cards when one is not specified and a default for this connected account does not exist. */ + /**Whether this personalization design is used to create cards when one is not specified and a default for this connected account does not exist.*/ is_platform_default: z .boolean() - .nullable() .describe( 'Whether this personalization design is used to create cards when one is not specified and a default for this connected account does not exist.' ) @@ -3072,7 +2923,7 @@ export namespace stripe { > export const IssuingPersonalizationDesignRejectionReasonsSchema = z.object({ - /** The reason(s) the card logo was rejected. */ + /**The reason(s) the card logo was rejected.*/ card_logo: z .array( z.enum([ @@ -3086,10 +2937,9 @@ export namespace stripe { 'promotional_material' ]) ) - .nullable() .describe('The reason(s) the card logo was rejected.') .optional(), - /** The reason(s) the carrier text was rejected. */ + /**The reason(s) the carrier text was rejected.*/ carrier_text: z .array( z.enum([ @@ -3102,7 +2952,6 @@ export namespace stripe { 'promotional_material' ]) ) - .nullable() .describe('The reason(s) the carrier text was rejected.') .optional() }) @@ -3111,11 +2960,10 @@ export namespace stripe { > export const IssuingCardShippingCustomsSchema = z.object({ - /** A registration number used for customs in Europe. See [https://www.gov.uk/eori](https://www.gov.uk/eori) for the UK and [https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en](https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en) for the EU. */ + /**A registration number used for customs in Europe. See [https://www.gov.uk/eori](https://www.gov.uk/eori) for the UK and [https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en](https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en) for the EU.*/ eori_number: z .string() .max(5000) - .nullable() .describe( 'A registration number used for customs in Europe. See [https://www.gov.uk/eori](https://www.gov.uk/eori) for the UK and [https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en](https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en) for the EU.' ) @@ -3126,14 +2974,14 @@ export namespace stripe { > export const IssuingCardSpendingLimitSchema = z.object({ - /** Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /**Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).*/ amount: z .number() .int() .describe( "Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal)." ), - /** Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. */ + /**Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories.*/ categories: z .array( z.enum([ @@ -3434,12 +3282,11 @@ export namespace stripe { 'wrecking_and_salvage_yards' ]) ) - .nullable() .describe( 'Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories.' ) .optional(), - /** Interval (or event) to which the amount applies. */ + /**Interval (or event) to which the amount applies.*/ interval: z .enum([ 'all_time', @@ -3456,89 +3303,69 @@ export namespace stripe { > export const IssuingCardApplePaySchema = z.object({ - /** Apple Pay Eligibility */ + /**Apple Pay Eligibility*/ eligible: z.boolean().describe('Apple Pay Eligibility'), - /** Reason the card is ineligible for Apple Pay */ + /**Reason the card is ineligible for Apple Pay*/ ineligible_reason: z .enum([ 'missing_agreement', 'missing_cardholder_contact', 'unsupported_region' ]) - .nullable() .describe('Reason the card is ineligible for Apple Pay') .optional() }) export type IssuingCardApplePay = z.infer export const IssuingCardGooglePaySchema = z.object({ - /** Google Pay Eligibility */ + /**Google Pay Eligibility*/ eligible: z.boolean().describe('Google Pay Eligibility'), - /** Reason the card is ineligible for Google Pay */ + /**Reason the card is ineligible for Google Pay*/ ineligible_reason: z .enum([ 'missing_agreement', 'missing_cardholder_contact', 'unsupported_region' ]) - .nullable() .describe('Reason the card is ineligible for Google Pay') .optional() }) export type IssuingCardGooglePay = z.infer export const IssuingAuthorizationFleetCardholderPromptDataSchema = z.object({ - /** [Deprecated] An alphanumeric ID, though typical point of sales only support numeric entry. The card program can be configured to prompt for a vehicle ID, driver ID, or generic ID. */ + /**[Deprecated] An alphanumeric ID, though typical point of sales only support numeric entry. The card program can be configured to prompt for a vehicle ID, driver ID, or generic ID.*/ alphanumeric_id: z .string() .max(5000) - .nullable() .describe( '[Deprecated] An alphanumeric ID, though typical point of sales only support numeric entry. The card program can be configured to prompt for a vehicle ID, driver ID, or generic ID.' ) .optional(), - /** Driver ID. */ - driver_id: z - .string() - .max(5000) - .nullable() - .describe('Driver ID.') - .optional(), - /** Odometer reading. */ - odometer: z - .number() - .int() - .nullable() - .describe('Odometer reading.') - .optional(), - /** An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type. */ + /**Driver ID.*/ + driver_id: z.string().max(5000).describe('Driver ID.').optional(), + /**Odometer reading.*/ + odometer: z.number().int().describe('Odometer reading.').optional(), + /**An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.*/ unspecified_id: z .string() .max(5000) - .nullable() .describe( 'An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.' ) .optional(), - /** User ID. */ - user_id: z.string().max(5000).nullable().describe('User ID.').optional(), - /** Vehicle number. */ - vehicle_number: z - .string() - .max(5000) - .nullable() - .describe('Vehicle number.') - .optional() + /**User ID.*/ + user_id: z.string().max(5000).describe('User ID.').optional(), + /**Vehicle number.*/ + vehicle_number: z.string().max(5000).describe('Vehicle number.').optional() }) export type IssuingAuthorizationFleetCardholderPromptData = z.infer< typeof IssuingAuthorizationFleetCardholderPromptDataSchema > export const IssuingAuthorizationFleetFuelPriceDataSchema = z.object({ - /** Gross fuel amount that should equal Fuel Quantity multiplied by Fuel Unit Cost, inclusive of taxes. */ + /**Gross fuel amount that should equal Fuel Quantity multiplied by Fuel Unit Cost, inclusive of taxes.*/ gross_amount_decimal: z .string() - .nullable() .describe( 'Gross fuel amount that should equal Fuel Quantity multiplied by Fuel Unit Cost, inclusive of taxes.' ) @@ -3549,10 +3376,9 @@ export namespace stripe { > export const IssuingAuthorizationFleetNonFuelPriceDataSchema = z.object({ - /** Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes. */ + /**Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.*/ gross_amount_decimal: z .string() - .nullable() .describe( 'Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.' ) @@ -3563,18 +3389,16 @@ export namespace stripe { > export const IssuingAuthorizationFleetTaxDataSchema = z.object({ - /** Amount of state or provincial Sales Tax included in the transaction amount. `null` if not reported by merchant or not subject to tax. */ + /**Amount of state or provincial Sales Tax included in the transaction amount. `null` if not reported by merchant or not subject to tax.*/ local_amount_decimal: z .string() - .nullable() .describe( 'Amount of state or provincial Sales Tax included in the transaction amount. `null` if not reported by merchant or not subject to tax.' ) .optional(), - /** Amount of national Sales Tax or VAT included in the transaction amount. `null` if not reported by merchant or not subject to tax. */ + /**Amount of national Sales Tax or VAT included in the transaction amount. `null` if not reported by merchant or not subject to tax.*/ national_amount_decimal: z .string() - .nullable() .describe( 'Amount of national Sales Tax or VAT included in the transaction amount. `null` if not reported by merchant or not subject to tax.' ) @@ -3585,20 +3409,19 @@ export namespace stripe { > export const IssuingAuthorizationFraudChallengeSchema = z.object({ - /** The method by which the fraud challenge was delivered to the cardholder. */ + /**The method by which the fraud challenge was delivered to the cardholder.*/ channel: z .literal('sms') .describe( 'The method by which the fraud challenge was delivered to the cardholder.' ), - /** The status of the fraud challenge. */ + /**The status of the fraud challenge.*/ status: z .enum(['expired', 'pending', 'rejected', 'undeliverable', 'verified']) .describe('The status of the fraud challenge.'), - /** If the challenge is not deliverable, the reason why. */ + /**If the challenge is not deliverable, the reason why.*/ undeliverable_reason: z .enum(['no_phone_number', 'unsupported_phone_number']) - .nullable() .describe('If the challenge is not deliverable, the reason why.') .optional() }) @@ -3607,24 +3430,22 @@ export namespace stripe { > export const IssuingAuthorizationFuelDataSchema = z.object({ - /** [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased. */ + /**[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.*/ industry_product_code: z .string() .max(5000) - .nullable() .describe( '[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.' ) .optional(), - /** The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places. */ + /**The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.*/ quantity_decimal: z .string() - .nullable() .describe( 'The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.' ) .optional(), - /** The type of fuel that was purchased. */ + /**The type of fuel that was purchased.*/ type: z .enum([ 'diesel', @@ -3633,10 +3454,9 @@ export namespace stripe { 'unleaded_regular', 'unleaded_super' ]) - .nullable() .describe('The type of fuel that was purchased.') .optional(), - /** The units for `quantity_decimal`. */ + /**The units for `quantity_decimal`.*/ unit: z .enum([ 'charging_minute', @@ -3648,13 +3468,11 @@ export namespace stripe { 'pound', 'us_gallon' ]) - .nullable() .describe('The units for `quantity_decimal`.') .optional(), - /** The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places. */ + /**The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.*/ unit_cost_decimal: z .string() - .nullable() .describe( 'The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.' ) @@ -3665,81 +3483,69 @@ export namespace stripe { > export const IssuingAuthorizationMerchantDataSchema = z.object({ - /** A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values. */ + /**A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values.*/ category: z .string() .max(5000) .describe( "A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values." ), - /** The merchant category code for the seller’s business */ + /**The merchant category code for the seller’s business*/ category_code: z .string() .max(5000) .describe('The merchant category code for the seller’s business'), - /** City where the seller is located */ + /**City where the seller is located*/ city: z .string() .max(5000) - .nullable() .describe('City where the seller is located') .optional(), - /** Country where the seller is located */ + /**Country where the seller is located*/ country: z .string() .max(5000) - .nullable() .describe('Country where the seller is located') .optional(), - /** Name of the seller */ - name: z - .string() - .max(5000) - .nullable() - .describe('Name of the seller') - .optional(), - /** Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant. */ + /**Name of the seller*/ + name: z.string().max(5000).describe('Name of the seller').optional(), + /**Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.*/ network_id: z .string() .max(5000) .describe( 'Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.' ), - /** Postal code where the seller is located */ + /**Postal code where the seller is located*/ postal_code: z .string() .max(5000) - .nullable() .describe('Postal code where the seller is located') .optional(), - /** State where the seller is located */ + /**State where the seller is located*/ state: z .string() .max(5000) - .nullable() .describe('State where the seller is located') .optional(), - /** The seller's tax identification number. Currently populated for French merchants only. */ + /**The seller's tax identification number. Currently populated for French merchants only.*/ tax_id: z .string() .max(5000) - .nullable() .describe( "The seller's tax identification number. Currently populated for French merchants only." ) .optional(), - /** An ID assigned by the seller to the location of the sale. */ + /**An ID assigned by the seller to the location of the sale.*/ terminal_id: z .string() .max(5000) - .nullable() .describe('An ID assigned by the seller to the location of the sale.') .optional(), - /** URL provided by the merchant on a 3DS request */ + /**URL provided by the merchant on a 3DS request*/ url: z .string() .max(5000) - .nullable() .describe('URL provided by the merchant on a 3DS request') .optional() }) @@ -3748,29 +3554,26 @@ export namespace stripe { > export const IssuingAuthorizationNetworkDataSchema = z.object({ - /** Identifier assigned to the acquirer by the card network. Sometimes this value is not provided by the network; in this case, the value will be `null`. */ + /**Identifier assigned to the acquirer by the card network. Sometimes this value is not provided by the network; in this case, the value will be `null`.*/ acquiring_institution_id: z .string() .max(5000) - .nullable() .describe( 'Identifier assigned to the acquirer by the card network. Sometimes this value is not provided by the network; in this case, the value will be `null`.' ) .optional(), - /** The System Trace Audit Number (STAN) is a 6-digit identifier assigned by the acquirer. Prefer `network_data.transaction_id` if present, unless you have special requirements. */ + /**The System Trace Audit Number (STAN) is a 6-digit identifier assigned by the acquirer. Prefer `network_data.transaction_id` if present, unless you have special requirements.*/ system_trace_audit_number: z .string() .max(5000) - .nullable() .describe( 'The System Trace Audit Number (STAN) is a 6-digit identifier assigned by the acquirer. Prefer `network_data.transaction_id` if present, unless you have special requirements.' ) .optional(), - /** Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions. */ + /**Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions.*/ transaction_id: z .string() .max(5000) - .nullable() .describe( 'Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions.' ) @@ -3781,19 +3584,19 @@ export namespace stripe { > export const IssuingNetworkTokenDeviceSchema = z.object({ - /** An obfuscated ID derived from the device ID. */ + /**An obfuscated ID derived from the device ID.*/ device_fingerprint: z .string() .max(5000) .describe('An obfuscated ID derived from the device ID.') .optional(), - /** The IP address of the device at provisioning time. */ + /**The IP address of the device at provisioning time.*/ ip_address: z .string() .max(5000) .describe('The IP address of the device at provisioning time.') .optional(), - /** The geographic latitude/longitude coordinates of the device at provisioning time. The format is [+-]decimal/[+-]decimal. */ + /**The geographic latitude/longitude coordinates of the device at provisioning time. The format is [+-]decimal/[+-]decimal.*/ location: z .string() .max(5000) @@ -3801,19 +3604,19 @@ export namespace stripe { 'The geographic latitude/longitude coordinates of the device at provisioning time. The format is [+-]decimal/[+-]decimal.' ) .optional(), - /** The name of the device used for tokenization. */ + /**The name of the device used for tokenization.*/ name: z .string() .max(5000) .describe('The name of the device used for tokenization.') .optional(), - /** The phone number of the device used for tokenization. */ + /**The phone number of the device used for tokenization.*/ phone_number: z .string() .max(5000) .describe('The phone number of the device used for tokenization.') .optional(), - /** The type of device used for tokenization. */ + /**The type of device used for tokenization.*/ type: z .enum(['other', 'phone', 'watch']) .describe('The type of device used for tokenization.') @@ -3824,7 +3627,7 @@ export namespace stripe { > export const IssuingNetworkTokenMastercardSchema = z.object({ - /** A unique reference ID from MasterCard to represent the card account number. */ + /**A unique reference ID from MasterCard to represent the card account number.*/ card_reference_id: z .string() .max(5000) @@ -3832,19 +3635,19 @@ export namespace stripe { 'A unique reference ID from MasterCard to represent the card account number.' ) .optional(), - /** The network-unique identifier for the token. */ + /**The network-unique identifier for the token.*/ token_reference_id: z .string() .max(5000) .describe('The network-unique identifier for the token.'), - /** The ID of the entity requesting tokenization, specific to MasterCard. */ + /**The ID of the entity requesting tokenization, specific to MasterCard.*/ token_requestor_id: z .string() .max(5000) .describe( 'The ID of the entity requesting tokenization, specific to MasterCard.' ), - /** The name of the entity requesting tokenization, if known. This is directly provided from MasterCard. */ + /**The name of the entity requesting tokenization, if known. This is directly provided from MasterCard.*/ token_requestor_name: z .string() .max(5000) @@ -3858,26 +3661,26 @@ export namespace stripe { > export const IssuingNetworkTokenVisaSchema = z.object({ - /** A unique reference ID from Visa to represent the card account number. */ + /**A unique reference ID from Visa to represent the card account number.*/ card_reference_id: z .string() .max(5000) .describe( 'A unique reference ID from Visa to represent the card account number.' ), - /** The network-unique identifier for the token. */ + /**The network-unique identifier for the token.*/ token_reference_id: z .string() .max(5000) .describe('The network-unique identifier for the token.'), - /** The ID of the entity requesting tokenization, specific to Visa. */ + /**The ID of the entity requesting tokenization, specific to Visa.*/ token_requestor_id: z .string() .max(5000) .describe( 'The ID of the entity requesting tokenization, specific to Visa.' ), - /** Degree of risk associated with the token between `01` and `99`, with higher number indicating higher risk. A `00` value indicates the token was not scored by Visa. */ + /**Degree of risk associated with the token between `01` and `99`, with higher number indicating higher risk. A `00` value indicates the token was not scored by Visa.*/ token_risk_score: z .string() .max(5000) @@ -3891,12 +3694,12 @@ export namespace stripe { > export const IssuingNetworkTokenAddressSchema = z.object({ - /** The street address of the cardholder tokenizing the card. */ + /**The street address of the cardholder tokenizing the card.*/ line1: z .string() .max(5000) .describe('The street address of the cardholder tokenizing the card.'), - /** The postal code of the cardholder tokenizing the card. */ + /**The postal code of the cardholder tokenizing the card.*/ postal_code: z .string() .max(5000) @@ -3907,18 +3710,16 @@ export namespace stripe { > export const IssuingTransactionAmountDetailsSchema = z.object({ - /** The fee charged by the ATM for the cash withdrawal. */ + /**The fee charged by the ATM for the cash withdrawal.*/ atm_fee: z .number() .int() - .nullable() .describe('The fee charged by the ATM for the cash withdrawal.') .optional(), - /** The amount of cash requested by the cardholder. */ + /**The amount of cash requested by the cardholder.*/ cashback_amount: z .number() .int() - .nullable() .describe('The amount of cash requested by the cardholder.') .optional() }) @@ -3927,16 +3728,15 @@ export namespace stripe { > export const IssuingDisputeTreasurySchema = z.object({ - /** The Treasury [DebitReversal](https://stripe.com/docs/api/treasury/debit_reversals) representing this Issuing dispute */ + /**The Treasury [DebitReversal](https://stripe.com/docs/api/treasury/debit_reversals) representing this Issuing dispute*/ debit_reversal: z .string() .max(5000) - .nullable() .describe( 'The Treasury [DebitReversal](https://stripe.com/docs/api/treasury/debit_reversals) representing this Issuing dispute' ) .optional(), - /** The Treasury [ReceivedDebit](https://stripe.com/docs/api/treasury/received_debits) that is being disputed. */ + /**The Treasury [ReceivedDebit](https://stripe.com/docs/api/treasury/received_debits) that is being disputed.*/ received_debit: z .string() .max(5000) @@ -3949,29 +3749,26 @@ export namespace stripe { > export const IssuingTransactionNetworkDataSchema = z.object({ - /** A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter "S", followed by a six-digit number. For example, "S498162". Please note that the code is not guaranteed to be unique across authorizations. */ + /**A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter "S", followed by a six-digit number. For example, "S498162". Please note that the code is not guaranteed to be unique across authorizations.*/ authorization_code: z .string() .max(5000) - .nullable() .describe( 'A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter "S", followed by a six-digit number. For example, "S498162". Please note that the code is not guaranteed to be unique across authorizations.' ) .optional(), - /** The date the transaction was processed by the card network. This can be different from the date the seller recorded the transaction depending on when the acquirer submits the transaction to the network. */ + /**The date the transaction was processed by the card network. This can be different from the date the seller recorded the transaction depending on when the acquirer submits the transaction to the network.*/ processing_date: z .string() .max(5000) - .nullable() .describe( 'The date the transaction was processed by the card network. This can be different from the date the seller recorded the transaction depending on when the acquirer submits the transaction to the network.' ) .optional(), - /** Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions. */ + /**Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions.*/ transaction_id: z .string() .max(5000) - .nullable() .describe( 'Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions.' ) @@ -3982,48 +3779,31 @@ export namespace stripe { > export const IssuingTransactionFleetCardholderPromptDataSchema = z.object({ - /** Driver ID. */ - driver_id: z - .string() - .max(5000) - .nullable() - .describe('Driver ID.') - .optional(), - /** Odometer reading. */ - odometer: z - .number() - .int() - .nullable() - .describe('Odometer reading.') - .optional(), - /** An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type. */ + /**Driver ID.*/ + driver_id: z.string().max(5000).describe('Driver ID.').optional(), + /**Odometer reading.*/ + odometer: z.number().int().describe('Odometer reading.').optional(), + /**An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.*/ unspecified_id: z .string() .max(5000) - .nullable() .describe( 'An alphanumeric ID. This field is used when a vehicle ID, driver ID, or generic ID is entered by the cardholder, but the merchant or card network did not specify the prompt type.' ) .optional(), - /** User ID. */ - user_id: z.string().max(5000).nullable().describe('User ID.').optional(), - /** Vehicle number. */ - vehicle_number: z - .string() - .max(5000) - .nullable() - .describe('Vehicle number.') - .optional() + /**User ID.*/ + user_id: z.string().max(5000).describe('User ID.').optional(), + /**Vehicle number.*/ + vehicle_number: z.string().max(5000).describe('Vehicle number.').optional() }) export type IssuingTransactionFleetCardholderPromptData = z.infer< typeof IssuingTransactionFleetCardholderPromptDataSchema > export const IssuingTransactionFleetFuelPriceDataSchema = z.object({ - /** Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes. */ + /**Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.*/ gross_amount_decimal: z .string() - .nullable() .describe( 'Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.' ) @@ -4034,10 +3814,9 @@ export namespace stripe { > export const IssuingTransactionFleetNonFuelPriceDataSchema = z.object({ - /** Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes. */ + /**Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.*/ gross_amount_decimal: z .string() - .nullable() .describe( 'Gross non-fuel amount that should equal the sum of the line items, inclusive of taxes.' ) @@ -4048,18 +3827,16 @@ export namespace stripe { > export const IssuingTransactionFleetTaxDataSchema = z.object({ - /** Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax. */ + /**Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.*/ local_amount_decimal: z .string() - .nullable() .describe( 'Amount of state or provincial Sales Tax included in the transaction amount. Null if not reported by merchant or not subject to tax.' ) .optional(), - /** Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax. */ + /**Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.*/ national_amount_decimal: z .string() - .nullable() .describe( 'Amount of national Sales Tax or VAT included in the transaction amount. Null if not reported by merchant or not subject to tax.' ) @@ -4070,49 +3847,43 @@ export namespace stripe { > export const IssuingTransactionFlightDataLegSchema = z.object({ - /** The three-letter IATA airport code of the flight's destination. */ + /**The three-letter IATA airport code of the flight's destination.*/ arrival_airport_code: z .string() .max(5000) - .nullable() .describe( "The three-letter IATA airport code of the flight's destination." ) .optional(), - /** The airline carrier code. */ + /**The airline carrier code.*/ carrier: z .string() .max(5000) - .nullable() .describe('The airline carrier code.') .optional(), - /** The three-letter IATA airport code that the flight departed from. */ + /**The three-letter IATA airport code that the flight departed from.*/ departure_airport_code: z .string() .max(5000) - .nullable() .describe( 'The three-letter IATA airport code that the flight departed from.' ) .optional(), - /** The flight number. */ + /**The flight number.*/ flight_number: z .string() .max(5000) - .nullable() .describe('The flight number.') .optional(), - /** The flight's service class. */ + /**The flight's service class.*/ service_class: z .string() .max(5000) - .nullable() .describe("The flight's service class.") .optional(), - /** Whether a stopover is allowed on this flight. */ + /**Whether a stopover is allowed on this flight.*/ stopover_allowed: z .boolean() - .nullable() .describe('Whether a stopover is allowed on this flight.') .optional() }) @@ -4121,38 +3892,36 @@ export namespace stripe { > export const IssuingTransactionFuelDataSchema = z.object({ - /** [Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased. */ + /**[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.*/ industry_product_code: z .string() .max(5000) - .nullable() .describe( '[Conexxus Payment System Product Code](https://www.conexxus.org/conexxus-payment-system-product-codes) identifying the primary fuel product purchased.' ) .optional(), - /** The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places. */ + /**The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.*/ quantity_decimal: z .string() - .nullable() .describe( 'The quantity of `unit`s of fuel that was dispensed, represented as a decimal string with at most 12 decimal places.' ) .optional(), - /** The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`. */ + /**The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.*/ type: z .string() .max(5000) .describe( 'The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.' ), - /** The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`. */ + /**The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.*/ unit: z .string() .max(5000) .describe( 'The units for `quantity_decimal`. One of `charging_minute`, `imperial_gallon`, `kilogram`, `kilowatt_hour`, `liter`, `pound`, `us_gallon`, or `other`.' ), - /** The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places. */ + /**The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.*/ unit_cost_decimal: z .string() .describe( @@ -4164,18 +3933,16 @@ export namespace stripe { > export const IssuingTransactionLodgingDataSchema = z.object({ - /** The time of checking into the lodging. */ + /**The time of checking into the lodging.*/ check_in_at: z .number() .int() - .nullable() .describe('The time of checking into the lodging.') .optional(), - /** The number of nights stayed at the lodging. */ + /**The number of nights stayed at the lodging.*/ nights: z .number() .int() - .nullable() .describe('The number of nights stayed at the lodging.') .optional() }) @@ -4184,33 +3951,26 @@ export namespace stripe { > export const IssuingTransactionReceiptDataSchema = z.object({ - /** The description of the item. The maximum length of this field is 26 characters. */ + /**The description of the item. The maximum length of this field is 26 characters.*/ description: z .string() .max(5000) - .nullable() .describe( 'The description of the item. The maximum length of this field is 26 characters.' ) .optional(), - /** The quantity of the item. */ - quantity: z - .number() - .nullable() - .describe('The quantity of the item.') - .optional(), - /** The total for this line item in cents. */ + /**The quantity of the item.*/ + quantity: z.number().describe('The quantity of the item.').optional(), + /**The total for this line item in cents.*/ total: z .number() .int() - .nullable() .describe('The total for this line item in cents.') .optional(), - /** The unit cost of the item in cents. */ + /**The unit cost of the item in cents.*/ unit_cost: z .number() .int() - .nullable() .describe('The unit cost of the item in cents.') .optional() }) @@ -4219,20 +3979,18 @@ export namespace stripe { > export const IssuingTransactionTreasurySchema = z.object({ - /** The Treasury [ReceivedCredit](https://stripe.com/docs/api/treasury/received_credits) representing this Issuing transaction if it is a refund */ + /**The Treasury [ReceivedCredit](https://stripe.com/docs/api/treasury/received_credits) representing this Issuing transaction if it is a refund*/ received_credit: z .string() .max(5000) - .nullable() .describe( 'The Treasury [ReceivedCredit](https://stripe.com/docs/api/treasury/received_credits) representing this Issuing transaction if it is a refund' ) .optional(), - /** The Treasury [ReceivedDebit](https://stripe.com/docs/api/treasury/received_debits) representing this Issuing transaction if it is a capture */ + /**The Treasury [ReceivedDebit](https://stripe.com/docs/api/treasury/received_debits) representing this Issuing transaction if it is a capture*/ received_debit: z .string() .max(5000) - .nullable() .describe( 'The Treasury [ReceivedDebit](https://stripe.com/docs/api/treasury/received_debits) representing this Issuing transaction if it is a capture' ) @@ -4243,23 +4001,22 @@ export namespace stripe { > export const IssuingAuthorizationTreasurySchema = z.object({ - /** The array of [ReceivedCredits](https://stripe.com/docs/api/treasury/received_credits) associated with this authorization */ + /**The array of [ReceivedCredits](https://stripe.com/docs/api/treasury/received_credits) associated with this authorization*/ received_credits: z .array(z.string().max(5000)) .describe( 'The array of [ReceivedCredits](https://stripe.com/docs/api/treasury/received_credits) associated with this authorization' ), - /** The array of [ReceivedDebits](https://stripe.com/docs/api/treasury/received_debits) associated with this authorization */ + /**The array of [ReceivedDebits](https://stripe.com/docs/api/treasury/received_debits) associated with this authorization*/ received_debits: z .array(z.string().max(5000)) .describe( 'The array of [ReceivedDebits](https://stripe.com/docs/api/treasury/received_debits) associated with this authorization' ), - /** The Treasury [Transaction](https://stripe.com/docs/api/treasury/transactions) associated with this authorization */ + /**The Treasury [Transaction](https://stripe.com/docs/api/treasury/transactions) associated with this authorization*/ transaction: z .string() .max(5000) - .nullable() .describe( 'The Treasury [Transaction](https://stripe.com/docs/api/treasury/transactions) associated with this authorization' ) @@ -4270,13 +4027,13 @@ export namespace stripe { > export const IssuingAuthorizationAuthenticationExemptionSchema = z.object({ - /** The entity that requested the exemption, either the acquiring merchant or the Issuing user. */ + /**The entity that requested the exemption, either the acquiring merchant or the Issuing user.*/ claimed_by: z .enum(['acquirer', 'issuer']) .describe( 'The entity that requested the exemption, either the acquiring merchant or the Issuing user.' ), - /** The specific exemption claimed for this authorization. */ + /**The specific exemption claimed for this authorization.*/ type: z .enum(['low_value_transaction', 'transaction_risk_analysis', 'unknown']) .describe('The specific exemption claimed for this authorization.') @@ -4286,7 +4043,7 @@ export namespace stripe { > export const IssuingAuthorizationThreeDSecureSchema = z.object({ - /** The outcome of the 3D Secure authentication request. */ + /**The outcome of the 3D Secure authentication request.*/ result: z .enum(['attempt_acknowledged', 'authenticated', 'failed', 'required']) .describe('The outcome of the 3D Secure authentication request.') @@ -4296,20 +4053,19 @@ export namespace stripe { > export const DeletedBankAccountSchema = z.object({ - /** Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. */ + /**Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.*/ currency: z .string() .max(5000) - .nullable() .describe( 'Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.' ) .optional(), - /** Always true for a deleted object */ + /**Always true for a deleted object*/ deleted: z.literal(true).describe('Always true for a deleted object'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('bank_account') .describe( @@ -4319,20 +4075,19 @@ export namespace stripe { export type DeletedBankAccount = z.infer export const DeletedCardSchema = z.object({ - /** Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. */ + /**Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.*/ currency: z .string() .max(5000) - .nullable() .describe( 'Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.' ) .optional(), - /** Always true for a deleted object */ + /**Always true for a deleted object*/ deleted: z.literal(true).describe('Always true for a deleted object'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('card') .describe( @@ -4342,18 +4097,17 @@ export namespace stripe { export type DeletedCard = z.infer export const PayoutsTraceIdSchema = z.object({ - /** Possible values are `pending`, `supported`, and `unsupported`. When `payout.status` is `pending` or `in_transit`, this will be `pending`. When the payout transitions to `paid`, `failed`, or `canceled`, this status will become `supported` or `unsupported` shortly after in most cases. In some cases, this may appear as `pending` for up to 10 days after `arrival_date` until transitioning to `supported` or `unsupported`. */ + /**Possible values are `pending`, `supported`, and `unsupported`. When `payout.status` is `pending` or `in_transit`, this will be `pending`. When the payout transitions to `paid`, `failed`, or `canceled`, this status will become `supported` or `unsupported` shortly after in most cases. In some cases, this may appear as `pending` for up to 10 days after `arrival_date` until transitioning to `supported` or `unsupported`.*/ status: z .string() .max(5000) .describe( 'Possible values are `pending`, `supported`, and `unsupported`. When `payout.status` is `pending` or `in_transit`, this will be `pending`. When the payout transitions to `paid`, `failed`, or `canceled`, this status will become `supported` or `unsupported` shortly after in most cases. In some cases, this may appear as `pending` for up to 10 days after `arrival_date` until transitioning to `supported` or `unsupported`.' ), - /** The trace ID value if `trace_id.status` is `supported`, otherwise `nil`. */ + /**The trace ID value if `trace_id.status` is `supported`, otherwise `nil`.*/ value: z .string() .max(5000) - .nullable() .describe( 'The trace ID value if `trace_id.status` is `supported`, otherwise `nil`.' ) @@ -4363,24 +4117,23 @@ export namespace stripe { export const ReserveTransactionSchema = z.object({ amount: z.number().int(), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** An arbitrary string attached to the object. Often useful for displaying to users. */ + /**An arbitrary string attached to the object. Often useful for displaying to users.*/ description: z .string() .max(5000) - .nullable() .describe( 'An arbitrary string attached to the object. Often useful for displaying to users.' ) .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('reserve_transaction') .describe( @@ -4390,29 +4143,29 @@ export namespace stripe { export type ReserveTransaction = z.infer export const TaxDeductedAtSourceSchema = z.object({ - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('tax_deducted_at_source') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The end of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period. */ + /**The end of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period.*/ period_end: z .number() .int() .describe( 'The end of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period.' ), - /** The start of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period. */ + /**The start of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period.*/ period_start: z .number() .int() .describe( 'The start of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period.' ), - /** The TAN that was supplied to Stripe when TDS was assessed */ + /**The TAN that was supplied to Stripe when TDS was assessed*/ tax_deduction_account_number: z .string() .max(5000) @@ -4421,19 +4174,19 @@ export namespace stripe { export type TaxDeductedAtSource = z.infer export const PlatformEarningFeeSourceSchema = z.object({ - /** Charge ID that created this application fee. */ + /**Charge ID that created this application fee.*/ charge: z .string() .max(5000) .describe('Charge ID that created this application fee.') .optional(), - /** Payout ID that created this application fee. */ + /**Payout ID that created this application fee.*/ payout: z .string() .max(5000) .describe('Payout ID that created this application fee.') .optional(), - /** Type of object that created the application fee, either `charge` or `payout`. */ + /**Type of object that created the application fee, either `charge` or `payout`.*/ type: z .enum(['charge', 'payout']) .describe( @@ -4445,13 +4198,13 @@ export namespace stripe { > export const ChargeFraudDetailsSchema = z.object({ - /** Assessments from Stripe. If set, the value is `fraudulent`. */ + /**Assessments from Stripe. If set, the value is `fraudulent`.*/ stripe_report: z .string() .max(5000) .describe('Assessments from Stripe. If set, the value is `fraudulent`.') .optional(), - /** Assessments reported by you. If set, possible values of are `safe` and `fraudulent`. */ + /**Assessments reported by you. If set, possible values of are `safe` and `fraudulent`.*/ user_report: z .string() .max(5000) @@ -4463,11 +4216,11 @@ export namespace stripe { export type ChargeFraudDetails = z.infer export const RuleSchema = z.object({ - /** The action taken on the payment. */ + /**The action taken on the payment.*/ action: z.string().max(5000).describe('The action taken on the payment.'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** The predicate to evaluate the payment against. */ + /**The predicate to evaluate the payment against.*/ predicate: z .string() .max(5000) @@ -4476,34 +4229,30 @@ export namespace stripe { export type Rule = z.infer export const PaymentMethodDetailsAchCreditTransferSchema = z.object({ - /** Account number to transfer funds to. */ + /**Account number to transfer funds to.*/ account_number: z .string() .max(5000) - .nullable() .describe('Account number to transfer funds to.') .optional(), - /** Name of the bank associated with the routing number. */ + /**Name of the bank associated with the routing number.*/ bank_name: z .string() .max(5000) - .nullable() .describe('Name of the bank associated with the routing number.') .optional(), - /** Routing transit number for the bank account to transfer funds to. */ + /**Routing transit number for the bank account to transfer funds to.*/ routing_number: z .string() .max(5000) - .nullable() .describe( 'Routing transit number for the bank account to transfer funds to.' ) .optional(), - /** SWIFT code of the bank associated with the routing number. */ + /**SWIFT code of the bank associated with the routing number.*/ swift_code: z .string() .max(5000) - .nullable() .describe('SWIFT code of the bank associated with the routing number.') .optional() }) @@ -4512,51 +4261,45 @@ export namespace stripe { > export const PaymentMethodDetailsAchDebitSchema = z.object({ - /** Type of entity that holds the account. This can be either `individual` or `company`. */ + /**Type of entity that holds the account. This can be either `individual` or `company`.*/ account_holder_type: z .enum(['company', 'individual']) - .nullable() .describe( 'Type of entity that holds the account. This can be either `individual` or `company`.' ) .optional(), - /** Name of the bank associated with the bank account. */ + /**Name of the bank associated with the bank account.*/ bank_name: z .string() .max(5000) - .nullable() .describe('Name of the bank associated with the bank account.') .optional(), - /** Two-letter ISO code representing the country the bank account is located in. */ + /**Two-letter ISO code representing the country the bank account is located in.*/ country: z .string() .max(5000) - .nullable() .describe( 'Two-letter ISO code representing the country the bank account is located in.' ) .optional(), - /** Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /**Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.*/ fingerprint: z .string() .max(5000) - .nullable() .describe( 'Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.' ) .optional(), - /** Last four digits of the bank account number. */ + /**Last four digits of the bank account number.*/ last4: z .string() .max(5000) - .nullable() .describe('Last four digits of the bank account number.') .optional(), - /** Routing transit number of the bank account. */ + /**Routing transit number of the bank account.*/ routing_number: z .string() .max(5000) - .nullable() .describe('Routing transit number of the bank account.') .optional() }) @@ -4565,47 +4308,42 @@ export namespace stripe { > export const PaymentMethodDetailsAcssDebitSchema = z.object({ - /** Name of the bank associated with the bank account. */ + /**Name of the bank associated with the bank account.*/ bank_name: z .string() .max(5000) - .nullable() .describe('Name of the bank associated with the bank account.') .optional(), - /** Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /**Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.*/ fingerprint: z .string() .max(5000) - .nullable() .describe( 'Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.' ) .optional(), - /** Institution number of the bank account */ + /**Institution number of the bank account*/ institution_number: z .string() .max(5000) - .nullable() .describe('Institution number of the bank account') .optional(), - /** Last four digits of the bank account number. */ + /**Last four digits of the bank account number.*/ last4: z .string() .max(5000) - .nullable() .describe('Last four digits of the bank account number.') .optional(), - /** ID of the mandate used to make this payment. */ + /**ID of the mandate used to make this payment.*/ mandate: z .string() .max(5000) .describe('ID of the mandate used to make this payment.') .optional(), - /** Transit number of the bank account. */ + /**Transit number of the bank account.*/ transit_number: z .string() .max(5000) - .nullable() .describe('Transit number of the bank account.') .optional() }) @@ -4614,11 +4352,10 @@ export namespace stripe { > export const PaymentMethodDetailsAffirmSchema = z.object({ - /** The Affirm transaction ID associated with this payment. */ + /**The Affirm transaction ID associated with this payment.*/ transaction_id: z .string() .max(5000) - .nullable() .describe('The Affirm transaction ID associated with this payment.') .optional() }) @@ -4627,18 +4364,16 @@ export namespace stripe { > export const PaymentMethodDetailsAfterpayClearpaySchema = z.object({ - /** The Afterpay order ID associated with this payment intent. */ + /**The Afterpay order ID associated with this payment intent.*/ order_id: z .string() .max(5000) - .nullable() .describe('The Afterpay order ID associated with this payment intent.') .optional(), - /** Order identifier shown to the merchant in Afterpay’s online portal. */ + /**Order identifier shown to the merchant in Afterpay’s online portal.*/ reference: z .string() .max(5000) - .nullable() .describe( 'Order identifier shown to the merchant in Afterpay’s online portal.' ) @@ -4649,7 +4384,7 @@ export namespace stripe { > export const PaymentFlowsPrivatePaymentMethodsAlipayDetailsSchema = z.object({ - /** Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same. */ + /**Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.*/ buyer_id: z .string() .max(5000) @@ -4657,20 +4392,18 @@ export namespace stripe { 'Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.' ) .optional(), - /** Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same. */ + /**Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.*/ fingerprint: z .string() .max(5000) - .nullable() .describe( 'Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same.' ) .optional(), - /** Transaction ID of this particular Alipay transaction. */ + /**Transaction ID of this particular Alipay transaction.*/ transaction_id: z .string() .max(5000) - .nullable() .describe('Transaction ID of this particular Alipay transaction.') .optional() }) @@ -4684,52 +4417,46 @@ export namespace stripe { > export const PaymentMethodDetailsPassthroughCardSchema = z.object({ - /** Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /**Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.*/ brand: z .string() .max(5000) - .nullable() .describe( 'Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.' ) .optional(), - /** Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. */ + /**Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.*/ country: z .string() .max(5000) - .nullable() .describe( "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected." ) .optional(), - /** Two-digit number representing the card's expiration month. */ + /**Two-digit number representing the card's expiration month.*/ exp_month: z .number() .int() - .nullable() .describe("Two-digit number representing the card's expiration month.") .optional(), - /** Four-digit number representing the card's expiration year. */ + /**Four-digit number representing the card's expiration year.*/ exp_year: z .number() .int() - .nullable() .describe("Four-digit number representing the card's expiration year.") .optional(), - /** Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ + /**Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.*/ funding: z .string() .max(5000) - .nullable() .describe( 'Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.' ) .optional(), - /** The last four digits of the card. */ + /**The last four digits of the card.*/ last4: z .string() .max(5000) - .nullable() .describe('The last four digits of the card.') .optional() }) @@ -4738,30 +4465,27 @@ export namespace stripe { > export const PaymentMethodDetailsAuBecsDebitSchema = z.object({ - /** Bank-State-Branch number of the bank account. */ + /**Bank-State-Branch number of the bank account.*/ bsb_number: z .string() .max(5000) - .nullable() .describe('Bank-State-Branch number of the bank account.') .optional(), - /** Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /**Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.*/ fingerprint: z .string() .max(5000) - .nullable() .describe( 'Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.' ) .optional(), - /** Last four digits of the bank account number. */ + /**Last four digits of the bank account number.*/ last4: z .string() .max(5000) - .nullable() .describe('Last four digits of the bank account number.') .optional(), - /** ID of the mandate used to make this payment. */ + /**ID of the mandate used to make this payment.*/ mandate: z .string() .max(5000) @@ -4773,34 +4497,30 @@ export namespace stripe { > export const PaymentMethodDetailsBacsDebitSchema = z.object({ - /** Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /**Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.*/ fingerprint: z .string() .max(5000) - .nullable() .describe( 'Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.' ) .optional(), - /** Last four digits of the bank account number. */ + /**Last four digits of the bank account number.*/ last4: z .string() .max(5000) - .nullable() .describe('Last four digits of the bank account number.') .optional(), - /** ID of the mandate used to make this payment. */ + /**ID of the mandate used to make this payment.*/ mandate: z .string() .max(5000) - .nullable() .describe('ID of the mandate used to make this payment.') .optional(), - /** Sort code of the bank account. (e.g., `10-20-30`) */ + /**Sort code of the bank account. (e.g., `10-20-30`)*/ sort_code: z .string() .max(5000) - .nullable() .describe('Sort code of the bank account. (e.g., `10-20-30`)') .optional() }) @@ -4809,11 +4529,10 @@ export namespace stripe { > export const PaymentMethodDetailsBlikSchema = z.object({ - /** A unique and immutable identifier assigned by BLIK to every buyer. */ + /**A unique and immutable identifier assigned by BLIK to every buyer.*/ buyer_id: z .string() .max(5000) - .nullable() .describe( 'A unique and immutable identifier assigned by BLIK to every buyer.' ) @@ -4824,7 +4543,7 @@ export namespace stripe { > export const PaymentMethodDetailsBoletoSchema = z.object({ - /** The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers) */ + /**The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers)*/ tax_id: z .string() .max(5000) @@ -4837,29 +4556,26 @@ export namespace stripe { > export const PaymentMethodDetailsCardChecksSchema = z.object({ - /** If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ + /**If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.*/ address_line1_check: z .string() .max(5000) - .nullable() .describe( 'If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.' ) .optional(), - /** If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ + /**If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.*/ address_postal_code_check: z .string() .max(5000) - .nullable() .describe( 'If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.' ) .optional(), - /** If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ + /**If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.*/ cvc_check: z .string() .max(5000) - .nullable() .describe( 'If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.' ) @@ -4871,7 +4587,7 @@ export namespace stripe { export const PaymentFlowsPrivatePaymentMethodsCardDetailsApiResourceEnterpriseFeaturesExtendedAuthorizationExtendedAuthorizationSchema = z.object({ - /** Indicates whether or not the capture window is extended beyond the standard authorization. */ + /**Indicates whether or not the capture window is extended beyond the standard authorization.*/ status: z .enum(['disabled', 'enabled']) .describe( @@ -4885,7 +4601,7 @@ export namespace stripe { export const PaymentFlowsPrivatePaymentMethodsCardDetailsApiResourceEnterpriseFeaturesIncrementalAuthorizationIncrementalAuthorizationSchema = z.object({ - /** Indicates whether or not the incremental authorization feature is supported. */ + /**Indicates whether or not the incremental authorization feature is supported.*/ status: z .enum(['available', 'unavailable']) .describe( @@ -4898,11 +4614,10 @@ export namespace stripe { > export const PaymentMethodDetailsCardInstallmentsPlanSchema = z.object({ - /** For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card. */ + /**For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.*/ count: z .number() .int() - .nullable() .describe( 'For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card.' ) @@ -4913,12 +4628,11 @@ export namespace stripe { */ interval: z .literal('month') - .nullable() .describe( 'For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.\nOne of `month`.' ) .optional(), - /** Type of installment plan, one of `fixed_count`. */ + /**Type of installment plan, one of `fixed_count`.*/ type: z .literal('fixed_count') .describe('Type of installment plan, one of `fixed_count`.') @@ -4929,7 +4643,7 @@ export namespace stripe { export const PaymentFlowsPrivatePaymentMethodsCardDetailsApiResourceMulticaptureSchema = z.object({ - /** Indicates whether or not multiple captures are supported. */ + /**Indicates whether or not multiple captures are supported.*/ status: z .enum(['available', 'unavailable']) .describe('Indicates whether or not multiple captures are supported.') @@ -4940,7 +4654,7 @@ export namespace stripe { > export const PaymentMethodDetailsCardNetworkTokenSchema = z.object({ - /** Indicates if Stripe used a network token, either user provided or Stripe managed when processing the transaction. */ + /**Indicates if Stripe used a network token, either user provided or Stripe managed when processing the transaction.*/ used: z .boolean() .describe( @@ -4953,12 +4667,12 @@ export namespace stripe { export const PaymentFlowsPrivatePaymentMethodsCardDetailsApiResourceEnterpriseFeaturesOvercaptureOvercaptureSchema = z.object({ - /** The maximum amount that can be captured. */ + /**The maximum amount that can be captured.*/ maximum_amount_capturable: z .number() .int() .describe('The maximum amount that can be captured.'), - /** Indicates whether or not the authorized amount can be over-captured. */ + /**Indicates whether or not the authorized amount can be over-captured.*/ status: z .enum(['available', 'unavailable']) .describe( @@ -4977,7 +4691,6 @@ export namespace stripe { */ authentication_flow: z .enum(['challenge', 'frictionless']) - .nullable() .describe( 'For authenticated transactions: how the customer was authenticated by\nthe issuing bank.' ) @@ -4988,15 +4701,13 @@ export namespace stripe { */ electronic_commerce_indicator: z .enum(['01', '02', '05', '06', '07']) - .nullable() .describe( 'The Electronic Commerce Indicator (ECI). A protocol-level field\nindicating what degree of authentication was performed.' ) .optional(), - /** The exemption requested via 3DS and accepted by the issuer at authentication time. */ + /**The exemption requested via 3DS and accepted by the issuer at authentication time.*/ exemption_indicator: z .enum(['low_risk', 'none']) - .nullable() .describe( 'The exemption requested via 3DS and accepted by the issuer at authentication time.' ) @@ -5011,7 +4722,7 @@ export namespace stripe { "Whether Stripe requested the value of `exemption_indicator` in the transaction. This will depend on\nthe outcome of Stripe's internal risk assessment." ) .optional(), - /** Indicates the outcome of 3D Secure authentication. */ + /**Indicates the outcome of 3D Secure authentication.*/ result: z .enum([ 'attempt_acknowledged', @@ -5021,7 +4732,6 @@ export namespace stripe { 'not_supported', 'processing_error' ]) - .nullable() .describe('Indicates the outcome of 3D Secure authentication.') .optional(), /** @@ -5038,7 +4748,6 @@ export namespace stripe { 'protocol_error', 'rejected' ]) - .nullable() .describe( 'Additional information about why 3D Secure succeeded or failed based\non the `result`.' ) @@ -5050,15 +4759,13 @@ export namespace stripe { transaction_id: z .string() .max(5000) - .nullable() .describe( 'The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID\n(dsTransId) for this payment.' ) .optional(), - /** The version of 3D Secure that was used. */ + /**The version of 3D Secure that was used.*/ version: z .enum(['1.0.2', '2.1.0', '2.2.0']) - .nullable() .describe('The version of 3D Secure that was used.') .optional() }) @@ -5083,20 +4790,18 @@ export namespace stripe { > export const PaymentMethodDetailsCashappSchema = z.object({ - /** A unique and immutable identifier assigned by Cash App to every buyer. */ + /**A unique and immutable identifier assigned by Cash App to every buyer.*/ buyer_id: z .string() .max(5000) - .nullable() .describe( 'A unique and immutable identifier assigned by Cash App to every buyer.' ) .optional(), - /** A public identifier for buyers using Cash App. */ + /**A public identifier for buyers using Cash App.*/ cashtag: z .string() .max(5000) - .nullable() .describe('A public identifier for buyers using Cash App.') .optional() }) @@ -5110,7 +4815,7 @@ export namespace stripe { > export const PaymentMethodDetailsEpsSchema = z.object({ - /** The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`. */ + /**The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`.*/ bank: z .enum([ 'arzte_und_apotheker_bank', @@ -5142,7 +4847,6 @@ export namespace stripe { 'volkskreditbank_ag', 'vr_bank_braunau' ]) - .nullable() .describe( "The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`." ) @@ -5155,7 +4859,6 @@ export namespace stripe { verified_name: z .string() .max(5000) - .nullable() .describe( "Owner's verified full name. Values are verified or provided by EPS directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.\nEPS rarely provides this information so the attribute is usually empty." ) @@ -5166,7 +4869,7 @@ export namespace stripe { > export const PaymentMethodDetailsFpxSchema = z.object({ - /** The customer's bank. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`. */ + /**The customer's bank. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`.*/ bank: z .enum([ 'affin_bank', @@ -5195,11 +4898,10 @@ export namespace stripe { .describe( "The customer's bank. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`." ), - /** Unique transaction id generated by FPX for every request from the merchant */ + /**Unique transaction id generated by FPX for every request from the merchant*/ transaction_id: z .string() .max(5000) - .nullable() .describe( 'Unique transaction id generated by FPX for every request from the merchant' ) @@ -5210,25 +4912,22 @@ export namespace stripe { > export const PaymentMethodDetailsGiropaySchema = z.object({ - /** Bank code of bank associated with the bank account. */ + /**Bank code of bank associated with the bank account.*/ bank_code: z .string() .max(5000) - .nullable() .describe('Bank code of bank associated with the bank account.') .optional(), - /** Name of the bank associated with the bank account. */ + /**Name of the bank associated with the bank account.*/ bank_name: z .string() .max(5000) - .nullable() .describe('Name of the bank associated with the bank account.') .optional(), - /** Bank Identifier Code of the bank associated with the bank account. */ + /**Bank Identifier Code of the bank associated with the bank account.*/ bic: z .string() .max(5000) - .nullable() .describe( 'Bank Identifier Code of the bank associated with the bank account.' ) @@ -5241,7 +4940,6 @@ export namespace stripe { verified_name: z .string() .max(5000) - .nullable() .describe( "Owner's verified full name. Values are verified or provided by Giropay directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.\nGiropay rarely provides this information so the attribute is usually empty." ) @@ -5252,11 +4950,10 @@ export namespace stripe { > export const PaymentMethodDetailsGrabpaySchema = z.object({ - /** Unique transaction id generated by GrabPay */ + /**Unique transaction id generated by GrabPay*/ transaction_id: z .string() .max(5000) - .nullable() .describe('Unique transaction id generated by GrabPay') .optional() }) @@ -5265,73 +4962,65 @@ export namespace stripe { > export const PaymentMethodDetailsInteracPresentReceiptSchema = z.object({ - /** The type of account being debited or credited */ + /**The type of account being debited or credited*/ account_type: z .enum(['checking', 'savings', 'unknown']) .describe('The type of account being debited or credited') .optional(), - /** EMV tag 9F26, cryptogram generated by the integrated circuit chip. */ + /**EMV tag 9F26, cryptogram generated by the integrated circuit chip.*/ application_cryptogram: z .string() .max(5000) - .nullable() .describe( 'EMV tag 9F26, cryptogram generated by the integrated circuit chip.' ) .optional(), - /** Mnenomic of the Application Identifier. */ + /**Mnenomic of the Application Identifier.*/ application_preferred_name: z .string() .max(5000) - .nullable() .describe('Mnenomic of the Application Identifier.') .optional(), - /** Identifier for this transaction. */ + /**Identifier for this transaction.*/ authorization_code: z .string() .max(5000) - .nullable() .describe('Identifier for this transaction.') .optional(), - /** EMV tag 8A. A code returned by the card issuer. */ + /**EMV tag 8A. A code returned by the card issuer.*/ authorization_response_code: z .string() .max(5000) - .nullable() .describe('EMV tag 8A. A code returned by the card issuer.') .optional(), - /** Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`. */ + /**Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`.*/ cardholder_verification_method: z .string() .max(5000) - .nullable() .describe( 'Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`.' ) .optional(), - /** EMV tag 84. Similar to the application identifier stored on the integrated circuit chip. */ + /**EMV tag 84. Similar to the application identifier stored on the integrated circuit chip.*/ dedicated_file_name: z .string() .max(5000) - .nullable() .describe( 'EMV tag 84. Similar to the application identifier stored on the integrated circuit chip.' ) .optional(), - /** The outcome of a series of EMV functions performed by the card reader. */ + /**The outcome of a series of EMV functions performed by the card reader.*/ terminal_verification_results: z .string() .max(5000) - .nullable() .describe( 'The outcome of a series of EMV functions performed by the card reader.' ) .optional(), - /** An indication of various EMV functions performed during the transaction. */ + /**An indication of various EMV functions performed during the transaction.*/ transaction_status_information: z .string() .max(5000) - .nullable() .describe( 'An indication of various EMV functions performed during the transaction.' ) @@ -5342,11 +5031,10 @@ export namespace stripe { > export const PaymentMethodDetailsKakaoPaySchema = z.object({ - /** A unique identifier for the buyer as determined by the local payment processor. */ + /**A unique identifier for the buyer as determined by the local payment processor.*/ buyer_id: z .string() .max(5000) - .nullable() .describe( 'A unique identifier for the buyer as determined by the local payment processor.' ) @@ -5357,21 +5045,19 @@ export namespace stripe { > export const KlarnaAddressSchema = z.object({ - /** The payer address country */ + /**The payer address country*/ country: z .string() .max(5000) - .nullable() .describe('The payer address country') .optional() }) export type KlarnaAddress = z.infer export const PaymentMethodDetailsKonbiniStoreSchema = z.object({ - /** The name of the convenience store chain where the payment was completed. */ + /**The name of the convenience store chain where the payment was completed.*/ chain: z .enum(['familymart', 'lawson', 'ministop', 'seicomart']) - .nullable() .describe( 'The name of the convenience store chain where the payment was completed.' ) @@ -5382,7 +5068,7 @@ export namespace stripe { > export const PaymentMethodDetailsKrCardSchema = z.object({ - /** The local credit or debit card brand. */ + /**The local credit or debit card brand.*/ brand: z .enum([ 'bc', @@ -5408,23 +5094,20 @@ export namespace stripe { 'tossbank', 'woori' ]) - .nullable() .describe('The local credit or debit card brand.') .optional(), - /** A unique identifier for the buyer as determined by the local payment processor. */ + /**A unique identifier for the buyer as determined by the local payment processor.*/ buyer_id: z .string() .max(5000) - .nullable() .describe( 'A unique identifier for the buyer as determined by the local payment processor.' ) .optional(), - /** The last four digits of the card. This may not be present for American Express cards. */ + /**The last four digits of the card. This may not be present for American Express cards.*/ last4: z .string() .max(4) - .nullable() .describe( 'The last four digits of the card. This may not be present for American Express cards.' ) @@ -5442,7 +5125,6 @@ export namespace stripe { country: z .string() .max(5000) - .nullable() .describe( 'Two-letter ISO code representing the funding source country beneath the Link payment.\nYou could use this attribute to get a sense of international fees.' ) @@ -5453,57 +5135,50 @@ export namespace stripe { > export const InternalCardSchema = z.object({ - /** Brand of the card used in the transaction */ + /**Brand of the card used in the transaction*/ brand: z .string() .max(5000) - .nullable() .describe('Brand of the card used in the transaction') .optional(), - /** Two-letter ISO code representing the country of the card */ + /**Two-letter ISO code representing the country of the card*/ country: z .string() .max(5000) - .nullable() .describe('Two-letter ISO code representing the country of the card') .optional(), - /** Two digit number representing the card's expiration month */ + /**Two digit number representing the card's expiration month*/ exp_month: z .number() .int() - .nullable() .describe("Two digit number representing the card's expiration month") .optional(), - /** Two digit number representing the card's expiration year */ + /**Two digit number representing the card's expiration year*/ exp_year: z .number() .int() - .nullable() .describe("Two digit number representing the card's expiration year") .optional(), - /** The last 4 digits of the card */ + /**The last 4 digits of the card*/ last4: z .string() .max(5000) - .nullable() .describe('The last 4 digits of the card') .optional() }) export type InternalCard = z.infer export const PaymentMethodDetailsMultibancoSchema = z.object({ - /** Entity number associated with this Multibanco payment. */ + /**Entity number associated with this Multibanco payment.*/ entity: z .string() .max(5000) - .nullable() .describe('Entity number associated with this Multibanco payment.') .optional(), - /** Reference number associated with this Multibanco payment. */ + /**Reference number associated with this Multibanco payment.*/ reference: z .string() .max(5000) - .nullable() .describe('Reference number associated with this Multibanco payment.') .optional() }) @@ -5512,11 +5187,10 @@ export namespace stripe { > export const PaymentMethodDetailsNaverPaySchema = z.object({ - /** A unique identifier for the buyer as determined by the local payment processor. */ + /**A unique identifier for the buyer as determined by the local payment processor.*/ buyer_id: z .string() .max(5000) - .nullable() .describe( 'A unique identifier for the buyer as determined by the local payment processor.' ) @@ -5527,20 +5201,15 @@ export namespace stripe { > export const PaymentMethodDetailsOxxoSchema = z.object({ - /** OXXO reference number */ - number: z - .string() - .max(5000) - .nullable() - .describe('OXXO reference number') - .optional() + /**OXXO reference number*/ + number: z.string().max(5000).describe('OXXO reference number').optional() }) export type PaymentMethodDetailsOxxo = z.infer< typeof PaymentMethodDetailsOxxoSchema > export const PaymentMethodDetailsP24Schema = z.object({ - /** The customer's bank. Can be one of `ing`, `citi_handlowy`, `tmobile_usbugi_bankowe`, `plus_bank`, `etransfer_pocztowy24`, `banki_spbdzielcze`, `bank_nowy_bfg_sa`, `getin_bank`, `velobank`, `blik`, `noble_pay`, `ideabank`, `envelobank`, `santander_przelew24`, `nest_przelew`, `mbank_mtransfer`, `inteligo`, `pbac_z_ipko`, `bnp_paribas`, `credit_agricole`, `toyota_bank`, `bank_pekao_sa`, `volkswagen_bank`, `bank_millennium`, `alior_bank`, or `boz`. */ + /**The customer's bank. Can be one of `ing`, `citi_handlowy`, `tmobile_usbugi_bankowe`, `plus_bank`, `etransfer_pocztowy24`, `banki_spbdzielcze`, `bank_nowy_bfg_sa`, `getin_bank`, `velobank`, `blik`, `noble_pay`, `ideabank`, `envelobank`, `santander_przelew24`, `nest_przelew`, `mbank_mtransfer`, `inteligo`, `pbac_z_ipko`, `bnp_paribas`, `credit_agricole`, `toyota_bank`, `bank_pekao_sa`, `volkswagen_bank`, `bank_millennium`, `alior_bank`, or `boz`.*/ bank: z .enum([ 'alior_bank', @@ -5570,16 +5239,14 @@ export namespace stripe { 'velobank', 'volkswagen_bank' ]) - .nullable() .describe( "The customer's bank. Can be one of `ing`, `citi_handlowy`, `tmobile_usbugi_bankowe`, `plus_bank`, `etransfer_pocztowy24`, `banki_spbdzielcze`, `bank_nowy_bfg_sa`, `getin_bank`, `velobank`, `blik`, `noble_pay`, `ideabank`, `envelobank`, `santander_przelew24`, `nest_przelew`, `mbank_mtransfer`, `inteligo`, `pbac_z_ipko`, `bnp_paribas`, `credit_agricole`, `toyota_bank`, `bank_pekao_sa`, `volkswagen_bank`, `bank_millennium`, `alior_bank`, or `boz`." ) .optional(), - /** Unique reference for this Przelewy24 payment. */ + /**Unique reference for this Przelewy24 payment.*/ reference: z .string() .max(5000) - .nullable() .describe('Unique reference for this Przelewy24 payment.') .optional(), /** @@ -5590,7 +5257,6 @@ export namespace stripe { verified_name: z .string() .max(5000) - .nullable() .describe( "Owner's verified full name. Values are verified or provided by Przelewy24 directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.\nPrzelewy24 rarely provides this information so the attribute is usually empty." ) @@ -5606,11 +5272,10 @@ export namespace stripe { > export const PaymentMethodDetailsPaycoSchema = z.object({ - /** A unique identifier for the buyer as determined by the local payment processor. */ + /**A unique identifier for the buyer as determined by the local payment processor.*/ buyer_id: z .string() .max(5000) - .nullable() .describe( 'A unique identifier for the buyer as determined by the local payment processor.' ) @@ -5621,11 +5286,10 @@ export namespace stripe { > export const PaymentMethodDetailsPaynowSchema = z.object({ - /** Reference number associated with this PayNow payment */ + /**Reference number associated with this PayNow payment*/ reference: z .string() .max(5000) - .nullable() .describe('Reference number associated with this PayNow payment') .optional() }) @@ -5634,15 +5298,14 @@ export namespace stripe { > export const PaypalSellerProtectionSchema = z.object({ - /** An array of conditions that are covered for the transaction, if applicable. */ + /**An array of conditions that are covered for the transaction, if applicable.*/ dispute_categories: z .array(z.enum(['fraudulent', 'product_not_received'])) - .nullable() .describe( 'An array of conditions that are covered for the transaction, if applicable.' ) .optional(), - /** Indicates whether the transaction is eligible for PayPal's seller protection. */ + /**Indicates whether the transaction is eligible for PayPal's seller protection.*/ status: z .enum(['eligible', 'not_eligible', 'partially_eligible']) .describe( @@ -5654,11 +5317,10 @@ export namespace stripe { > export const PaymentMethodDetailsPixSchema = z.object({ - /** Unique transaction id generated by BCB */ + /**Unique transaction id generated by BCB*/ bank_transaction_id: z .string() .max(5000) - .nullable() .describe('Unique transaction id generated by BCB') .optional() }) @@ -5667,11 +5329,10 @@ export namespace stripe { > export const PaymentMethodDetailsPromptpaySchema = z.object({ - /** Bill reference generated by PromptPay */ + /**Bill reference generated by PromptPay*/ reference: z .string() .max(5000) - .nullable() .describe('Bill reference generated by PromptPay') .optional() }) @@ -5680,11 +5341,10 @@ export namespace stripe { > export const PaymentMethodDetailsSamsungPaySchema = z.object({ - /** A unique identifier for the buyer as determined by the local payment processor. */ + /**A unique identifier for the buyer as determined by the local payment processor.*/ buyer_id: z .string() .max(5000) - .nullable() .describe( 'A unique identifier for the buyer as determined by the local payment processor.' ) @@ -5695,50 +5355,44 @@ export namespace stripe { > export const PaymentMethodDetailsSepaDebitSchema = z.object({ - /** Bank code of bank associated with the bank account. */ + /**Bank code of bank associated with the bank account.*/ bank_code: z .string() .max(5000) - .nullable() .describe('Bank code of bank associated with the bank account.') .optional(), - /** Branch code of bank associated with the bank account. */ + /**Branch code of bank associated with the bank account.*/ branch_code: z .string() .max(5000) - .nullable() .describe('Branch code of bank associated with the bank account.') .optional(), - /** Two-letter ISO code representing the country the bank account is located in. */ + /**Two-letter ISO code representing the country the bank account is located in.*/ country: z .string() .max(5000) - .nullable() .describe( 'Two-letter ISO code representing the country the bank account is located in.' ) .optional(), - /** Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /**Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.*/ fingerprint: z .string() .max(5000) - .nullable() .describe( 'Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.' ) .optional(), - /** Last four characters of the IBAN. */ + /**Last four characters of the IBAN.*/ last4: z .string() .max(5000) - .nullable() .describe('Last four characters of the IBAN.') .optional(), - /** Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) property on the Charge. Use this mandate ID to [retrieve the Mandate](https://stripe.com/docs/api/mandates/retrieve). */ + /**Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) property on the Charge. Use this mandate ID to [retrieve the Mandate](https://stripe.com/docs/api/mandates/retrieve).*/ mandate: z .string() .max(5000) - .nullable() .describe( 'Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) property on the Charge. Use this mandate ID to [retrieve the Mandate](https://stripe.com/docs/api/mandates/retrieve).' ) @@ -5754,27 +5408,24 @@ export namespace stripe { > export const PaymentMethodDetailsSwishSchema = z.object({ - /** Uniquely identifies the payer's Swish account. You can use this attribute to check whether two Swish transactions were paid for by the same payer */ + /**Uniquely identifies the payer's Swish account. You can use this attribute to check whether two Swish transactions were paid for by the same payer*/ fingerprint: z .string() .max(5000) - .nullable() .describe( "Uniquely identifies the payer's Swish account. You can use this attribute to check whether two Swish transactions were paid for by the same payer" ) .optional(), - /** Payer bank reference number for the payment */ + /**Payer bank reference number for the payment*/ payment_reference: z .string() .max(5000) - .nullable() .describe('Payer bank reference number for the payment') .optional(), - /** The last four digits of the Swish account phone number */ + /**The last four digits of the Swish account phone number*/ verified_phone_last4: z .string() .max(5000) - .nullable() .describe('The last four digits of the Swish account phone number') .optional() }) @@ -5793,20 +5444,18 @@ export namespace stripe { > export const PaymentMethodDetailsWechatPaySchema = z.object({ - /** Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same. */ + /**Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same.*/ fingerprint: z .string() .max(5000) - .nullable() .describe( 'Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same.' ) .optional(), - /** Transaction ID of this particular WeChat Pay transaction. */ + /**Transaction ID of this particular WeChat Pay transaction.*/ transaction_id: z .string() .max(5000) - .nullable() .describe('Transaction ID of this particular WeChat Pay transaction.') .optional() }) @@ -5819,10 +5468,10 @@ export namespace stripe { typeof PaymentMethodDetailsZipSchema > - /** Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information. */ + /**Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.*/ export const RadarRadarOptionsSchema = z .object({ - /** A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. */ + /**A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.*/ session: z .string() .max(5000) @@ -5837,39 +5486,34 @@ export namespace stripe { export type RadarRadarOptions = z.infer export const RadarReviewResourceLocationSchema = z.object({ - /** The city where the payment originated. */ + /**The city where the payment originated.*/ city: z .string() .max(5000) - .nullable() .describe('The city where the payment originated.') .optional(), - /** Two-letter ISO code representing the country where the payment originated. */ + /**Two-letter ISO code representing the country where the payment originated.*/ country: z .string() .max(5000) - .nullable() .describe( 'Two-letter ISO code representing the country where the payment originated.' ) .optional(), - /** The geographic latitude where the payment originated. */ + /**The geographic latitude where the payment originated.*/ latitude: z .number() - .nullable() .describe('The geographic latitude where the payment originated.') .optional(), - /** The geographic longitude where the payment originated. */ + /**The geographic longitude where the payment originated.*/ longitude: z .number() - .nullable() .describe('The geographic longitude where the payment originated.') .optional(), - /** The state/county/province/region where the payment originated. */ + /**The state/county/province/region where the payment originated.*/ region: z .string() .max(5000) - .nullable() .describe( 'The state/county/province/region where the payment originated.' ) @@ -5880,34 +5524,30 @@ export namespace stripe { > export const RadarReviewResourceSessionSchema = z.object({ - /** The browser used in this browser session (e.g., `Chrome`). */ + /**The browser used in this browser session (e.g., `Chrome`).*/ browser: z .string() .max(5000) - .nullable() .describe('The browser used in this browser session (e.g., `Chrome`).') .optional(), - /** Information about the device used for the browser session (e.g., `Samsung SM-G930T`). */ + /**Information about the device used for the browser session (e.g., `Samsung SM-G930T`).*/ device: z .string() .max(5000) - .nullable() .describe( 'Information about the device used for the browser session (e.g., `Samsung SM-G930T`).' ) .optional(), - /** The platform for the browser session (e.g., `Macintosh`). */ + /**The platform for the browser session (e.g., `Macintosh`).*/ platform: z .string() .max(5000) - .nullable() .describe('The platform for the browser session (e.g., `Macintosh`).') .optional(), - /** The version for the browser session (e.g., `61.0.3163.100`). */ + /**The version for the browser session (e.g., `61.0.3163.100`).*/ version: z .string() .max(5000) - .nullable() .describe('The version for the browser session (e.g., `61.0.3163.100`).') .optional() }) @@ -5916,7 +5556,7 @@ export namespace stripe { > export const InvoicesResourceInvoiceTaxIdSchema = z.object({ - /** The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or `unknown` */ + /**The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or `unknown`*/ type: z .enum([ 'ad_nrt', @@ -6024,29 +5664,24 @@ export namespace stripe { .describe( 'The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or `unknown`' ), - /** The value of the tax ID. */ - value: z - .string() - .max(5000) - .nullable() - .describe('The value of the tax ID.') - .optional() + /**The value of the tax ID.*/ + value: z.string().max(5000).describe('The value of the tax ID.').optional() }) export type InvoicesResourceInvoiceTaxId = z.infer< typeof InvoicesResourceInvoiceTaxIdSchema > - /** The amount of the tax rate when the `rate_type`` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate. */ + /**The amount of the tax rate when the `rate_type`` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate.*/ export const TaxRateFlatAmountSchema = z .object({ - /** Amount of the tax when the `rate_type` is `flat_amount`. This positive integer represents how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). */ + /**Amount of the tax when the `rate_type` is `flat_amount`. This positive integer represents how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).*/ amount: z .number() .int() .describe( 'Amount of the tax when the `rate_type` is `flat_amount`. This positive integer represents how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).' ), - /** Three-letter ISO currency code, in lowercase. */ + /**Three-letter ISO currency code, in lowercase.*/ currency: z .string() .max(5000) @@ -6058,14 +5693,14 @@ export namespace stripe { export type TaxRateFlatAmount = z.infer export const InvoiceLineItemPeriodSchema = z.object({ - /** The end of the period, which must be greater than or equal to the start. This value is inclusive. */ + /**The end of the period, which must be greater than or equal to the start. This value is inclusive.*/ end: z .number() .int() .describe( 'The end of the period, which must be greater than or equal to the start. This value is inclusive.' ), - /** The start of the period. This value is inclusive. */ + /**The start of the period. This value is inclusive.*/ start: z .number() .int() @@ -6076,29 +5711,26 @@ export namespace stripe { > export const CustomUnitAmountSchema = z.object({ - /** The maximum unit amount the customer can specify for this item. */ + /**The maximum unit amount the customer can specify for this item.*/ maximum: z .number() .int() - .nullable() .describe( 'The maximum unit amount the customer can specify for this item.' ) .optional(), - /** The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount. */ + /**The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.*/ minimum: z .number() .int() - .nullable() .describe( 'The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.' ) .optional(), - /** The starting unit amount which can be updated by the customer. */ + /**The starting unit amount which can be updated by the customer.*/ preset: z .number() .int() - .nullable() .describe( 'The starting unit amount which can be updated by the customer.' ) @@ -6107,41 +5739,36 @@ export namespace stripe { export type CustomUnitAmount = z.infer export const PriceTierSchema = z.object({ - /** Price for the entire tier. */ + /**Price for the entire tier.*/ flat_amount: z .number() .int() - .nullable() .describe('Price for the entire tier.') .optional(), - /** Same as `flat_amount`, but contains a decimal value with at most 12 decimal places. */ + /**Same as `flat_amount`, but contains a decimal value with at most 12 decimal places.*/ flat_amount_decimal: z .string() - .nullable() .describe( 'Same as `flat_amount`, but contains a decimal value with at most 12 decimal places.' ) .optional(), - /** Per unit price for units relevant to the tier. */ + /**Per unit price for units relevant to the tier.*/ unit_amount: z .number() .int() - .nullable() .describe('Per unit price for units relevant to the tier.') .optional(), - /** Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. */ + /**Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.*/ unit_amount_decimal: z .string() - .nullable() .describe( 'Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.' ) .optional(), - /** Up to and including to this quantity will be contained in the tier. */ + /**Up to and including to this quantity will be contained in the tier.*/ up_to: z .number() .int() - .nullable() .describe( 'Up to and including to this quantity will be contained in the tier.' ) @@ -6150,7 +5777,7 @@ export namespace stripe { export type PriceTier = z.infer export const ProductMarketingFeatureSchema = z.object({ - /** The marketing feature name. Up to 80 characters long. */ + /**The marketing feature name. Up to 80 characters long.*/ name: z .string() .max(5000) @@ -6162,32 +5789,32 @@ export namespace stripe { > export const PackageDimensionsSchema = z.object({ - /** Height, in inches. */ + /**Height, in inches.*/ height: z.number().describe('Height, in inches.'), - /** Length, in inches. */ + /**Length, in inches.*/ length: z.number().describe('Length, in inches.'), - /** Weight, in ounces. */ + /**Weight, in ounces.*/ weight: z.number().describe('Weight, in ounces.'), - /** Width, in inches. */ + /**Width, in inches.*/ width: z.number().describe('Width, in inches.') }) export type PackageDimensions = z.infer - /** [Tax codes](https://stripe.com/docs/tax/tax-categories) classify goods and services for tax purposes. */ + /**[Tax codes](https://stripe.com/docs/tax/tax-categories) classify goods and services for tax purposes.*/ export const TaxCodeSchema = z .object({ - /** A detailed description of which types of products the tax code represents. */ + /**A detailed description of which types of products the tax code represents.*/ description: z .string() .max(5000) .describe( 'A detailed description of which types of products the tax code represents.' ), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** A short name for the tax code. */ + /**A short name for the tax code.*/ name: z.string().max(5000).describe('A short name for the tax code.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('tax_code') .describe( @@ -6200,11 +5827,11 @@ export namespace stripe { export type TaxCode = z.infer export const DeletedProductSchema = z.object({ - /** Always true for a deleted object */ + /**Always true for a deleted object*/ deleted: z.literal(true).describe('Always true for a deleted object'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('product') .describe( @@ -6214,35 +5841,33 @@ export namespace stripe { export type DeletedProduct = z.infer export const RecurringSchema = z.object({ - /** Specifies a usage aggregation strategy for prices of `usage_type=metered`. Defaults to `sum`. */ + /**Specifies a usage aggregation strategy for prices of `usage_type=metered`. Defaults to `sum`.*/ aggregate_usage: z .enum(['last_during_period', 'last_ever', 'max', 'sum']) - .nullable() .describe( 'Specifies a usage aggregation strategy for prices of `usage_type=metered`. Defaults to `sum`.' ) .optional(), - /** The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`. */ + /**The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.*/ interval: z .enum(['day', 'month', 'week', 'year']) .describe( 'The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.' ), - /** The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. */ + /**The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.*/ interval_count: z .number() .int() .describe( 'The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.' ), - /** The meter tracking the usage of a metered price */ + /**The meter tracking the usage of a metered price*/ meter: z .string() .max(5000) - .nullable() .describe('The meter tracking the usage of a metered price') .optional(), - /** Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`. */ + /**Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.*/ usage_type: z .enum(['licensed', 'metered']) .describe( @@ -6252,9 +5877,9 @@ export namespace stripe { export type Recurring = z.infer export const TransformQuantitySchema = z.object({ - /** Divide usage by this number. */ + /**Divide usage by this number.*/ divide_by: z.number().int().describe('Divide usage by this number.'), - /** After division, either round the result `up` or `down`. */ + /**After division, either round the result `up` or `down`.*/ round: z .enum(['down', 'up']) .describe('After division, either round the result `up` or `down`.') @@ -6262,37 +5887,33 @@ export namespace stripe { export type TransformQuantity = z.infer export const SubscriptionsResourceBillingCycleAnchorConfigSchema = z.object({ - /** The day of the month of the billing_cycle_anchor. */ + /**The day of the month of the billing_cycle_anchor.*/ day_of_month: z .number() .int() .describe('The day of the month of the billing_cycle_anchor.'), - /** The hour of the day of the billing_cycle_anchor. */ + /**The hour of the day of the billing_cycle_anchor.*/ hour: z .number() .int() - .nullable() .describe('The hour of the day of the billing_cycle_anchor.') .optional(), - /** The minute of the hour of the billing_cycle_anchor. */ + /**The minute of the hour of the billing_cycle_anchor.*/ minute: z .number() .int() - .nullable() .describe('The minute of the hour of the billing_cycle_anchor.') .optional(), - /** The month to start full cycle billing periods. */ + /**The month to start full cycle billing periods.*/ month: z .number() .int() - .nullable() .describe('The month to start full cycle billing periods.') .optional(), - /** The second of the minute of the billing_cycle_anchor. */ + /**The second of the minute of the billing_cycle_anchor.*/ second: z .number() .int() - .nullable() .describe('The second of the minute of the billing_cycle_anchor.') .optional() }) @@ -6301,19 +5922,17 @@ export namespace stripe { > export const SubscriptionBillingThresholdsSchema = z.object({ - /** Monetary threshold that triggers the subscription to create an invoice */ + /**Monetary threshold that triggers the subscription to create an invoice*/ amount_gte: z .number() .int() - .nullable() .describe( 'Monetary threshold that triggers the subscription to create an invoice' ) .optional(), - /** Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`. */ + /**Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`.*/ reset_billing_cycle_anchor: z .boolean() - .nullable() .describe( 'Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`.' ) @@ -6324,16 +5943,15 @@ export namespace stripe { > export const CancellationDetailsSchema = z.object({ - /** Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user. */ + /**Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.*/ comment: z .string() .max(5000) - .nullable() .describe( 'Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.' ) .optional(), - /** The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user. */ + /**The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.*/ feedback: z .enum([ 'customer_service', @@ -6345,26 +5963,23 @@ export namespace stripe { 'too_expensive', 'unused' ]) - .nullable() .describe( 'The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.' ) .optional(), - /** Why this subscription was canceled. */ + /**Why this subscription was canceled.*/ reason: z .enum(['cancellation_requested', 'payment_disputed', 'payment_failed']) - .nullable() .describe('Why this subscription was canceled.') .optional() }) export type CancellationDetails = z.infer export const SubscriptionItemBillingThresholdsSchema = z.object({ - /** Usage threshold that triggers the subscription to create an invoice */ + /**Usage threshold that triggers the subscription to create an invoice*/ usage_gte: z .number() .int() - .nullable() .describe( 'Usage threshold that triggers the subscription to create an invoice' ) @@ -6380,17 +5995,16 @@ export namespace stripe { */ export const SubscriptionsResourcePauseCollectionSchema = z .object({ - /** The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`. */ + /**The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.*/ behavior: z .enum(['keep_as_draft', 'mark_uncollectible', 'void']) .describe( 'The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.' ), - /** The time after which the subscription will resume collecting payments. */ + /**The time after which the subscription will resume collecting payments.*/ resumes_at: z .number() .int() - .nullable() .describe( 'The time after which the subscription will resume collecting payments.' ) @@ -6405,10 +6019,9 @@ export namespace stripe { export const InvoicePaymentMethodOptionsAcssDebitMandateOptionsSchema = z.object({ - /** Transaction type of the mandate. */ + /**Transaction type of the mandate.*/ transaction_type: z .enum(['business', 'personal']) - .nullable() .describe('Transaction type of the mandate.') .optional() }) @@ -6417,7 +6030,7 @@ export namespace stripe { > export const InvoicePaymentMethodOptionsBancontactSchema = z.object({ - /** Preferred language of the Bancontact authorization page that the customer is redirected to. */ + /**Preferred language of the Bancontact authorization page that the customer is redirected to.*/ preferred_language: z .enum(['de', 'en', 'fr', 'nl']) .describe( @@ -6429,26 +6042,23 @@ export namespace stripe { > export const InvoiceMandateOptionsCardSchema = z.object({ - /** Amount to be charged for future payments. */ + /**Amount to be charged for future payments.*/ amount: z .number() .int() - .nullable() .describe('Amount to be charged for future payments.') .optional(), - /** One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param. */ + /**One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.*/ amount_type: z .enum(['fixed', 'maximum']) - .nullable() .describe( 'One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.' ) .optional(), - /** A description of the mandate or subscription that is meant to be displayed to the customer. */ + /**A description of the mandate or subscription that is meant to be displayed to the customer.*/ description: z .string() .max(200) - .nullable() .describe( 'A description of the mandate or subscription that is meant to be displayed to the customer.' ) @@ -6460,7 +6070,7 @@ export namespace stripe { export const InvoicePaymentMethodOptionsCustomerBalanceBankTransferEuBankTransferSchema = z.object({ - /** The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. */ + /**The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.*/ country: z .enum(['BE', 'DE', 'ES', 'FR', 'IE', 'NL']) .describe( @@ -6484,7 +6094,7 @@ export namespace stripe { export const InvoicePaymentMethodOptionsUsBankAccountLinkedAccountOptionsFiltersSchema = z.object({ - /** The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`. */ + /**The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.*/ account_subcategories: z .array(z.enum(['checking', 'savings'])) .describe( @@ -6498,13 +6108,13 @@ export namespace stripe { > export const SubscriptionPendingInvoiceItemIntervalSchema = z.object({ - /** Specifies invoicing frequency. Either `day`, `week`, `month` or `year`. */ + /**Specifies invoicing frequency. Either `day`, `week`, `month` or `year`.*/ interval: z .enum(['day', 'month', 'week', 'year']) .describe( 'Specifies invoicing frequency. Either `day`, `week`, `month` or `year`.' ), - /** The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). */ + /**The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).*/ interval_count: z .number() .int() @@ -6528,10 +6138,9 @@ export namespace stripe { "Controls whether this SetupIntent will accept redirect-based payment methods.\n\nRedirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/setup_intents/confirm) this SetupIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the setup." ) .optional(), - /** Automatically calculates compatible payment methods */ + /**Automatically calculates compatible payment methods*/ enabled: z .boolean() - .nullable() .describe('Automatically calculates compatible payment methods') .optional() }) @@ -6540,17 +6149,17 @@ export namespace stripe { > export const PaymentIntentNextActionCashappQrCodeSchema = z.object({ - /** The date (unix timestamp) when the QR code expires. */ + /**The date (unix timestamp) when the QR code expires.*/ expires_at: z .number() .int() .describe('The date (unix timestamp) when the QR code expires.'), - /** The image_url_png string used to render QR code */ + /**The image_url_png string used to render QR code*/ image_url_png: z .string() .max(5000) .describe('The image_url_png string used to render QR code'), - /** The image_url_svg string used to render QR code */ + /**The image_url_svg string used to render QR code*/ image_url_svg: z .string() .max(5000) @@ -6561,20 +6170,18 @@ export namespace stripe { > export const SetupIntentNextActionRedirectToUrlSchema = z.object({ - /** If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. */ + /**If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.*/ return_url: z .string() .max(5000) - .nullable() .describe( 'If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.' ) .optional(), - /** The URL you must redirect your customer to in order to authenticate. */ + /**The URL you must redirect your customer to in order to authenticate.*/ url: z .string() .max(5000) - .nullable() .describe( 'The URL you must redirect your customer to in order to authenticate.' ) @@ -6585,22 +6192,21 @@ export namespace stripe { > export const SetupIntentNextActionVerifyWithMicrodepositsSchema = z.object({ - /** The timestamp when the microdeposits are expected to land. */ + /**The timestamp when the microdeposits are expected to land.*/ arrival_date: z .number() .int() .describe('The timestamp when the microdeposits are expected to land.'), - /** The URL for the hosted verification page, which allows customers to verify their bank account. */ + /**The URL for the hosted verification page, which allows customers to verify their bank account.*/ hosted_verification_url: z .string() .max(5000) .describe( 'The URL for the hosted verification page, which allows customers to verify their bank account.' ), - /** The type of the microdeposit sent to the customer. Used to distinguish between different verification methods. */ + /**The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.*/ microdeposit_type: z .enum(['amounts', 'descriptor_code']) - .nullable() .describe( 'The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.' ) @@ -6612,16 +6218,15 @@ export namespace stripe { export const PaymentMethodConfigBizPaymentMethodConfigurationDetailsSchema = z.object({ - /** ID of the payment method configuration used. */ + /**ID of the payment method configuration used.*/ id: z .string() .max(5000) .describe('ID of the payment method configuration used.'), - /** ID of the parent payment method configuration used. */ + /**ID of the parent payment method configuration used.*/ parent: z .string() .max(5000) - .nullable() .describe('ID of the parent payment method configuration used.') .optional() }) @@ -6631,38 +6236,35 @@ export namespace stripe { export const SetupIntentPaymentMethodOptionsMandateOptionsAcssDebitSchema = z.object({ - /** A URL for custom mandate text */ + /**A URL for custom mandate text*/ custom_mandate_url: z .string() .max(5000) .describe('A URL for custom mandate text') .optional(), - /** List of Stripe products where this mandate can be selected automatically. */ + /**List of Stripe products where this mandate can be selected automatically.*/ default_for: z .array(z.enum(['invoice', 'subscription'])) .describe( 'List of Stripe products where this mandate can be selected automatically.' ) .optional(), - /** Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. */ + /**Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.*/ interval_description: z .string() .max(5000) - .nullable() .describe( "Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'." ) .optional(), - /** Payment schedule for the mandate. */ + /**Payment schedule for the mandate.*/ payment_schedule: z .enum(['combined', 'interval', 'sporadic']) - .nullable() .describe('Payment schedule for the mandate.') .optional(), - /** Transaction type of the mandate. */ + /**Transaction type of the mandate.*/ transaction_type: z .enum(['business', 'personal']) - .nullable() .describe('Transaction type of the mandate.') .optional() }) @@ -6672,7 +6274,7 @@ export namespace stripe { export const SetupIntentTypeSpecificPaymentMethodOptionsClientSchema = z.object({ - /** Bank account verification method. */ + /**Bank account verification method.*/ verification_method: z .enum(['automatic', 'instant', 'microdeposits']) .describe('Bank account verification method.') @@ -6689,7 +6291,7 @@ export namespace stripe { export const SetupIntentPaymentMethodOptionsMandateOptionsBacsDebitSchema = z.object({ - /** Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'. */ + /**Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.*/ reference_prefix: z .string() .max(5000) @@ -6704,72 +6306,68 @@ export namespace stripe { export const SetupIntentPaymentMethodOptionsCardMandateOptionsSchema = z.object({ - /** Amount to be charged for future payments. */ + /**Amount to be charged for future payments.*/ amount: z .number() .int() .describe('Amount to be charged for future payments.'), - /** One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param. */ + /**One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.*/ amount_type: z .enum(['fixed', 'maximum']) .describe( 'One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** A description of the mandate or subscription that is meant to be displayed to the customer. */ + /**A description of the mandate or subscription that is meant to be displayed to the customer.*/ description: z .string() .max(200) - .nullable() .describe( 'A description of the mandate or subscription that is meant to be displayed to the customer.' ) .optional(), - /** End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date. */ + /**End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.*/ end_date: z .number() .int() - .nullable() .describe( 'End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.' ) .optional(), - /** Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`. */ + /**Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.*/ interval: z .enum(['day', 'month', 'sporadic', 'week', 'year']) .describe( 'Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.' ), - /** The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`. */ + /**The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.*/ interval_count: z .number() .int() - .nullable() .describe( 'The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.' ) .optional(), - /** Unique identifier for the mandate or subscription. */ + /**Unique identifier for the mandate or subscription.*/ reference: z .string() .max(80) .describe('Unique identifier for the mandate or subscription.'), - /** Start date of the mandate or subscription. Start date should not be lesser than yesterday. */ + /**Start date of the mandate or subscription. Start date should not be lesser than yesterday.*/ start_date: z .number() .int() .describe( 'Start date of the mandate or subscription. Start date should not be lesser than yesterday.' ), - /** Specifies the type of mandates supported. Possible values are `india`. */ + /**Specifies the type of mandates supported. Possible values are `india`.*/ supported_types: z .array(z.literal('india')) - .nullable() .describe( 'Specifies the type of mandates supported. Possible values are `india`.' ) @@ -6790,11 +6388,10 @@ export namespace stripe { > export const SetupIntentPaymentMethodOptionsPaypalSchema = z.object({ - /** The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer. */ + /**The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.*/ billing_agreement_id: z .string() .max(5000) - .nullable() .describe( 'The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.' ) @@ -6806,7 +6403,7 @@ export namespace stripe { export const SetupIntentPaymentMethodOptionsMandateOptionsSepaDebitSchema = z.object({ - /** Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'. */ + /**Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.*/ reference_prefix: z .string() .max(5000) @@ -6821,7 +6418,7 @@ export namespace stripe { export const PaymentFlowsPrivatePaymentMethodsUsBankAccountLinkedAccountOptionsFiltersSchema = z.object({ - /** The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`. */ + /**The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.*/ account_subcategories: z .array(z.enum(['checking', 'savings'])) .describe( @@ -6836,7 +6433,7 @@ export namespace stripe { export const PaymentMethodOptionsUsBankAccountMandateOptionsSchema = z.object( { - /** Mandate collection method */ + /**Mandate collection method*/ collection_method: z .literal('paper') .describe('Mandate collection method') @@ -6848,12 +6445,12 @@ export namespace stripe { > export const SubscriptionScheduleCurrentPhaseSchema = z.object({ - /** The end of this phase of the subscription schedule. */ + /**The end of this phase of the subscription schedule.*/ end_date: z .number() .int() .describe('The end of this phase of the subscription schedule.'), - /** The start of this phase of the subscription schedule. */ + /**The start of this phase of the subscription schedule.*/ start_date: z .number() .int() @@ -6864,11 +6461,11 @@ export namespace stripe { > export const DeletedPriceSchema = z.object({ - /** Always true for a deleted object */ + /**Always true for a deleted object*/ deleted: z.literal(true).describe('Always true for a deleted object'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('price') .describe( @@ -6878,11 +6475,11 @@ export namespace stripe { export type DeletedPrice = z.infer export const DeletedCouponSchema = z.object({ - /** Always true for a deleted object */ + /**Always true for a deleted object*/ deleted: z.literal(true).describe('Always true for a deleted object'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('coupon') .describe( @@ -6893,7 +6490,7 @@ export namespace stripe { export const BillingClocksResourceStatusDetailsAdvancingStatusDetailsSchema = z.object({ - /** The `frozen_time` that the Test Clock is advancing towards. */ + /**The `frozen_time` that the Test Clock is advancing towards.*/ target_frozen_time: z .number() .int() @@ -6904,10 +6501,10 @@ export namespace stripe { typeof BillingClocksResourceStatusDetailsAdvancingStatusDetailsSchema > - /** Defines how a subscription behaves when a free trial ends. */ + /**Defines how a subscription behaves when a free trial ends.*/ export const SubscriptionsTrialsResourceEndBehaviorSchema = z .object({ - /** Indicates how the subscription should change when the trial ends if the user did not provide a payment method. */ + /**Indicates how the subscription should change when the trial ends if the user did not provide a payment method.*/ missing_payment_method: z .enum(['cancel', 'create_invoice', 'pause']) .describe( @@ -6920,14 +6517,14 @@ export namespace stripe { > export const BillingCreditGrantsResourceMonetaryAmountSchema = z.object({ - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .max(5000) .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** A positive integer representing the amount. */ + /**A positive integer representing the amount.*/ value: z .number() .int() @@ -6938,11 +6535,10 @@ export namespace stripe { > export const BillingCreditGrantsResourceApplicablePriceSchema = z.object({ - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z .string() .max(5000) - .nullable() .describe('Unique identifier for the object.') .optional() }) @@ -6951,12 +6547,12 @@ export namespace stripe { > export const InvoicesResourceLineItemsCreditedItemsSchema = z.object({ - /** Invoice containing the credited invoice line items */ + /**Invoice containing the credited invoice line items*/ invoice: z .string() .max(5000) .describe('Invoice containing the credited invoice line items'), - /** Credited invoice line items */ + /**Credited invoice line items*/ invoice_line_items: z .array(z.string().max(5000)) .describe('Credited invoice line items') @@ -6966,10 +6562,9 @@ export namespace stripe { > export const InvoiceInstallmentsCardSchema = z.object({ - /** Whether Installments are enabled for this Invoice. */ + /**Whether Installments are enabled for this Invoice.*/ enabled: z .boolean() - .nullable() .describe('Whether Installments are enabled for this Invoice.') .optional() }) @@ -6978,11 +6573,11 @@ export namespace stripe { > export const DeletedInvoiceSchema = z.object({ - /** Always true for a deleted object */ + /**Always true for a deleted object*/ deleted: z.literal(true).describe('Always true for a deleted object'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('invoice') .describe( @@ -6992,29 +6587,26 @@ export namespace stripe { export type DeletedInvoice = z.infer export const QuotesResourceStatusTransitionsSchema = z.object({ - /** The time that the quote was accepted. Measured in seconds since Unix epoch. */ + /**The time that the quote was accepted. Measured in seconds since Unix epoch.*/ accepted_at: z .number() .int() - .nullable() .describe( 'The time that the quote was accepted. Measured in seconds since Unix epoch.' ) .optional(), - /** The time that the quote was canceled. Measured in seconds since Unix epoch. */ + /**The time that the quote was canceled. Measured in seconds since Unix epoch.*/ canceled_at: z .number() .int() - .nullable() .describe( 'The time that the quote was canceled. Measured in seconds since Unix epoch.' ) .optional(), - /** The time that the quote was finalized. Measured in seconds since Unix epoch. */ + /**The time that the quote was finalized. Measured in seconds since Unix epoch.*/ finalized_at: z .number() .int() - .nullable() .describe( 'The time that the quote was finalized. Measured in seconds since Unix epoch.' ) @@ -7025,37 +6617,33 @@ export namespace stripe { > export const QuotesResourceSubscriptionDataSubscriptionDataSchema = z.object({ - /** The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. */ + /**The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.*/ description: z .string() .max(5000) - .nullable() .describe( "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs." ) .optional(), - /** When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. This date is ignored if it is in the past when the quote is accepted. Measured in seconds since the Unix epoch. */ + /**When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. This date is ignored if it is in the past when the quote is accepted. Measured in seconds since the Unix epoch.*/ effective_date: z .number() .int() - .nullable() .describe( 'When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. This date is ignored if it is in the past when the quote is accepted. Measured in seconds since the Unix epoch.' ) .optional(), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.*/ metadata: z .record(z.string().max(500)) - .nullable() .describe( "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values." ) .optional(), - /** Integer representing the number of trial period days before the customer is charged for the first time. */ + /**Integer representing the number of trial period days before the customer is charged for the first time.*/ trial_period_days: z .number() .int() - .nullable() .describe( 'Integer representing the number of trial period days before the customer is charged for the first time.' ) @@ -7066,10 +6654,9 @@ export namespace stripe { > export const InvoiceRenderingPdfSchema = z.object({ - /** Page size of invoice pdf. Options include a4, letter, and auto. If set to auto, page size will be switched to a4 or letter based on customer locale. */ + /**Page size of invoice pdf. Options include a4, letter, and auto. If set to auto, page size will be switched to a4 or letter based on customer locale.*/ page_size: z .enum(['a4', 'auto', 'letter']) - .nullable() .describe( 'Page size of invoice pdf. Options include a4, letter, and auto. If set to auto, page size will be switched to a4 or letter based on customer locale.' ) @@ -7078,11 +6665,11 @@ export namespace stripe { export type InvoiceRenderingPdf = z.infer export const ShippingRateDeliveryEstimateBoundSchema = z.object({ - /** A unit of time. */ + /**A unit of time.*/ unit: z .enum(['business_day', 'day', 'hour', 'month', 'week']) .describe('A unit of time.'), - /** Must be greater than 0. */ + /**Must be greater than 0.*/ value: z.number().int().describe('Must be greater than 0.') }) export type ShippingRateDeliveryEstimateBound = z.infer< @@ -7090,14 +6677,14 @@ export namespace stripe { > export const ShippingRateCurrencyOptionSchema = z.object({ - /** A non-negative integer in cents representing how much to charge. */ + /**A non-negative integer in cents representing how much to charge.*/ amount: z .number() .int() .describe( 'A non-negative integer in cents representing how much to charge.' ), - /** Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. */ + /**Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.*/ tax_behavior: z .enum(['exclusive', 'inclusive', 'unspecified']) .describe( @@ -7109,32 +6696,28 @@ export namespace stripe { > export const InvoicesResourceStatusTransitionsSchema = z.object({ - /** The time that the invoice draft was finalized. */ + /**The time that the invoice draft was finalized.*/ finalized_at: z .number() .int() - .nullable() .describe('The time that the invoice draft was finalized.') .optional(), - /** The time that the invoice was marked uncollectible. */ + /**The time that the invoice was marked uncollectible.*/ marked_uncollectible_at: z .number() .int() - .nullable() .describe('The time that the invoice was marked uncollectible.') .optional(), - /** The time that the invoice was paid. */ + /**The time that the invoice was paid.*/ paid_at: z .number() .int() - .nullable() .describe('The time that the invoice was paid.') .optional(), - /** The time that the invoice was voided. */ + /**The time that the invoice was voided.*/ voided_at: z .number() .int() - .nullable() .describe('The time that the invoice was voided.') .optional() }) @@ -7149,7 +6732,6 @@ export namespace stripe { */ metadata: z .record(z.string().max(500)) - .nullable() .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization.\n *Note: This attribute is populated only for invoices created on or after June 29, 2023.*' ) @@ -7160,13 +6742,13 @@ export namespace stripe { > export const InvoiceItemThresholdReasonSchema = z.object({ - /** The IDs of the line items that triggered the threshold invoice. */ + /**The IDs of the line items that triggered the threshold invoice.*/ line_item_ids: z .array(z.string().max(5000)) .describe( 'The IDs of the line items that triggered the threshold invoice.' ), - /** The quantity threshold boundary that applied to the given line item. */ + /**The quantity threshold boundary that applied to the given line item.*/ usage_gte: z .number() .int() @@ -7179,38 +6761,34 @@ export namespace stripe { > export const PaymentIntentNextActionAlipayHandleRedirectSchema = z.object({ - /** The native data to be used with Alipay SDK you must redirect your customer to in order to authenticate the payment in an Android App. */ + /**The native data to be used with Alipay SDK you must redirect your customer to in order to authenticate the payment in an Android App.*/ native_data: z .string() .max(5000) - .nullable() .describe( 'The native data to be used with Alipay SDK you must redirect your customer to in order to authenticate the payment in an Android App.' ) .optional(), - /** The native URL you must redirect your customer to in order to authenticate the payment in an iOS App. */ + /**The native URL you must redirect your customer to in order to authenticate the payment in an iOS App.*/ native_url: z .string() .max(5000) - .nullable() .describe( 'The native URL you must redirect your customer to in order to authenticate the payment in an iOS App.' ) .optional(), - /** If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. */ + /**If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.*/ return_url: z .string() .max(5000) - .nullable() .describe( 'If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.' ) .optional(), - /** The URL you must redirect your customer to in order to authenticate the payment. */ + /**The URL you must redirect your customer to in order to authenticate the payment.*/ url: z .string() .max(5000) - .nullable() .describe( 'The URL you must redirect your customer to in order to authenticate the payment.' ) @@ -7221,34 +6799,26 @@ export namespace stripe { > export const PaymentIntentNextActionBoletoSchema = z.object({ - /** The timestamp after which the boleto expires. */ + /**The timestamp after which the boleto expires.*/ expires_at: z .number() .int() - .nullable() .describe('The timestamp after which the boleto expires.') .optional(), - /** The URL to the hosted boleto voucher page, which allows customers to view the boleto voucher. */ + /**The URL to the hosted boleto voucher page, which allows customers to view the boleto voucher.*/ hosted_voucher_url: z .string() .max(5000) - .nullable() .describe( 'The URL to the hosted boleto voucher page, which allows customers to view the boleto voucher.' ) .optional(), - /** The boleto number. */ - number: z - .string() - .max(5000) - .nullable() - .describe('The boleto number.') - .optional(), - /** The URL to the downloadable boleto voucher PDF. */ + /**The boleto number.*/ + number: z.string().max(5000).describe('The boleto number.').optional(), + /**The URL to the downloadable boleto voucher PDF.*/ pdf: z .string() .max(5000) - .nullable() .describe('The URL to the downloadable boleto voucher PDF.') .optional() }) @@ -7257,19 +6827,17 @@ export namespace stripe { > export const PaymentIntentNextActionCardAwaitNotificationSchema = z.object({ - /** The time that payment will be attempted. If customer approval is required, they need to provide approval before this time. */ + /**The time that payment will be attempted. If customer approval is required, they need to provide approval before this time.*/ charge_attempt_at: z .number() .int() - .nullable() .describe( 'The time that payment will be attempted. If customer approval is required, they need to provide approval before this time.' ) .optional(), - /** For payments greater than INR 15000, the customer must provide explicit approval of the payment with their bank. For payments of lower amount, no customer action is required. */ + /**For payments greater than INR 15000, the customer must provide explicit approval of the payment with their bank. For payments of lower amount, no customer action is required.*/ customer_approval_required: z .boolean() - .nullable() .describe( 'For payments greater than INR 15000, the customer must provide explicit approval of the payment with their bank. For payments of lower amount, no customer action is required.' ) @@ -7280,13 +6848,13 @@ export namespace stripe { > export const PaymentIntentNextActionKonbiniFamilymartSchema = z.object({ - /** The confirmation number. */ + /**The confirmation number.*/ confirmation_number: z .string() .max(5000) .describe('The confirmation number.') .optional(), - /** The payment code. */ + /**The payment code.*/ payment_code: z.string().max(5000).describe('The payment code.') }) export type PaymentIntentNextActionKonbiniFamilymart = z.infer< @@ -7294,13 +6862,13 @@ export namespace stripe { > export const PaymentIntentNextActionKonbiniLawsonSchema = z.object({ - /** The confirmation number. */ + /**The confirmation number.*/ confirmation_number: z .string() .max(5000) .describe('The confirmation number.') .optional(), - /** The payment code. */ + /**The payment code.*/ payment_code: z.string().max(5000).describe('The payment code.') }) export type PaymentIntentNextActionKonbiniLawson = z.infer< @@ -7308,13 +6876,13 @@ export namespace stripe { > export const PaymentIntentNextActionKonbiniMinistopSchema = z.object({ - /** The confirmation number. */ + /**The confirmation number.*/ confirmation_number: z .string() .max(5000) .describe('The confirmation number.') .optional(), - /** The payment code. */ + /**The payment code.*/ payment_code: z.string().max(5000).describe('The payment code.') }) export type PaymentIntentNextActionKonbiniMinistop = z.infer< @@ -7322,13 +6890,13 @@ export namespace stripe { > export const PaymentIntentNextActionKonbiniSeicomartSchema = z.object({ - /** The confirmation number. */ + /**The confirmation number.*/ confirmation_number: z .string() .max(5000) .describe('The confirmation number.') .optional(), - /** The payment code. */ + /**The payment code.*/ payment_code: z.string().max(5000).describe('The payment code.') }) export type PaymentIntentNextActionKonbiniSeicomart = z.infer< @@ -7337,34 +6905,30 @@ export namespace stripe { export const PaymentIntentNextActionDisplayMultibancoDetailsSchema = z.object( { - /** Entity number associated with this Multibanco payment. */ + /**Entity number associated with this Multibanco payment.*/ entity: z .string() .max(5000) - .nullable() .describe('Entity number associated with this Multibanco payment.') .optional(), - /** The timestamp at which the Multibanco voucher expires. */ + /**The timestamp at which the Multibanco voucher expires.*/ expires_at: z .number() .int() - .nullable() .describe('The timestamp at which the Multibanco voucher expires.') .optional(), - /** The URL for the hosted Multibanco voucher page, which allows customers to view a Multibanco voucher. */ + /**The URL for the hosted Multibanco voucher page, which allows customers to view a Multibanco voucher.*/ hosted_voucher_url: z .string() .max(5000) - .nullable() .describe( 'The URL for the hosted Multibanco voucher page, which allows customers to view a Multibanco voucher.' ) .optional(), - /** Reference number associated with this Multibanco payment. */ + /**Reference number associated with this Multibanco payment.*/ reference: z .string() .max(5000) - .nullable() .describe('Reference number associated with this Multibanco payment.') .optional() } @@ -7374,57 +6938,49 @@ export namespace stripe { > export const PaymentIntentNextActionDisplayOxxoDetailsSchema = z.object({ - /** The timestamp after which the OXXO voucher expires. */ + /**The timestamp after which the OXXO voucher expires.*/ expires_after: z .number() .int() - .nullable() .describe('The timestamp after which the OXXO voucher expires.') .optional(), - /** The URL for the hosted OXXO voucher page, which allows customers to view and print an OXXO voucher. */ + /**The URL for the hosted OXXO voucher page, which allows customers to view and print an OXXO voucher.*/ hosted_voucher_url: z .string() .max(5000) - .nullable() .describe( 'The URL for the hosted OXXO voucher page, which allows customers to view and print an OXXO voucher.' ) .optional(), - /** OXXO reference number. */ - number: z - .string() - .max(5000) - .nullable() - .describe('OXXO reference number.') - .optional() + /**OXXO reference number.*/ + number: z.string().max(5000).describe('OXXO reference number.').optional() }) export type PaymentIntentNextActionDisplayOxxoDetails = z.infer< typeof PaymentIntentNextActionDisplayOxxoDetailsSchema > export const PaymentIntentNextActionPaynowDisplayQrCodeSchema = z.object({ - /** The raw data string used to generate QR code, it should be used together with QR code library. */ + /**The raw data string used to generate QR code, it should be used together with QR code library.*/ data: z .string() .max(5000) .describe( 'The raw data string used to generate QR code, it should be used together with QR code library.' ), - /** The URL to the hosted PayNow instructions page, which allows customers to view the PayNow QR code. */ + /**The URL to the hosted PayNow instructions page, which allows customers to view the PayNow QR code.*/ hosted_instructions_url: z .string() .max(5000) - .nullable() .describe( 'The URL to the hosted PayNow instructions page, which allows customers to view the PayNow QR code.' ) .optional(), - /** The image_url_png string used to render QR code */ + /**The image_url_png string used to render QR code*/ image_url_png: z .string() .max(5000) .describe('The image_url_png string used to render QR code'), - /** The image_url_svg string used to render QR code */ + /**The image_url_svg string used to render QR code*/ image_url_svg: z .string() .max(5000) @@ -7435,7 +6991,7 @@ export namespace stripe { > export const PaymentIntentNextActionPixDisplayQrCodeSchema = z.object({ - /** The raw data string used to generate QR code, it should be used together with QR code library. */ + /**The raw data string used to generate QR code, it should be used together with QR code library.*/ data: z .string() .max(5000) @@ -7443,13 +6999,13 @@ export namespace stripe { 'The raw data string used to generate QR code, it should be used together with QR code library.' ) .optional(), - /** The date (unix timestamp) when the PIX expires. */ + /**The date (unix timestamp) when the PIX expires.*/ expires_at: z .number() .int() .describe('The date (unix timestamp) when the PIX expires.') .optional(), - /** The URL to the hosted pix instructions page, which allows customers to view the pix QR code. */ + /**The URL to the hosted pix instructions page, which allows customers to view the pix QR code.*/ hosted_instructions_url: z .string() .max(5000) @@ -7457,13 +7013,13 @@ export namespace stripe { 'The URL to the hosted pix instructions page, which allows customers to view the pix QR code.' ) .optional(), - /** The image_url_png string used to render png QR code */ + /**The image_url_png string used to render png QR code*/ image_url_png: z .string() .max(5000) .describe('The image_url_png string used to render png QR code') .optional(), - /** The image_url_svg string used to render svg QR code */ + /**The image_url_svg string used to render svg QR code*/ image_url_svg: z .string() .max(5000) @@ -7475,28 +7031,28 @@ export namespace stripe { > export const PaymentIntentNextActionPromptpayDisplayQrCodeSchema = z.object({ - /** The raw data string used to generate QR code, it should be used together with QR code library. */ + /**The raw data string used to generate QR code, it should be used together with QR code library.*/ data: z .string() .max(5000) .describe( 'The raw data string used to generate QR code, it should be used together with QR code library.' ), - /** The URL to the hosted PromptPay instructions page, which allows customers to view the PromptPay QR code. */ + /**The URL to the hosted PromptPay instructions page, which allows customers to view the PromptPay QR code.*/ hosted_instructions_url: z .string() .max(5000) .describe( 'The URL to the hosted PromptPay instructions page, which allows customers to view the PromptPay QR code.' ), - /** The PNG path used to render the QR code, can be used as the source in an HTML img tag */ + /**The PNG path used to render the QR code, can be used as the source in an HTML img tag*/ image_url_png: z .string() .max(5000) .describe( 'The PNG path used to render the QR code, can be used as the source in an HTML img tag' ), - /** The SVG path used to render the QR code, can be used as the source in an HTML img tag */ + /**The SVG path used to render the QR code, can be used as the source in an HTML img tag*/ image_url_svg: z .string() .max(5000) @@ -7509,20 +7065,18 @@ export namespace stripe { > export const PaymentIntentNextActionRedirectToUrlSchema = z.object({ - /** If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. */ + /**If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.*/ return_url: z .string() .max(5000) - .nullable() .describe( 'If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.' ) .optional(), - /** The URL you must redirect your customer to in order to authenticate the payment. */ + /**The URL you must redirect your customer to in order to authenticate the payment.*/ url: z .string() .max(5000) - .nullable() .describe( 'The URL you must redirect your customer to in order to authenticate the payment.' ) @@ -7533,19 +7087,19 @@ export namespace stripe { > export const PaymentIntentNextActionSwishQrCodeSchema = z.object({ - /** The raw data string used to generate QR code, it should be used together with QR code library. */ + /**The raw data string used to generate QR code, it should be used together with QR code library.*/ data: z .string() .max(5000) .describe( 'The raw data string used to generate QR code, it should be used together with QR code library.' ), - /** The image_url_png string used to render QR code */ + /**The image_url_png string used to render QR code*/ image_url_png: z .string() .max(5000) .describe('The image_url_png string used to render QR code'), - /** The image_url_svg string used to render QR code */ + /**The image_url_svg string used to render QR code*/ image_url_svg: z .string() .max(5000) @@ -7556,22 +7110,21 @@ export namespace stripe { > export const PaymentIntentNextActionVerifyWithMicrodepositsSchema = z.object({ - /** The timestamp when the microdeposits are expected to land. */ + /**The timestamp when the microdeposits are expected to land.*/ arrival_date: z .number() .int() .describe('The timestamp when the microdeposits are expected to land.'), - /** The URL for the hosted verification page, which allows customers to verify their bank account. */ + /**The URL for the hosted verification page, which allows customers to verify their bank account.*/ hosted_verification_url: z .string() .max(5000) .describe( 'The URL for the hosted verification page, which allows customers to verify their bank account.' ), - /** The type of the microdeposit sent to the customer. Used to distinguish between different verification methods. */ + /**The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.*/ microdeposit_type: z .enum(['amounts', 'descriptor_code']) - .nullable() .describe( 'The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.' ) @@ -7582,29 +7135,29 @@ export namespace stripe { > export const PaymentIntentNextActionWechatPayDisplayQrCodeSchema = z.object({ - /** The data being used to generate QR code */ + /**The data being used to generate QR code*/ data: z .string() .max(5000) .describe('The data being used to generate QR code'), - /** The URL to the hosted WeChat Pay instructions page, which allows customers to view the WeChat Pay QR code. */ + /**The URL to the hosted WeChat Pay instructions page, which allows customers to view the WeChat Pay QR code.*/ hosted_instructions_url: z .string() .max(5000) .describe( 'The URL to the hosted WeChat Pay instructions page, which allows customers to view the WeChat Pay QR code.' ), - /** The base64 image data for a pre-generated QR code */ + /**The base64 image data for a pre-generated QR code*/ image_data_url: z .string() .max(5000) .describe('The base64 image data for a pre-generated QR code'), - /** The image_url_png string used to render QR code */ + /**The image_url_png string used to render QR code*/ image_url_png: z .string() .max(5000) .describe('The image_url_png string used to render QR code'), - /** The image_url_svg string used to render QR code */ + /**The image_url_svg string used to render QR code*/ image_url_svg: z .string() .max(5000) @@ -7616,28 +7169,28 @@ export namespace stripe { export const PaymentIntentNextActionWechatPayRedirectToAndroidAppSchema = z.object({ - /** app_id is the APP ID registered on WeChat open platform */ + /**app_id is the APP ID registered on WeChat open platform*/ app_id: z .string() .max(5000) .describe('app_id is the APP ID registered on WeChat open platform'), - /** nonce_str is a random string */ + /**nonce_str is a random string*/ nonce_str: z.string().max(5000).describe('nonce_str is a random string'), - /** package is static value */ + /**package is static value*/ package: z.string().max(5000).describe('package is static value'), - /** an unique merchant ID assigned by WeChat Pay */ + /**an unique merchant ID assigned by WeChat Pay*/ partner_id: z .string() .max(5000) .describe('an unique merchant ID assigned by WeChat Pay'), - /** an unique trading ID assigned by WeChat Pay */ + /**an unique trading ID assigned by WeChat Pay*/ prepay_id: z .string() .max(5000) .describe('an unique trading ID assigned by WeChat Pay'), - /** A signature */ + /**A signature*/ sign: z.string().max(5000).describe('A signature'), - /** Specifies the current time in epoch format */ + /**Specifies the current time in epoch format*/ timestamp: z .string() .max(5000) @@ -7649,7 +7202,7 @@ export namespace stripe { export const PaymentIntentNextActionWechatPayRedirectToIosAppSchema = z.object({ - /** An universal link that redirect to WeChat Pay app */ + /**An universal link that redirect to WeChat Pay app*/ native_url: z .string() .max(5000) @@ -7661,31 +7214,28 @@ export namespace stripe { export const PaymentIntentPaymentMethodOptionsMandateOptionsAcssDebitSchema = z.object({ - /** A URL for custom mandate text */ + /**A URL for custom mandate text*/ custom_mandate_url: z .string() .max(5000) .describe('A URL for custom mandate text') .optional(), - /** Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. */ + /**Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.*/ interval_description: z .string() .max(5000) - .nullable() .describe( "Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'." ) .optional(), - /** Payment schedule for the mandate. */ + /**Payment schedule for the mandate.*/ payment_schedule: z .enum(['combined', 'interval', 'sporadic']) - .nullable() .describe('Payment schedule for the mandate.') .optional(), - /** Transaction type of the mandate. */ + /**Transaction type of the mandate.*/ transaction_type: z .enum(['business', 'personal']) - .nullable() .describe('Transaction type of the mandate.') .optional() }) @@ -7695,10 +7245,9 @@ export namespace stripe { > export const PaymentMethodOptionsCardPresentRoutingSchema = z.object({ - /** Requested routing priority */ + /**Requested routing priority*/ requested_priority: z .enum(['domestic', 'international']) - .nullable() .describe('Requested routing priority') .optional() }) @@ -7707,14 +7256,14 @@ export namespace stripe { > export const PaymentMethodOptionsAffirmSchema = z.object({ - /** Controls when the funds will be captured from the customer's account. */ + /**Controls when the funds will be captured from the customer's account.*/ capture_method: z .literal('manual') .describe( "Controls when the funds will be captured from the customer's account." ) .optional(), - /** Preferred language of the Affirm authorization page that the customer is redirected to. */ + /**Preferred language of the Affirm authorization page that the customer is redirected to.*/ preferred_locale: z .string() .max(30) @@ -7743,7 +7292,7 @@ export namespace stripe { > export const PaymentMethodOptionsAfterpayClearpaySchema = z.object({ - /** Controls when the funds will be captured from the customer's account. */ + /**Controls when the funds will be captured from the customer's account.*/ capture_method: z .literal('manual') .describe( @@ -7757,7 +7306,6 @@ export namespace stripe { reference: z .string() .max(5000) - .nullable() .describe( 'An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes.\nThis field differs from the statement descriptor and item name.' ) @@ -7804,7 +7352,7 @@ export namespace stripe { > export const PaymentMethodOptionsAlmaSchema = z.object({ - /** Controls when the funds will be captured from the customer's account. */ + /**Controls when the funds will be captured from the customer's account.*/ capture_method: z .literal('manual') .describe( @@ -7817,7 +7365,7 @@ export namespace stripe { > export const PaymentMethodOptionsAmazonPaySchema = z.object({ - /** Controls when the funds will be captured from the customer's account. */ + /**Controls when the funds will be captured from the customer's account.*/ capture_method: z .literal('manual') .describe( @@ -7860,7 +7408,7 @@ export namespace stripe { "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)." ) .optional(), - /** Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now. */ + /**Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.*/ target_date: z .string() .max(5000) @@ -7875,7 +7423,7 @@ export namespace stripe { export const PaymentIntentPaymentMethodOptionsMandateOptionsBacsDebitSchema = z.object({ - /** Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'. */ + /**Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.*/ reference_prefix: z .string() .max(5000) @@ -7890,7 +7438,7 @@ export namespace stripe { > export const PaymentMethodOptionsBancontactSchema = z.object({ - /** Preferred language of the Bancontact authorization page that the customer is redirected to. */ + /**Preferred language of the Bancontact authorization page that the customer is redirected to.*/ preferred_language: z .enum(['de', 'en', 'fr', 'nl']) .describe( @@ -7938,7 +7486,7 @@ export namespace stripe { > export const PaymentMethodOptionsBoletoSchema = z.object({ - /** The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time. */ + /**The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time.*/ expires_after_days: z .number() .int() @@ -7966,66 +7514,62 @@ export namespace stripe { > export const PaymentMethodOptionsCardMandateOptionsSchema = z.object({ - /** Amount to be charged for future payments. */ + /**Amount to be charged for future payments.*/ amount: z .number() .int() .describe('Amount to be charged for future payments.'), - /** One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param. */ + /**One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.*/ amount_type: z .enum(['fixed', 'maximum']) .describe( 'One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.' ), - /** A description of the mandate or subscription that is meant to be displayed to the customer. */ + /**A description of the mandate or subscription that is meant to be displayed to the customer.*/ description: z .string() .max(200) - .nullable() .describe( 'A description of the mandate or subscription that is meant to be displayed to the customer.' ) .optional(), - /** End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date. */ + /**End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.*/ end_date: z .number() .int() - .nullable() .describe( 'End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.' ) .optional(), - /** Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`. */ + /**Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.*/ interval: z .enum(['day', 'month', 'sporadic', 'week', 'year']) .describe( 'Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`.' ), - /** The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`. */ + /**The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.*/ interval_count: z .number() .int() - .nullable() .describe( 'The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`.' ) .optional(), - /** Unique identifier for the mandate or subscription. */ + /**Unique identifier for the mandate or subscription.*/ reference: z .string() .max(80) .describe('Unique identifier for the mandate or subscription.'), - /** Start date of the mandate or subscription. Start date should not be lesser than yesterday. */ + /**Start date of the mandate or subscription. Start date should not be lesser than yesterday.*/ start_date: z .number() .int() .describe( 'Start date of the mandate or subscription. Start date should not be lesser than yesterday.' ), - /** Specifies the type of mandates supported. Possible values are `india`. */ + /**Specifies the type of mandates supported. Possible values are `india`.*/ supported_types: z .array(z.literal('india')) - .nullable() .describe( 'Specifies the type of mandates supported. Possible values are `india`.' ) @@ -8036,7 +7580,7 @@ export namespace stripe { > export const PaymentMethodOptionsCashappSchema = z.object({ - /** Controls when the funds will be captured from the customer's account. */ + /**Controls when the funds will be captured from the customer's account.*/ capture_method: z .literal('manual') .describe( @@ -8065,7 +7609,7 @@ export namespace stripe { export const PaymentMethodOptionsCustomerBalanceEuBankAccountSchema = z.object({ - /** The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. */ + /**The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.*/ country: z .enum(['BE', 'DE', 'ES', 'FR', 'IE', 'NL']) .describe( @@ -8188,7 +7732,7 @@ export namespace stripe { export const PaymentFlowsPrivatePaymentMethodsKakaoPayPaymentMethodOptionsSchema = z.object({ - /** Controls when the funds will be captured from the customer's account. */ + /**Controls when the funds will be captured from the customer's account.*/ capture_method: z .literal('manual') .describe( @@ -8217,18 +7761,17 @@ export namespace stripe { > export const PaymentMethodOptionsKlarnaSchema = z.object({ - /** Controls when the funds will be captured from the customer's account. */ + /**Controls when the funds will be captured from the customer's account.*/ capture_method: z .literal('manual') .describe( "Controls when the funds will be captured from the customer's account." ) .optional(), - /** Preferred locale of the Klarna checkout page that the customer is redirected to. */ + /**Preferred locale of the Klarna checkout page that the customer is redirected to.*/ preferred_locale: z .string() .max(5000) - .nullable() .describe( 'Preferred locale of the Klarna checkout page that the customer is redirected to.' ) @@ -8254,38 +7797,34 @@ export namespace stripe { > export const PaymentMethodOptionsKonbiniSchema = z.object({ - /** An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores. */ + /**An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores.*/ confirmation_number: z .string() .max(5000) - .nullable() .describe( 'An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores.' ) .optional(), - /** The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. */ + /**The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST.*/ expires_after_days: z .number() .int() - .nullable() .describe( 'The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST.' ) .optional(), - /** The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set. */ + /**The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set.*/ expires_at: z .number() .int() - .nullable() .describe( 'The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set.' ) .optional(), - /** A product descriptor of up to 22 characters, which will appear to customers at the convenience store. */ + /**A product descriptor of up to 22 characters, which will appear to customers at the convenience store.*/ product_description: z .string() .max(5000) - .nullable() .describe( 'A product descriptor of up to 22 characters, which will appear to customers at the convenience store.' ) @@ -8311,7 +7850,7 @@ export namespace stripe { > export const PaymentMethodOptionsKrCardSchema = z.object({ - /** Controls when the funds will be captured from the customer's account. */ + /**Controls when the funds will be captured from the customer's account.*/ capture_method: z .literal('manual') .describe( @@ -8339,7 +7878,7 @@ export namespace stripe { > export const PaymentIntentPaymentMethodOptionsLinkSchema = z.object({ - /** Controls when the funds will be captured from the customer's account. */ + /**Controls when the funds will be captured from the customer's account.*/ capture_method: z .literal('manual') .describe( @@ -8367,7 +7906,7 @@ export namespace stripe { > export const PaymentIntentPaymentMethodOptionsMobilepaySchema = z.object({ - /** Controls when the funds will be captured from the customer's account. */ + /**Controls when the funds will be captured from the customer's account.*/ capture_method: z .literal('manual') .describe( @@ -8417,7 +7956,7 @@ export namespace stripe { export const PaymentFlowsPrivatePaymentMethodsNaverPayPaymentMethodOptionsSchema = z.object({ - /** Controls when the funds will be captured from the customer's account. */ + /**Controls when the funds will be captured from the customer's account.*/ capture_method: z .literal('manual') .describe( @@ -8431,7 +7970,7 @@ export namespace stripe { > export const PaymentMethodOptionsOxxoSchema = z.object({ - /** The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time. */ + /**The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.*/ expires_after_days: z .number() .int() @@ -8486,7 +8025,7 @@ export namespace stripe { export const PaymentFlowsPrivatePaymentMethodsPaycoPaymentMethodOptionsSchema = z.object({ - /** Controls when the funds will be captured from the customer's account. */ + /**Controls when the funds will be captured from the customer's account.*/ capture_method: z .literal('manual') .describe( @@ -8521,27 +8060,25 @@ export namespace stripe { > export const PaymentMethodOptionsPaypalSchema = z.object({ - /** Controls when the funds will be captured from the customer's account. */ + /**Controls when the funds will be captured from the customer's account.*/ capture_method: z .literal('manual') .describe( "Controls when the funds will be captured from the customer's account." ) .optional(), - /** Preferred locale of the PayPal checkout page that the customer is redirected to. */ + /**Preferred locale of the PayPal checkout page that the customer is redirected to.*/ preferred_locale: z .string() .max(5000) - .nullable() .describe( 'Preferred locale of the PayPal checkout page that the customer is redirected to.' ) .optional(), - /** A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID. */ + /**A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.*/ reference: z .string() .max(5000) - .nullable() .describe( "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID." ) @@ -8567,20 +8104,18 @@ export namespace stripe { > export const PaymentMethodOptionsPixSchema = z.object({ - /** The number of seconds (between 10 and 1209600) after which Pix payment will expire. */ + /**The number of seconds (between 10 and 1209600) after which Pix payment will expire.*/ expires_after_seconds: z .number() .int() - .nullable() .describe( 'The number of seconds (between 10 and 1209600) after which Pix payment will expire.' ) .optional(), - /** The timestamp at which the Pix expires. */ + /**The timestamp at which the Pix expires.*/ expires_at: z .number() .int() - .nullable() .describe('The timestamp at which the Pix expires.') .optional(), /** @@ -8625,7 +8160,7 @@ export namespace stripe { > export const PaymentMethodOptionsRevolutPaySchema = z.object({ - /** Controls when the funds will be captured from the customer's account. */ + /**Controls when the funds will be captured from the customer's account.*/ capture_method: z .literal('manual') .describe( @@ -8654,7 +8189,7 @@ export namespace stripe { export const PaymentFlowsPrivatePaymentMethodsSamsungPayPaymentMethodOptionsSchema = z.object({ - /** Controls when the funds will be captured from the customer's account. */ + /**Controls when the funds will be captured from the customer's account.*/ capture_method: z .literal('manual') .describe( @@ -8669,7 +8204,7 @@ export namespace stripe { export const PaymentIntentPaymentMethodOptionsMandateOptionsSepaDebitSchema = z.object({ - /** Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'. */ + /**Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.*/ reference_prefix: z .string() .max(5000) @@ -8684,10 +8219,9 @@ export namespace stripe { > export const PaymentMethodOptionsSofortSchema = z.object({ - /** Preferred language of the SOFORT authorization page that the customer is redirected to. */ + /**Preferred language of the SOFORT authorization page that the customer is redirected to.*/ preferred_language: z .enum(['de', 'en', 'es', 'fr', 'it', 'nl', 'pl']) - .nullable() .describe( 'Preferred language of the SOFORT authorization page that the customer is redirected to.' ) @@ -8713,11 +8247,10 @@ export namespace stripe { > export const PaymentIntentPaymentMethodOptionsSwishSchema = z.object({ - /** A reference for this payment to be displayed in the Swish app. */ + /**A reference for this payment to be displayed in the Swish app.*/ reference: z .string() .max(35) - .nullable() .describe( 'A reference for this payment to be displayed in the Swish app.' ) @@ -8764,19 +8297,17 @@ export namespace stripe { > export const PaymentMethodOptionsWechatPaySchema = z.object({ - /** The app ID registered with WeChat Pay. Only required when client is ios or android. */ + /**The app ID registered with WeChat Pay. Only required when client is ios or android.*/ app_id: z .string() .max(5000) - .nullable() .describe( 'The app ID registered with WeChat Pay. Only required when client is ios or android.' ) .optional(), - /** The client type that the end customer will pay from */ + /**The client type that the end customer will pay from*/ client: z .enum(['android', 'ios', 'web']) - .nullable() .describe('The client type that the end customer will pay from') .optional(), /** @@ -8821,19 +8352,17 @@ export namespace stripe { > export const PaymentIntentProcessingCustomerNotificationSchema = z.object({ - /** Whether customer approval has been requested for this payment. For payments greater than INR 15000 or mandate amount, the customer must provide explicit approval of the payment with their bank. */ + /**Whether customer approval has been requested for this payment. For payments greater than INR 15000 or mandate amount, the customer must provide explicit approval of the payment with their bank.*/ approval_requested: z .boolean() - .nullable() .describe( 'Whether customer approval has been requested for this payment. For payments greater than INR 15000 or mandate amount, the customer must provide explicit approval of the payment with their bank.' ) .optional(), - /** If customer approval is required, they need to provide approval before this time. */ + /**If customer approval is required, they need to provide approval before this time.*/ completes_at: z .number() .int() - .nullable() .describe( 'If customer approval is required, they need to provide approval before this time.' ) @@ -8844,17 +8373,16 @@ export namespace stripe { > export const NetworksSchema = z.object({ - /** All networks available for selection via [payment_method_options.card.network](/api/payment_intents/confirm#confirm_payment_intent-payment_method_options-card-network). */ + /**All networks available for selection via [payment_method_options.card.network](/api/payment_intents/confirm#confirm_payment_intent-payment_method_options-card-network).*/ available: z .array(z.string().max(5000)) .describe( 'All networks available for selection via [payment_method_options.card.network](/api/payment_intents/confirm#confirm_payment_intent-payment_method_options-card-network).' ), - /** The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card. */ + /**The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card.*/ preferred: z .string() .max(5000) - .nullable() .describe( 'The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card.' ) @@ -8863,7 +8391,7 @@ export namespace stripe { export type Networks = z.infer export const ThreeDSecureUsageSchema = z.object({ - /** Whether 3D Secure is supported on this card. */ + /**Whether 3D Secure is supported on this card.*/ supported: z .boolean() .describe('Whether 3D Secure is supported on this card.') @@ -8896,17 +8424,16 @@ export namespace stripe { > export const PaymentMethodCardPresentNetworksSchema = z.object({ - /** All networks available for selection via [payment_method_options.card.network](/api/payment_intents/confirm#confirm_payment_intent-payment_method_options-card-network). */ + /**All networks available for selection via [payment_method_options.card.network](/api/payment_intents/confirm#confirm_payment_intent-payment_method_options-card-network).*/ available: z .array(z.string().max(5000)) .describe( 'All networks available for selection via [payment_method_options.card.network](/api/payment_intents/confirm#confirm_payment_intent-payment_method_options-card-network).' ), - /** The preferred network for the card. */ + /**The preferred network for the card.*/ preferred: z .string() .max(5000) - .nullable() .describe('The preferred network for the card.') .optional() }) @@ -8915,20 +8442,18 @@ export namespace stripe { > export const PaymentMethodCashappSchema = z.object({ - /** A unique and immutable identifier assigned by Cash App to every buyer. */ + /**A unique and immutable identifier assigned by Cash App to every buyer.*/ buyer_id: z .string() .max(5000) - .nullable() .describe( 'A unique and immutable identifier assigned by Cash App to every buyer.' ) .optional(), - /** A public identifier for buyers using Cash App. */ + /**A public identifier for buyers using Cash App.*/ cashtag: z .string() .max(5000) - .nullable() .describe('A public identifier for buyers using Cash App.') .optional() }) @@ -8940,7 +8465,7 @@ export namespace stripe { > export const PaymentMethodEpsSchema = z.object({ - /** The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`. */ + /**The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`.*/ bank: z .enum([ 'arzte_und_apotheker_bank', @@ -8972,7 +8497,6 @@ export namespace stripe { 'volkskreditbank_ag', 'vr_bank_braunau' ]) - .nullable() .describe( "The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`." ) @@ -8981,7 +8505,7 @@ export namespace stripe { export type PaymentMethodEps = z.infer export const PaymentMethodFpxSchema = z.object({ - /** The customer's bank, if provided. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`. */ + /**The customer's bank, if provided. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`.*/ bank: z .enum([ 'affin_bank', @@ -9020,7 +8544,7 @@ export namespace stripe { export type PaymentMethodGrabpay = z.infer export const PaymentMethodIdealSchema = z.object({ - /** The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. */ + /**The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.*/ bank: z .enum([ 'abn_amro', @@ -9040,12 +8564,11 @@ export namespace stripe { 'van_lanschot', 'yoursafe' ]) - .nullable() .describe( "The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`." ) .optional(), - /** The Bank Identifier Code of the customer's bank, if the bank was provided. */ + /**The Bank Identifier Code of the customer's bank, if the bank was provided.*/ bic: z .enum([ 'ABNANL2A', @@ -9066,7 +8589,6 @@ export namespace stripe { 'SNSBNL2A', 'TRIONL2U' ]) - .nullable() .describe( "The Bank Identifier Code of the customer's bank, if the bank was provided." ) @@ -9080,27 +8602,20 @@ export namespace stripe { > export const PaymentFlowsPrivatePaymentMethodsKlarnaDobSchema = z.object({ - /** The day of birth, between 1 and 31. */ + /**The day of birth, between 1 and 31.*/ day: z .number() .int() - .nullable() .describe('The day of birth, between 1 and 31.') .optional(), - /** The month of birth, between 1 and 12. */ + /**The month of birth, between 1 and 12.*/ month: z .number() .int() - .nullable() .describe('The month of birth, between 1 and 12.') .optional(), - /** The four-digit year of birth. */ - year: z - .number() - .int() - .nullable() - .describe('The four-digit year of birth.') - .optional() + /**The four-digit year of birth.*/ + year: z.number().int().describe('The four-digit year of birth.').optional() }) export type PaymentFlowsPrivatePaymentMethodsKlarnaDob = z.infer< typeof PaymentFlowsPrivatePaymentMethodsKlarnaDobSchema @@ -9110,7 +8625,7 @@ export namespace stripe { export type PaymentMethodKonbini = z.infer export const PaymentMethodKrCardSchema = z.object({ - /** The local credit or debit card brand. */ + /**The local credit or debit card brand.*/ brand: z .enum([ 'bc', @@ -9136,14 +8651,12 @@ export namespace stripe { 'tossbank', 'woori' ]) - .nullable() .describe('The local credit or debit card brand.') .optional(), - /** The last four digits of the card. This may not be present for American Express cards. */ + /**The last four digits of the card. This may not be present for American Express cards.*/ last4: z .string() .max(4) - .nullable() .describe( 'The last four digits of the card. This may not be present for American Express cards.' ) @@ -9152,11 +8665,10 @@ export namespace stripe { export type PaymentMethodKrCard = z.infer export const PaymentMethodLinkSchema = z.object({ - /** Account owner's email address. */ + /**Account owner's email address.*/ email: z .string() .max(5000) - .nullable() .describe("Account owner's email address.") .optional() }) @@ -9173,7 +8685,7 @@ export namespace stripe { > export const PaymentMethodNaverPaySchema = z.object({ - /** Whether to fund this transaction with Naver Pay points or a card. */ + /**Whether to fund this transaction with Naver Pay points or a card.*/ funding: z .enum(['card', 'points']) .describe( @@ -9188,7 +8700,7 @@ export namespace stripe { export type PaymentMethodOxxo = z.infer export const PaymentMethodP24Schema = z.object({ - /** The customer's bank, if provided. */ + /**The customer's bank, if provided.*/ bank: z .enum([ 'alior_bank', @@ -9218,7 +8730,6 @@ export namespace stripe { 'velobank', 'volkswagen_bank' ]) - .nullable() .describe("The customer's bank, if provided.") .optional() }) @@ -9236,11 +8747,10 @@ export namespace stripe { export type PaymentMethodPaynow = z.infer export const PaymentMethodPaypalSchema = z.object({ - /** Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /**Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.*/ country: z .string() .max(5000) - .nullable() .describe( "Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated." ) @@ -9252,16 +8762,14 @@ export namespace stripe { payer_email: z .string() .max(5000) - .nullable() .describe( "Owner's email. Values are provided by PayPal directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated." ) .optional(), - /** PayPal account PayerID. This identifier uniquely identifies the PayPal customer. */ + /**PayPal account PayerID. This identifier uniquely identifies the PayPal customer.*/ payer_id: z .string() .max(5000) - .nullable() .describe( 'PayPal account PayerID. This identifier uniquely identifies the PayPal customer.' ) @@ -9288,11 +8796,10 @@ export namespace stripe { > export const PaymentMethodSofortSchema = z.object({ - /** Two-letter ISO code representing the country the bank account is located in. */ + /**Two-letter ISO code representing the country the bank account is located in.*/ country: z .string() .max(5000) - .nullable() .describe( 'Two-letter ISO code representing the country the bank account is located in.' ) @@ -9307,14 +8814,13 @@ export namespace stripe { export type PaymentMethodTwint = z.infer export const UsBankAccountNetworksSchema = z.object({ - /** The preferred network. */ + /**The preferred network.*/ preferred: z .string() .max(5000) - .nullable() .describe('The preferred network.') .optional(), - /** All supported networks. */ + /**All supported networks.*/ supported: z .array(z.enum(['ach', 'us_domestic_wire'])) .describe('All supported networks.') @@ -9324,7 +8830,7 @@ export namespace stripe { > export const PaymentMethodUsBankAccountBlockedSchema = z.object({ - /** The ACH network code that resulted in this block. */ + /**The ACH network code that resulted in this block.*/ network_code: z .enum([ 'R02', @@ -9340,10 +8846,9 @@ export namespace stripe { 'R29', 'R31' ]) - .nullable() .describe('The ACH network code that resulted in this block.') .optional(), - /** The reason why this PaymentMethod's fingerprint has been blocked */ + /**The reason why this PaymentMethod's fingerprint has been blocked*/ reason: z .enum([ 'bank_account_closed', @@ -9353,7 +8858,6 @@ export namespace stripe { 'bank_account_unusable', 'debit_not_authorized' ]) - .nullable() .describe( "The reason why this PaymentMethod's fingerprint has been blocked" ) @@ -9372,20 +8876,18 @@ export namespace stripe { export type PaymentMethodZip = z.infer export const InvoiceSettingCustomerRenderingOptionsSchema = z.object({ - /** How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. */ + /**How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.*/ amount_tax_display: z .string() .max(5000) - .nullable() .describe( 'How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.' ) .optional(), - /** ID of the invoice rendering template to be used for this customer's invoices. If set, the template will be used on all invoices for this customer unless a template is set directly on the invoice. */ + /**ID of the invoice rendering template to be used for this customer's invoices. If set, the template will be used on all invoices for this customer unless a template is set directly on the invoice.*/ template: z .string() .max(5000) - .nullable() .describe( "ID of the invoice rendering template to be used for this customer's invoices. If set, the template will be used on all invoices for this customer unless a template is set directly on the invoice." ) @@ -9396,12 +8898,12 @@ export namespace stripe { > export const CustomerTaxLocationSchema = z.object({ - /** The customer's country as identified by Stripe Tax. */ + /**The customer's country as identified by Stripe Tax.*/ country: z .string() .max(5000) .describe("The customer's country as identified by Stripe Tax."), - /** The data source used to infer the customer's location. */ + /**The data source used to infer the customer's location.*/ source: z .enum([ 'billing_address', @@ -9410,11 +8912,10 @@ export namespace stripe { 'shipping_destination' ]) .describe("The data source used to infer the customer's location."), - /** The customer's state, county, province, or region as identified by Stripe Tax. */ + /**The customer's state, county, province, or region as identified by Stripe Tax.*/ state: z .string() .max(5000) - .nullable() .describe( "The customer's state, county, province, or region as identified by Stripe Tax." ) @@ -9423,7 +8924,7 @@ export namespace stripe { export type CustomerTaxLocation = z.infer export const AccountRequirementsErrorSchema = z.object({ - /** The code for the type of error. */ + /**The code for the type of error.*/ code: z .enum([ 'invalid_address_city_state_postal_code', @@ -9517,14 +9018,14 @@ export namespace stripe { 'verification_supportability' ]) .describe('The code for the type of error.'), - /** An informative message that indicates the error type and provides additional details about the error. */ + /**An informative message that indicates the error type and provides additional details about the error.*/ reason: z .string() .max(5000) .describe( 'An informative message that indicates the error type and provides additional details about the error.' ), - /** The specific user onboarding requirement field (in the requirements hash) that needs to be resolved. */ + /**The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.*/ requirement: z .string() .max(5000) @@ -9537,13 +9038,13 @@ export namespace stripe { > export const AccountRequirementsAlternativeSchema = z.object({ - /** Fields that can be provided to satisfy all fields in `original_fields_due`. */ + /**Fields that can be provided to satisfy all fields in `original_fields_due`.*/ alternative_fields_due: z .array(z.string().max(5000)) .describe( 'Fields that can be provided to satisfy all fields in `original_fields_due`.' ), - /** Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`. */ + /**Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.*/ original_fields_due: z .array(z.string().max(5000)) .describe( @@ -9555,11 +9056,10 @@ export namespace stripe { > export const AccountGroupMembershipSchema = z.object({ - /** The group the account is in to determine their payments pricing, and null if the account is on customized pricing. [See the Platform pricing tool documentation](https://stripe.com/docs/connect/platform-pricing-tools) for details. */ + /**The group the account is in to determine their payments pricing, and null if the account is on customized pricing. [See the Platform pricing tool documentation](https://stripe.com/docs/connect/platform-pricing-tools) for details.*/ payments_pricing: z .string() .max(5000) - .nullable() .describe( 'The group the account is in to determine their payments pricing, and null if the account is on customized pricing. [See the Platform pricing tool documentation](https://stripe.com/docs/connect/platform-pricing-tools) for details.' ) @@ -9570,29 +9070,26 @@ export namespace stripe { > export const PersonAdditionalTosAcceptanceSchema = z.object({ - /** The Unix timestamp marking when the legal guardian accepted the service agreement. */ + /**The Unix timestamp marking when the legal guardian accepted the service agreement.*/ date: z .number() .int() - .nullable() .describe( 'The Unix timestamp marking when the legal guardian accepted the service agreement.' ) .optional(), - /** The IP address from which the legal guardian accepted the service agreement. */ + /**The IP address from which the legal guardian accepted the service agreement.*/ ip: z .string() .max(5000) - .nullable() .describe( 'The IP address from which the legal guardian accepted the service agreement.' ) .optional(), - /** The user agent of the browser from which the legal guardian accepted the service agreement. */ + /**The user agent of the browser from which the legal guardian accepted the service agreement.*/ user_agent: z .string() .max(5000) - .nullable() .describe( 'The user agent of the browser from which the legal guardian accepted the service agreement.' ) @@ -9603,110 +9100,93 @@ export namespace stripe { > export const LegalEntityDobSchema = z.object({ - /** The day of birth, between 1 and 31. */ + /**The day of birth, between 1 and 31.*/ day: z .number() .int() - .nullable() .describe('The day of birth, between 1 and 31.') .optional(), - /** The month of birth, between 1 and 12. */ + /**The month of birth, between 1 and 12.*/ month: z .number() .int() - .nullable() .describe('The month of birth, between 1 and 12.') .optional(), - /** The four-digit year of birth. */ - year: z - .number() - .int() - .nullable() - .describe('The four-digit year of birth.') - .optional() + /**The four-digit year of birth.*/ + year: z.number().int().describe('The four-digit year of birth.').optional() }) export type LegalEntityDob = z.infer export const PersonRelationshipSchema = z.object({ - /** Whether the person is the authorizer of the account's representative. */ + /**Whether the person is the authorizer of the account's representative.*/ authorizer: z .boolean() - .nullable() .describe( "Whether the person is the authorizer of the account's representative." ) .optional(), - /** Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations. */ + /**Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations.*/ director: z .boolean() - .nullable() .describe( "Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations." ) .optional(), - /** Whether the person has significant responsibility to control, manage, or direct the organization. */ + /**Whether the person has significant responsibility to control, manage, or direct the organization.*/ executive: z .boolean() - .nullable() .describe( 'Whether the person has significant responsibility to control, manage, or direct the organization.' ) .optional(), - /** Whether the person is the legal guardian of the account's representative. */ + /**Whether the person is the legal guardian of the account's representative.*/ legal_guardian: z .boolean() - .nullable() .describe( "Whether the person is the legal guardian of the account's representative." ) .optional(), - /** Whether the person is an owner of the account’s legal entity. */ + /**Whether the person is an owner of the account’s legal entity.*/ owner: z .boolean() - .nullable() .describe('Whether the person is an owner of the account’s legal entity.') .optional(), - /** The percent owned by the person of the account's legal entity. */ + /**The percent owned by the person of the account's legal entity.*/ percent_ownership: z .number() - .nullable() .describe( "The percent owned by the person of the account's legal entity." ) .optional(), - /** Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account. */ + /**Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account.*/ representative: z .boolean() - .nullable() .describe( 'Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account.' ) .optional(), - /** The person's title (e.g., CEO, Support Engineer). */ + /**The person's title (e.g., CEO, Support Engineer).*/ title: z .string() .max(5000) - .nullable() .describe("The person's title (e.g., CEO, Support Engineer).") .optional() }) export type PersonRelationship = z.infer export const AccountBacsDebitPaymentsSettingsSchema = z.object({ - /** The Bacs Direct Debit display name for this account. For payments made with Bacs Direct Debit, this name appears on the mandate as the statement descriptor. Mobile banking apps display it as the name of the business. To use custom branding, set the Bacs Direct Debit Display Name during or right after creation. Custom branding incurs an additional monthly fee for the platform. The fee appears 5 business days after requesting Bacs. If you don't set the display name before requesting Bacs capability, it's automatically set as "Stripe" and the account is onboarded to Stripe branding, which is free. */ + /**The Bacs Direct Debit display name for this account. For payments made with Bacs Direct Debit, this name appears on the mandate as the statement descriptor. Mobile banking apps display it as the name of the business. To use custom branding, set the Bacs Direct Debit Display Name during or right after creation. Custom branding incurs an additional monthly fee for the platform. The fee appears 5 business days after requesting Bacs. If you don't set the display name before requesting Bacs capability, it's automatically set as "Stripe" and the account is onboarded to Stripe branding, which is free.*/ display_name: z .string() .max(5000) - .nullable() .describe( 'The Bacs Direct Debit display name for this account. For payments made with Bacs Direct Debit, this name appears on the mandate as the statement descriptor. Mobile banking apps display it as the name of the business. To use custom branding, set the Bacs Direct Debit Display Name during or right after creation. Custom branding incurs an additional monthly fee for the platform. The fee appears 5 business days after requesting Bacs. If you don\'t set the display name before requesting Bacs capability, it\'s automatically set as "Stripe" and the account is onboarded to Stripe branding, which is free.' ) .optional(), - /** The Bacs Direct Debit Service user number for this account. For payments made with Bacs Direct Debit, this number is a unique identifier of the account with our banking partners. */ + /**The Bacs Direct Debit Service user number for this account. For payments made with Bacs Direct Debit, this number is a unique identifier of the account with our banking partners.*/ service_user_number: z .string() .max(5000) - .nullable() .describe( 'The Bacs Direct Debit Service user number for this account. For payments made with Bacs Direct Debit, this number is a unique identifier of the account with our banking partners.' ) @@ -9717,25 +9197,23 @@ export namespace stripe { > export const CardIssuingAccountTermsOfServiceSchema = z.object({ - /** The Unix timestamp marking when the account representative accepted the service agreement. */ + /**The Unix timestamp marking when the account representative accepted the service agreement.*/ date: z .number() .int() - .nullable() .describe( 'The Unix timestamp marking when the account representative accepted the service agreement.' ) .optional(), - /** The IP address from which the account representative accepted the service agreement. */ + /**The IP address from which the account representative accepted the service agreement.*/ ip: z .string() .max(5000) - .nullable() .describe( 'The IP address from which the account representative accepted the service agreement.' ) .optional(), - /** The user agent of the browser from which the account representative accepted the service agreement. */ + /**The user agent of the browser from which the account representative accepted the service agreement.*/ user_agent: z .string() .max(5000) @@ -9749,13 +9227,13 @@ export namespace stripe { > export const AccountDeclineChargeOnSchema = z.object({ - /** Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification. */ + /**Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification.*/ avs_failure: z .boolean() .describe( 'Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification.' ), - /** Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification. */ + /**Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification.*/ cvc_failure: z .boolean() .describe( @@ -9767,20 +9245,18 @@ export namespace stripe { > export const AccountDashboardSettingsSchema = z.object({ - /** The display name for this account. This is used on the Stripe Dashboard to differentiate between accounts. */ + /**The display name for this account. This is used on the Stripe Dashboard to differentiate between accounts.*/ display_name: z .string() .max(5000) - .nullable() .describe( 'The display name for this account. This is used on the Stripe Dashboard to differentiate between accounts.' ) .optional(), - /** The timezone used in the Stripe Dashboard for this account. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones). */ + /**The timezone used in the Stripe Dashboard for this account. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones).*/ timezone: z .string() .max(5000) - .nullable() .describe( 'The timezone used in the Stripe Dashboard for this account. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones).' ) @@ -9791,29 +9267,26 @@ export namespace stripe { > export const AccountPaymentsSettingsSchema = z.object({ - /** The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. */ + /**The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge.*/ statement_descriptor: z .string() .max(5000) - .nullable() .describe( 'The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge.' ) .optional(), - /** The Kana variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). */ + /**The Kana variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).*/ statement_descriptor_kana: z .string() .max(5000) - .nullable() .describe( 'The Kana variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).' ) .optional(), - /** The Kanji variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). */ + /**The Kanji variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).*/ statement_descriptor_kanji: z .string() .max(5000) - .nullable() .describe( 'The Kanji variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).' ) @@ -9824,21 +9297,21 @@ export namespace stripe { > export const TransferScheduleSchema = z.object({ - /** The number of days charges for the account will be held before being paid out. */ + /**The number of days charges for the account will be held before being paid out.*/ delay_days: z .number() .int() .describe( 'The number of days charges for the account will be held before being paid out.' ), - /** How frequently funds will be paid out. One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`. */ + /**How frequently funds will be paid out. One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`.*/ interval: z .string() .max(5000) .describe( 'How frequently funds will be paid out. One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`.' ), - /** The day of the month funds will be paid out. Only shown if `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months. */ + /**The day of the month funds will be paid out. Only shown if `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months.*/ monthly_anchor: z .number() .int() @@ -9846,7 +9319,7 @@ export namespace stripe { 'The day of the month funds will be paid out. Only shown if `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months.' ) .optional(), - /** The day of the week funds will be paid out, of the style 'monday', 'tuesday', etc. Only shown if `interval` is weekly. */ + /**The day of the week funds will be paid out, of the style 'monday', 'tuesday', etc. Only shown if `interval` is weekly.*/ weekly_anchor: z .string() .max(5000) @@ -9858,7 +9331,7 @@ export namespace stripe { export type TransferSchedule = z.infer export const AccountSepaDebitPaymentsSettingsSchema = z.object({ - /** SEPA creditor identifier that identifies the company making the payment. */ + /**SEPA creditor identifier that identifies the company making the payment.*/ creditor_id: z .string() .max(5000) @@ -9872,25 +9345,23 @@ export namespace stripe { > export const AccountTermsOfServiceSchema = z.object({ - /** The Unix timestamp marking when the account representative accepted the service agreement. */ + /**The Unix timestamp marking when the account representative accepted the service agreement.*/ date: z .number() .int() - .nullable() .describe( 'The Unix timestamp marking when the account representative accepted the service agreement.' ) .optional(), - /** The IP address from which the account representative accepted the service agreement. */ + /**The IP address from which the account representative accepted the service agreement.*/ ip: z .string() .max(5000) - .nullable() .describe( 'The IP address from which the account representative accepted the service agreement.' ) .optional(), - /** The user agent of the browser from which the account representative accepted the service agreement. */ + /**The user agent of the browser from which the account representative accepted the service agreement.*/ user_agent: z .string() .max(5000) @@ -9904,35 +9375,32 @@ export namespace stripe { > export const AccountTosAcceptanceSchema = z.object({ - /** The Unix timestamp marking when the account representative accepted their service agreement */ + /**The Unix timestamp marking when the account representative accepted their service agreement*/ date: z .number() .int() - .nullable() .describe( 'The Unix timestamp marking when the account representative accepted their service agreement' ) .optional(), - /** The IP address from which the account representative accepted their service agreement */ + /**The IP address from which the account representative accepted their service agreement*/ ip: z .string() .max(5000) - .nullable() .describe( 'The IP address from which the account representative accepted their service agreement' ) .optional(), - /** The user's service agreement type */ + /**The user's service agreement type*/ service_agreement: z .string() .max(5000) .describe("The user's service agreement type") .optional(), - /** The user agent of the browser from which the account representative accepted their service agreement */ + /**The user agent of the browser from which the account representative accepted their service agreement*/ user_agent: z .string() .max(5000) - .nullable() .describe( 'The user agent of the browser from which the account representative accepted their service agreement' ) @@ -9948,25 +9416,25 @@ export namespace stripe { */ export const AccountLinkSchema = z .object({ - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** The timestamp at which this account link will expire. */ + /**The timestamp at which this account link will expire.*/ expires_at: z .number() .int() .describe('The timestamp at which this account link will expire.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('account_link') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The URL for the account link. */ + /**The URL for the account link.*/ url: z.string().max(5000).describe('The URL for the account link.') }) .describe( @@ -9975,13 +9443,13 @@ export namespace stripe { export type AccountLink = z.infer export const ConnectEmbeddedAccountFeaturesClaimSchema = z.object({ - /** Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don’t set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false. */ + /**Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don’t set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false.*/ disable_stripe_user_authentication: z .boolean() .describe( 'Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don’t set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false.' ), - /** Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like custom accounts. Otherwise, bank account collection is determined by compliance requirements. The default value for this feature is `true`. */ + /**Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like custom accounts. Otherwise, bank account collection is determined by compliance requirements. The default value for this feature is `true`.*/ external_account_collection: z .boolean() .describe( @@ -9993,31 +9461,31 @@ export namespace stripe { > export const ConnectEmbeddedPayoutsFeaturesSchema = z.object({ - /** Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don’t set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false. */ + /**Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don’t set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false.*/ disable_stripe_user_authentication: z .boolean() .describe( 'Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don’t set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false.' ), - /** Whether to allow payout schedule to be changed. Default `true` when Stripe owns Loss Liability, default `false` otherwise. */ + /**Whether to allow payout schedule to be changed. Default `true` when Stripe owns Loss Liability, default `false` otherwise.*/ edit_payout_schedule: z .boolean() .describe( 'Whether to allow payout schedule to be changed. Default `true` when Stripe owns Loss Liability, default `false` otherwise.' ), - /** Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like custom accounts. Otherwise, bank account collection is determined by compliance requirements. The default value for this feature is `true`. */ + /**Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like custom accounts. Otherwise, bank account collection is determined by compliance requirements. The default value for this feature is `true`.*/ external_account_collection: z .boolean() .describe( 'Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like custom accounts. Otherwise, bank account collection is determined by compliance requirements. The default value for this feature is `true`.' ), - /** Whether to allow creation of instant payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise. */ + /**Whether to allow creation of instant payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise.*/ instant_payouts: z .boolean() .describe( 'Whether to allow creation of instant payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise.' ), - /** Whether to allow creation of standard payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise. */ + /**Whether to allow creation of standard payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise.*/ standard_payouts: z .boolean() .describe( @@ -10034,21 +9502,21 @@ export namespace stripe { > export const ConnectEmbeddedFinancialAccountFeaturesSchema = z.object({ - /** Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don’t set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false. */ + /**Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don’t set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false.*/ disable_stripe_user_authentication: z .boolean() .describe( 'Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don’t set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false.' ), - /** Whether to allow external accounts to be linked for money transfer. */ + /**Whether to allow external accounts to be linked for money transfer.*/ external_account_collection: z .boolean() .describe( 'Whether to allow external accounts to be linked for money transfer.' ), - /** Whether to allow sending money. */ + /**Whether to allow sending money.*/ send_money: z.boolean().describe('Whether to allow sending money.'), - /** Whether to allow transferring balance. */ + /**Whether to allow transferring balance.*/ transfer_balance: z .boolean() .describe('Whether to allow transferring balance.') @@ -10059,7 +9527,7 @@ export namespace stripe { export const ConnectEmbeddedFinancialAccountTransactionsFeaturesSchema = z.object({ - /** Whether to allow card spend dispute management features. */ + /**Whether to allow card spend dispute management features.*/ card_spend_dispute_management: z .boolean() .describe('Whether to allow card spend dispute management features.') @@ -10069,19 +9537,19 @@ export namespace stripe { > export const ConnectEmbeddedIssuingCardFeaturesSchema = z.object({ - /** Whether to allow card management features. */ + /**Whether to allow card management features.*/ card_management: z .boolean() .describe('Whether to allow card management features.'), - /** Whether to allow card spend dispute management features. */ + /**Whether to allow card spend dispute management features.*/ card_spend_dispute_management: z .boolean() .describe('Whether to allow card spend dispute management features.'), - /** Whether to allow cardholder management features. */ + /**Whether to allow cardholder management features.*/ cardholder_management: z .boolean() .describe('Whether to allow cardholder management features.'), - /** Whether to allow spend control management features. */ + /**Whether to allow spend control management features.*/ spend_control_management: z .boolean() .describe('Whether to allow spend control management features.') @@ -10091,25 +9559,25 @@ export namespace stripe { > export const ConnectEmbeddedIssuingCardsListFeaturesSchema = z.object({ - /** Whether to allow card management features. */ + /**Whether to allow card management features.*/ card_management: z .boolean() .describe('Whether to allow card management features.'), - /** Whether to allow card spend dispute management features. */ + /**Whether to allow card spend dispute management features.*/ card_spend_dispute_management: z .boolean() .describe('Whether to allow card spend dispute management features.'), - /** Whether to allow cardholder management features. */ + /**Whether to allow cardholder management features.*/ cardholder_management: z .boolean() .describe('Whether to allow cardholder management features.'), - /** Disables Stripe user authentication for this embedded component. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like custom accounts. */ + /**Disables Stripe user authentication for this embedded component. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like custom accounts.*/ disable_stripe_user_authentication: z .boolean() .describe( 'Disables Stripe user authentication for this embedded component. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like custom accounts.' ), - /** Whether to allow spend control management features. */ + /**Whether to allow spend control management features.*/ spend_control_management: z .boolean() .describe('Whether to allow spend control management features.') @@ -10119,25 +9587,25 @@ export namespace stripe { > export const ConnectEmbeddedPaymentsFeaturesSchema = z.object({ - /** Whether to allow capturing and cancelling payment intents. This is `true` by default. */ + /**Whether to allow capturing and cancelling payment intents. This is `true` by default.*/ capture_payments: z .boolean() .describe( 'Whether to allow capturing and cancelling payment intents. This is `true` by default.' ), - /** Whether to allow connected accounts to manage destination charges that are created on behalf of them. This is `false` by default. */ + /**Whether to allow connected accounts to manage destination charges that are created on behalf of them. This is `false` by default.*/ destination_on_behalf_of_charge_management: z .boolean() .describe( 'Whether to allow connected accounts to manage destination charges that are created on behalf of them. This is `false` by default.' ), - /** Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default. */ + /**Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default.*/ dispute_management: z .boolean() .describe( 'Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default.' ), - /** Whether to allow sending refunds. This is `true` by default. */ + /**Whether to allow sending refunds. This is `true` by default.*/ refund_management: z .boolean() .describe('Whether to allow sending refunds. This is `true` by default.') @@ -10147,11 +9615,11 @@ export namespace stripe { > export const DeletedAccountSchema = z.object({ - /** Always true for a deleted object */ + /**Always true for a deleted object*/ deleted: z.literal(true).describe('Always true for a deleted object'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('account') .describe( @@ -10160,23 +9628,23 @@ export namespace stripe { }) export type DeletedAccount = z.infer - /** Login Links are single-use URLs for a connected account to access the Express Dashboard. The connected account's [account.controller.stripe_dashboard.type](/api/accounts/object#account_object-controller-stripe_dashboard-type) must be `express` to have access to the Express Dashboard. */ + /**Login Links are single-use URLs for a connected account to access the Express Dashboard. The connected account's [account.controller.stripe_dashboard.type](/api/accounts/object#account_object-controller-stripe_dashboard-type) must be `express` to have access to the Express Dashboard.*/ export const LoginLinkSchema = z .object({ - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('login_link') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The URL for the login link. */ + /**The URL for the login link.*/ url: z.string().max(5000).describe('The URL for the login link.') }) .describe( @@ -10185,11 +9653,11 @@ export namespace stripe { export type LoginLink = z.infer export const DeletedPersonSchema = z.object({ - /** Always true for a deleted object */ + /**Always true for a deleted object*/ deleted: z.literal(true).describe('Always true for a deleted object'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('person') .describe( @@ -10199,7 +9667,7 @@ export namespace stripe { export type DeletedPerson = z.infer export const ApplePayDomainSchema = z.object({ - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() @@ -10207,15 +9675,15 @@ export namespace stripe { 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), domain_name: z.string().max(5000), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('apple_pay_domain') .describe( @@ -10225,11 +9693,11 @@ export namespace stripe { export type ApplePayDomain = z.infer export const DeletedApplePayDomainSchema = z.object({ - /** Always true for a deleted object */ + /**Always true for a deleted object*/ deleted: z.literal(true).describe('Always true for a deleted object'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('apple_pay_domain') .describe( @@ -10241,9 +9709,9 @@ export namespace stripe { > export const SecretServiceResourceScopeSchema = z.object({ - /** The secret scope type. */ + /**The secret scope type.*/ type: z.enum(['account', 'user']).describe('The secret scope type.'), - /** The user ID, if type is set to "user" */ + /**The user ID, if type is set to "user"*/ user: z .string() .max(5000) @@ -10255,7 +9723,7 @@ export namespace stripe { > export const BalanceAmountBySourceTypeSchema = z.object({ - /** Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated). */ + /**Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated).*/ bank_account: z .number() .int() @@ -10263,7 +9731,7 @@ export namespace stripe { 'Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated).' ) .optional(), - /** Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits). */ + /**Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits).*/ card: z .number() .int() @@ -10271,7 +9739,7 @@ export namespace stripe { 'Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits).' ) .optional(), - /** Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method. */ + /**Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method.*/ fpx: z .number() .int() @@ -10285,14 +9753,14 @@ export namespace stripe { > export const BillingMeterResourceCustomerMappingSettingsSchema = z.object({ - /** The key in the meter event payload to use for mapping the event to a customer. */ + /**The key in the meter event payload to use for mapping the event to a customer.*/ event_payload_key: z .string() .max(5000) .describe( 'The key in the meter event payload to use for mapping the event to a customer.' ), - /** The method for mapping a meter event to a customer. */ + /**The method for mapping a meter event to a customer.*/ type: z .literal('by_id') .describe('The method for mapping a meter event to a customer.') @@ -10302,7 +9770,7 @@ export namespace stripe { > export const BillingMeterResourceAggregationSettingsSchema = z.object({ - /** Specifies how events are aggregated. */ + /**Specifies how events are aggregated.*/ formula: z .enum(['count', 'sum']) .describe('Specifies how events are aggregated.') @@ -10313,11 +9781,10 @@ export namespace stripe { export const BillingMeterResourceBillingMeterStatusTransitionsSchema = z.object({ - /** The time the meter was deactivated, if any. Measured in seconds since Unix epoch. */ + /**The time the meter was deactivated, if any. Measured in seconds since Unix epoch.*/ deactivated_at: z .number() .int() - .nullable() .describe( 'The time the meter was deactivated, if any. Measured in seconds since Unix epoch.' ) @@ -10328,7 +9795,7 @@ export namespace stripe { > export const BillingMeterResourceBillingMeterValueSchema = z.object({ - /** The key in the meter event payload to use as the value for this meter. */ + /**The key in the meter event payload to use as the value for this meter.*/ event_payload_key: z .string() .max(5000) @@ -10342,11 +9809,10 @@ export namespace stripe { export const BillingMeterResourceBillingMeterEventAdjustmentCancelSchema = z.object({ - /** Unique identifier for the event. */ + /**Unique identifier for the event.*/ identifier: z .string() .max(100) - .nullable() .describe('Unique identifier for the event.') .optional() }) @@ -10354,47 +9820,47 @@ export namespace stripe { typeof BillingMeterResourceBillingMeterEventAdjustmentCancelSchema > - /** Meter events represent actions that customers take in your system. You can use meter events to bill a customer based on their usage. Meter events are associated with billing meters, which define both the contents of the event’s payload and how to aggregate those events. */ + /**Meter events represent actions that customers take in your system. You can use meter events to bill a customer based on their usage. Meter events are associated with billing meters, which define both the contents of the event’s payload and how to aggregate those events.*/ export const BillingMeterEventSchema = z .object({ - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** The name of the meter event. Corresponds with the `event_name` field on a meter. */ + /**The name of the meter event. Corresponds with the `event_name` field on a meter.*/ event_name: z .string() .max(100) .describe( 'The name of the meter event. Corresponds with the `event_name` field on a meter.' ), - /** A unique identifier for the event. */ + /**A unique identifier for the event.*/ identifier: z .string() .max(5000) .describe('A unique identifier for the event.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('billing.meter_event') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The payload of the event. This contains the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://stripe.com/docs/billing/subscriptions/usage-based/recording-usage#payload-key-overrides). */ + /**The payload of the event. This contains the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://stripe.com/docs/billing/subscriptions/usage-based/recording-usage#payload-key-overrides).*/ payload: z .record(z.string().max(100)) .describe( "The payload of the event. This contains the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://stripe.com/docs/billing/subscriptions/usage-based/recording-usage#payload-key-overrides)." ), - /** The timestamp passed in when creating the event. Measured in seconds since the Unix epoch. */ + /**The timestamp passed in when creating the event. Measured in seconds since the Unix epoch.*/ timestamp: z .number() .int() @@ -10415,39 +9881,39 @@ export namespace stripe { */ export const BillingMeterEventSummarySchema = z .object({ - /** Aggregated value of all the events within `start_time` (inclusive) and `end_time` (inclusive). The aggregation strategy is defined on meter via `default_aggregation`. */ + /**Aggregated value of all the events within `start_time` (inclusive) and `end_time` (inclusive). The aggregation strategy is defined on meter via `default_aggregation`.*/ aggregated_value: z .number() .describe( 'Aggregated value of all the events within `start_time` (inclusive) and `end_time` (inclusive). The aggregation strategy is defined on meter via `default_aggregation`.' ), - /** End timestamp for this event summary (exclusive). Must be aligned with minute boundaries. */ + /**End timestamp for this event summary (exclusive). Must be aligned with minute boundaries.*/ end_time: z .number() .int() .describe( 'End timestamp for this event summary (exclusive). Must be aligned with minute boundaries.' ), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** The meter associated with this event summary. */ + /**The meter associated with this event summary.*/ meter: z .string() .max(5000) .describe('The meter associated with this event summary.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('billing.meter_event_summary') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** Start timestamp for this event summary (inclusive). Must be aligned with minute boundaries. */ + /**Start timestamp for this event summary (inclusive). Must be aligned with minute boundaries.*/ start_time: z .number() .int() @@ -10463,25 +9929,22 @@ export namespace stripe { > export const PortalBusinessProfileSchema = z.object({ - /** The messaging shown to customers in the portal. */ + /**The messaging shown to customers in the portal.*/ headline: z .string() .max(5000) - .nullable() .describe('The messaging shown to customers in the portal.') .optional(), - /** A link to the business’s publicly available privacy policy. */ + /**A link to the business’s publicly available privacy policy.*/ privacy_policy_url: z .string() .max(5000) - .nullable() .describe('A link to the business’s publicly available privacy policy.') .optional(), - /** A link to the business’s publicly available terms of service. */ + /**A link to the business’s publicly available terms of service.*/ terms_of_service_url: z .string() .max(5000) - .nullable() .describe('A link to the business’s publicly available terms of service.') .optional() }) @@ -10490,7 +9953,7 @@ export namespace stripe { > export const PortalCustomerUpdateSchema = z.object({ - /** The types of customer updates that are supported. When empty, customers are not updateable. */ + /**The types of customer updates that are supported. When empty, customers are not updateable.*/ allowed_updates: z .array( z.enum(['address', 'email', 'name', 'phone', 'shipping', 'tax_id']) @@ -10498,19 +9961,19 @@ export namespace stripe { .describe( 'The types of customer updates that are supported. When empty, customers are not updateable.' ), - /** Whether the feature is enabled. */ + /**Whether the feature is enabled.*/ enabled: z.boolean().describe('Whether the feature is enabled.') }) export type PortalCustomerUpdate = z.infer export const PortalInvoiceListSchema = z.object({ - /** Whether the feature is enabled. */ + /**Whether the feature is enabled.*/ enabled: z.boolean().describe('Whether the feature is enabled.') }) export type PortalInvoiceList = z.infer export const PortalPaymentMethodUpdateSchema = z.object({ - /** Whether the feature is enabled. */ + /**Whether the feature is enabled.*/ enabled: z.boolean().describe('Whether the feature is enabled.') }) export type PortalPaymentMethodUpdate = z.infer< @@ -10518,9 +9981,9 @@ export namespace stripe { > export const PortalSubscriptionCancellationReasonSchema = z.object({ - /** Whether the feature is enabled. */ + /**Whether the feature is enabled.*/ enabled: z.boolean().describe('Whether the feature is enabled.'), - /** Which cancellation reasons will be given as options to the customer. */ + /**Which cancellation reasons will be given as options to the customer.*/ options: z .array( z.enum([ @@ -10543,13 +10006,13 @@ export namespace stripe { > export const PortalSubscriptionUpdateProductSchema = z.object({ - /** The list of price IDs which, when subscribed to, a subscription can be updated. */ + /**The list of price IDs which, when subscribed to, a subscription can be updated.*/ prices: z .array(z.string().max(5000)) .describe( 'The list of price IDs which, when subscribed to, a subscription can be updated.' ), - /** The product ID. */ + /**The product ID.*/ product: z.string().max(5000).describe('The product ID.') }) export type PortalSubscriptionUpdateProduct = z.infer< @@ -10558,7 +10021,7 @@ export namespace stripe { export const PortalResourceScheduleUpdateAtPeriodEndConditionSchema = z.object({ - /** The type of condition. */ + /**The type of condition.*/ type: z .enum(['decreasing_item_amount', 'shortening_interval']) .describe('The type of condition.') @@ -10578,11 +10041,10 @@ export namespace stripe { .describe( 'If `true`, a shareable `url` will be generated that will take your customers to a hosted login page for the customer portal.\n\nIf `false`, the previously generated `url`, if any, will be deactivated.' ), - /** A shareable URL to the hosted portal login page. Your customers will be able to log in with their [email](https://stripe.com/docs/api/customers/object#customer_object-email) and receive a link to their customer portal. */ + /**A shareable URL to the hosted portal login page. Your customers will be able to log in with their [email](https://stripe.com/docs/api/customers/object#customer_object-email) and receive a link to their customer portal.*/ url: z .string() .max(5000) - .nullable() .describe( 'A shareable URL to the hosted portal login page. Your customers will be able to log in with their [email](https://stripe.com/docs/api/customers/object#customer_object-email) and receive a link to their customer portal.' ) @@ -10591,11 +10053,10 @@ export namespace stripe { export type PortalLoginPage = z.infer export const PortalFlowsAfterCompletionHostedConfirmationSchema = z.object({ - /** A custom message to display to the customer after the flow is completed. */ + /**A custom message to display to the customer after the flow is completed.*/ custom_message: z .string() .max(5000) - .nullable() .describe( 'A custom message to display to the customer after the flow is completed.' ) @@ -10606,7 +10067,7 @@ export namespace stripe { > export const PortalFlowsAfterCompletionRedirectSchema = z.object({ - /** The URL the customer will be redirected to after the flow is completed. */ + /**The URL the customer will be redirected to after the flow is completed.*/ return_url: z .string() .max(5000) @@ -10619,7 +10080,7 @@ export namespace stripe { > export const PortalFlowsCouponOfferSchema = z.object({ - /** The ID of the coupon to be offered. */ + /**The ID of the coupon to be offered.*/ coupon: z.string().max(5000).describe('The ID of the coupon to be offered.') }) export type PortalFlowsCouponOffer = z.infer< @@ -10627,7 +10088,7 @@ export namespace stripe { > export const PortalFlowsFlowSubscriptionUpdateSchema = z.object({ - /** The ID of the subscription to be updated. */ + /**The ID of the subscription to be updated.*/ subscription: z .string() .max(5000) @@ -10638,18 +10099,16 @@ export namespace stripe { > export const PortalFlowsSubscriptionUpdateConfirmDiscountSchema = z.object({ - /** The ID of the coupon to apply to this subscription update. */ + /**The ID of the coupon to apply to this subscription update.*/ coupon: z .string() .max(5000) - .nullable() .describe('The ID of the coupon to apply to this subscription update.') .optional(), - /** The ID of a promotion code to apply to this subscription update. */ + /**The ID of a promotion code to apply to this subscription update.*/ promotion_code: z .string() .max(5000) - .nullable() .describe( 'The ID of a promotion code to apply to this subscription update.' ) @@ -10660,25 +10119,23 @@ export namespace stripe { > export const PortalFlowsSubscriptionUpdateConfirmItemSchema = z.object({ - /** The ID of the [subscription item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) to be updated. */ + /**The ID of the [subscription item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) to be updated.*/ id: z .string() .max(5000) - .nullable() .describe( 'The ID of the [subscription item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) to be updated.' ) .optional(), - /** The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products). */ + /**The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products).*/ price: z .string() .max(5000) - .nullable() .describe( "The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products)." ) .optional(), - /** [Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow. */ + /**[Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow.*/ quantity: z .number() .int() @@ -10692,7 +10149,7 @@ export namespace stripe { > export const PaymentPagesCheckoutSessionAdaptivePricingSchema = z.object({ - /** Whether Adaptive Pricing is enabled. */ + /**Whether Adaptive Pricing is enabled.*/ enabled: z.boolean().describe('Whether Adaptive Pricing is enabled.') }) export type PaymentPagesCheckoutSessionAdaptivePricing = z.infer< @@ -10701,7 +10158,7 @@ export namespace stripe { export const PaymentPagesCheckoutSessionAfterExpirationRecoverySchema = z.object({ - /** Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false` */ + /**Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false`*/ allow_promotion_codes: z .boolean() .describe( @@ -10717,18 +10174,16 @@ export namespace stripe { .describe( 'If `true`, a recovery url will be generated to recover this Checkout Session if it\nexpires before a transaction is completed. It will be attached to the\nCheckout Session object upon expiration.' ), - /** The timestamp at which the recovery URL will expire. */ + /**The timestamp at which the recovery URL will expire.*/ expires_at: z .number() .int() - .nullable() .describe('The timestamp at which the recovery URL will expire.') .optional(), - /** URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session */ + /**URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session*/ url: z .string() .max(5000) - .nullable() .describe( 'URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session' ) @@ -10745,15 +10200,13 @@ export namespace stripe { */ promotions: z .enum(['opt_in', 'opt_out']) - .nullable() .describe( 'If `opt_in`, the customer consents to receiving promotional communications\nfrom the merchant about this Checkout Session.' ) .optional(), - /** If `accepted`, the customer in this Checkout Session has agreed to the merchant's terms of service. */ + /**If `accepted`, the customer in this Checkout Session has agreed to the merchant's terms of service.*/ terms_of_service: z .literal('accepted') - .nullable() .describe( "If `accepted`, the customer in this Checkout Session has agreed to the merchant's terms of service." ) @@ -10781,27 +10234,27 @@ export namespace stripe { > export const PaymentPagesCheckoutSessionCurrencyConversionSchema = z.object({ - /** Total of all items in source currency before discounts or taxes are applied. */ + /**Total of all items in source currency before discounts or taxes are applied.*/ amount_subtotal: z .number() .int() .describe( 'Total of all items in source currency before discounts or taxes are applied.' ), - /** Total of all items in source currency after discounts and taxes are applied. */ + /**Total of all items in source currency after discounts and taxes are applied.*/ amount_total: z .number() .int() .describe( 'Total of all items in source currency after discounts and taxes are applied.' ), - /** Exchange rate used to convert source currency amounts to customer currency amounts */ + /**Exchange rate used to convert source currency amounts to customer currency amounts*/ fx_rate: z .string() .describe( 'Exchange rate used to convert source currency amounts to customer currency amounts' ), - /** Creation currency of the CheckoutSession before localization */ + /**Creation currency of the CheckoutSession before localization*/ source_currency: z .string() .max(5000) @@ -10812,14 +10265,14 @@ export namespace stripe { > export const PaymentPagesCheckoutSessionCustomFieldsOptionSchema = z.object({ - /** The label for the option, displayed to the customer. Up to 100 characters. */ + /**The label for the option, displayed to the customer. Up to 100 characters.*/ label: z .string() .max(5000) .describe( 'The label for the option, displayed to the customer. Up to 100 characters.' ), - /** The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters. */ + /**The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.*/ value: z .string() .max(5000) @@ -10832,16 +10285,15 @@ export namespace stripe { > export const PaymentPagesCheckoutSessionCustomFieldsLabelSchema = z.object({ - /** Custom text for the label, displayed to the customer. Up to 50 characters. */ + /**Custom text for the label, displayed to the customer. Up to 50 characters.*/ custom: z .string() .max(5000) - .nullable() .describe( 'Custom text for the label, displayed to the customer. Up to 50 characters.' ) .optional(), - /** The type of the label. */ + /**The type of the label.*/ type: z.literal('custom').describe('The type of the label.') }) export type PaymentPagesCheckoutSessionCustomFieldsLabel = z.infer< @@ -10849,36 +10301,32 @@ export namespace stripe { > export const PaymentPagesCheckoutSessionCustomFieldsNumericSchema = z.object({ - /** The value that will pre-fill the field on the payment page. */ + /**The value that will pre-fill the field on the payment page.*/ default_value: z .string() .max(5000) - .nullable() .describe('The value that will pre-fill the field on the payment page.') .optional(), - /** The maximum character length constraint for the customer's input. */ + /**The maximum character length constraint for the customer's input.*/ maximum_length: z .number() .int() - .nullable() .describe( "The maximum character length constraint for the customer's input." ) .optional(), - /** The minimum character length requirement for the customer's input. */ + /**The minimum character length requirement for the customer's input.*/ minimum_length: z .number() .int() - .nullable() .describe( "The minimum character length requirement for the customer's input." ) .optional(), - /** The value entered by the customer, containing only digits. */ + /**The value entered by the customer, containing only digits.*/ value: z .string() .max(5000) - .nullable() .describe('The value entered by the customer, containing only digits.') .optional() }) @@ -10887,36 +10335,32 @@ export namespace stripe { > export const PaymentPagesCheckoutSessionCustomFieldsTextSchema = z.object({ - /** The value that will pre-fill the field on the payment page. */ + /**The value that will pre-fill the field on the payment page.*/ default_value: z .string() .max(5000) - .nullable() .describe('The value that will pre-fill the field on the payment page.') .optional(), - /** The maximum character length constraint for the customer's input. */ + /**The maximum character length constraint for the customer's input.*/ maximum_length: z .number() .int() - .nullable() .describe( "The maximum character length constraint for the customer's input." ) .optional(), - /** The minimum character length requirement for the customer's input. */ + /**The minimum character length requirement for the customer's input.*/ minimum_length: z .number() .int() - .nullable() .describe( "The minimum character length requirement for the customer's input." ) .optional(), - /** The value entered by the customer. */ + /**The value entered by the customer.*/ value: z .string() .max(5000) - .nullable() .describe('The value entered by the customer.') .optional() }) @@ -10925,7 +10369,7 @@ export namespace stripe { > export const PaymentPagesCheckoutSessionCustomTextPositionSchema = z.object({ - /** Text may be up to 1200 characters in length. */ + /**Text may be up to 1200 characters in length.*/ message: z .string() .max(500) @@ -10936,7 +10380,7 @@ export namespace stripe { > export const PaymentPagesCheckoutSessionTaxIdSchema = z.object({ - /** The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or `unknown` */ + /**The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or `unknown`*/ type: z .enum([ 'ad_nrt', @@ -11044,24 +10488,18 @@ export namespace stripe { .describe( 'The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or `unknown`' ), - /** The value of the tax ID. */ - value: z - .string() - .max(5000) - .nullable() - .describe('The value of the tax ID.') - .optional() + /**The value of the tax ID.*/ + value: z.string().max(5000).describe('The value of the tax ID.').optional() }) export type PaymentPagesCheckoutSessionTaxId = z.infer< typeof PaymentPagesCheckoutSessionTaxIdSchema > export const InvoiceSettingCheckoutRenderingOptionsSchema = z.object({ - /** How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. */ + /**How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.*/ amount_tax_display: z .string() .max(5000) - .nullable() .describe( 'How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.' ) @@ -11073,11 +10511,10 @@ export namespace stripe { export const PaymentLinksResourceCompletionBehaviorConfirmationPageSchema = z.object({ - /** The custom message that is displayed to the customer after the purchase is complete. */ + /**The custom message that is displayed to the customer after the purchase is complete.*/ custom_message: z .string() .max(5000) - .nullable() .describe( 'The custom message that is displayed to the customer after the purchase is complete.' ) @@ -11088,7 +10525,7 @@ export namespace stripe { > export const PaymentLinksResourceCompletionBehaviorRedirectSchema = z.object({ - /** The URL the customer will be redirected to after the purchase is complete. */ + /**The URL the customer will be redirected to after the purchase is complete.*/ url: z .string() .max(5000) @@ -11119,14 +10556,14 @@ export namespace stripe { > export const PaymentLinksResourceCustomFieldsDropdownOptionSchema = z.object({ - /** The label for the option, displayed to the customer. Up to 100 characters. */ + /**The label for the option, displayed to the customer. Up to 100 characters.*/ label: z .string() .max(5000) .describe( 'The label for the option, displayed to the customer. Up to 100 characters.' ), - /** The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters. */ + /**The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.*/ value: z .string() .max(5000) @@ -11139,16 +10576,15 @@ export namespace stripe { > export const PaymentLinksResourceCustomFieldsLabelSchema = z.object({ - /** Custom text for the label, displayed to the customer. Up to 50 characters. */ + /**Custom text for the label, displayed to the customer. Up to 50 characters.*/ custom: z .string() .max(5000) - .nullable() .describe( 'Custom text for the label, displayed to the customer. Up to 50 characters.' ) .optional(), - /** The type of the label. */ + /**The type of the label.*/ type: z.literal('custom').describe('The type of the label.') }) export type PaymentLinksResourceCustomFieldsLabel = z.infer< @@ -11156,20 +10592,18 @@ export namespace stripe { > export const PaymentLinksResourceCustomFieldsNumericSchema = z.object({ - /** The maximum character length constraint for the customer's input. */ + /**The maximum character length constraint for the customer's input.*/ maximum_length: z .number() .int() - .nullable() .describe( "The maximum character length constraint for the customer's input." ) .optional(), - /** The minimum character length requirement for the customer's input. */ + /**The minimum character length requirement for the customer's input.*/ minimum_length: z .number() .int() - .nullable() .describe( "The minimum character length requirement for the customer's input." ) @@ -11180,20 +10614,18 @@ export namespace stripe { > export const PaymentLinksResourceCustomFieldsTextSchema = z.object({ - /** The maximum character length constraint for the customer's input. */ + /**The maximum character length constraint for the customer's input.*/ maximum_length: z .number() .int() - .nullable() .describe( "The maximum character length constraint for the customer's input." ) .optional(), - /** The minimum character length requirement for the customer's input. */ + /**The minimum character length requirement for the customer's input.*/ minimum_length: z .number() .int() - .nullable() .describe( "The minimum character length requirement for the customer's input." ) @@ -11204,7 +10636,7 @@ export namespace stripe { > export const PaymentLinksResourceCustomTextPositionSchema = z.object({ - /** Text may be up to 1200 characters in length. */ + /**Text may be up to 1200 characters in length.*/ message: z .string() .max(500) @@ -11215,60 +10647,54 @@ export namespace stripe { > export const PaymentLinksResourcePaymentIntentDataSchema = z.object({ - /** Indicates when the funds will be captured from the customer's account. */ + /**Indicates when the funds will be captured from the customer's account.*/ capture_method: z .enum(['automatic', 'automatic_async', 'manual']) - .nullable() .describe( "Indicates when the funds will be captured from the customer's account." ) .optional(), - /** An arbitrary string attached to the object. Often useful for displaying to users. */ + /**An arbitrary string attached to the object. Often useful for displaying to users.*/ description: z .string() .max(5000) - .nullable() .describe( 'An arbitrary string attached to the object. Often useful for displaying to users.' ) .optional(), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on [Payment Intents](https://stripe.com/docs/api/payment_intents) generated from this payment link. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on [Payment Intents](https://stripe.com/docs/api/payment_intents) generated from this payment link.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on [Payment Intents](https://stripe.com/docs/api/payment_intents) generated from this payment link.' ), - /** Indicates that you intend to make future payments with the payment method collected during checkout. */ + /**Indicates that you intend to make future payments with the payment method collected during checkout.*/ setup_future_usage: z .enum(['off_session', 'on_session']) - .nullable() .describe( 'Indicates that you intend to make future payments with the payment method collected during checkout.' ) .optional(), - /** For a non-card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. */ + /**For a non-card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge.*/ statement_descriptor: z .string() .max(5000) - .nullable() .describe( "For a non-card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge." ) .optional(), - /** For a card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. Concatenated with the account's statement descriptor prefix to form the complete statement descriptor. */ + /**For a card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. Concatenated with the account's statement descriptor prefix to form the complete statement descriptor.*/ statement_descriptor_suffix: z .string() .max(5000) - .nullable() .describe( "For a card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. Concatenated with the account's statement descriptor prefix to form the complete statement descriptor." ) .optional(), - /** A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details. */ + /**A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.*/ transfer_group: z .string() .max(5000) - .nullable() .describe( 'A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.' ) @@ -11279,7 +10705,7 @@ export namespace stripe { > export const PaymentLinksResourcePhoneNumberCollectionSchema = z.object({ - /** If `true`, a phone number will be collected during checkout. */ + /**If `true`, a phone number will be collected during checkout.*/ enabled: z .boolean() .describe('If `true`, a phone number will be collected during checkout.') @@ -11289,14 +10715,14 @@ export namespace stripe { > export const PaymentLinksResourceCompletedSessionsSchema = z.object({ - /** The current number of checkout sessions that have been completed on the payment link which count towards the `completed_sessions` restriction to be met. */ + /**The current number of checkout sessions that have been completed on the payment link which count towards the `completed_sessions` restriction to be met.*/ count: z .number() .int() .describe( 'The current number of checkout sessions that have been completed on the payment link which count towards the `completed_sessions` restriction to be met.' ), - /** The maximum number of checkout sessions that can be completed for the `completed_sessions` restriction to be met. */ + /**The maximum number of checkout sessions that can be completed for the `completed_sessions` restriction to be met.*/ limit: z .number() .int() @@ -11309,7 +10735,7 @@ export namespace stripe { > export const PaymentLinksResourceShippingAddressCollectionSchema = z.object({ - /** An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`. */ + /**An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`.*/ allowed_countries: z .array( z.enum([ @@ -11562,7 +10988,7 @@ export namespace stripe { > export const PaymentLinksResourceTaxIdCollectionSchema = z.object({ - /** Indicates whether tax ID collection is enabled for the session. */ + /**Indicates whether tax ID collection is enabled for the session.*/ enabled: z .boolean() .describe( @@ -11575,38 +11001,35 @@ export namespace stripe { > export const CheckoutAcssDebitMandateOptionsSchema = z.object({ - /** A URL for custom mandate text */ + /**A URL for custom mandate text*/ custom_mandate_url: z .string() .max(5000) .describe('A URL for custom mandate text') .optional(), - /** List of Stripe products where this mandate can be selected automatically. Returned when the Session is in `setup` mode. */ + /**List of Stripe products where this mandate can be selected automatically. Returned when the Session is in `setup` mode.*/ default_for: z .array(z.enum(['invoice', 'subscription'])) .describe( 'List of Stripe products where this mandate can be selected automatically. Returned when the Session is in `setup` mode.' ) .optional(), - /** Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. */ + /**Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.*/ interval_description: z .string() .max(5000) - .nullable() .describe( "Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'." ) .optional(), - /** Payment schedule for the mandate. */ + /**Payment schedule for the mandate.*/ payment_schedule: z .enum(['combined', 'interval', 'sporadic']) - .nullable() .describe('Payment schedule for the mandate.') .optional(), - /** Transaction type of the mandate. */ + /**Transaction type of the mandate.*/ transaction_type: z .enum(['business', 'personal']) - .nullable() .describe('Transaction type of the mandate.') .optional() }) @@ -11714,7 +11137,7 @@ export namespace stripe { "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)." ) .optional(), - /** Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now. */ + /**Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.*/ target_date: z .string() .max(5000) @@ -11729,7 +11152,7 @@ export namespace stripe { export const CheckoutPaymentMethodOptionsMandateOptionsBacsDebitSchema = z.object({ - /** Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'. */ + /**Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.*/ reference_prefix: z .string() .max(5000) @@ -11764,7 +11187,7 @@ export namespace stripe { > export const CheckoutBoletoPaymentMethodOptionsSchema = z.object({ - /** The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time. */ + /**The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time.*/ expires_after_days: z .number() .int() @@ -11792,7 +11215,7 @@ export namespace stripe { > export const CheckoutCardInstallmentsOptionsSchema = z.object({ - /** Indicates if installments are enabled */ + /**Indicates if installments are enabled*/ enabled: z .boolean() .describe('Indicates if installments are enabled') @@ -11804,7 +11227,7 @@ export namespace stripe { export const PaymentPagesPrivateCardPaymentMethodOptionsResourceRestrictionsSchema = z.object({ - /** Specify the card brands to block in the Checkout Session. If a customer enters or selects a card belonging to a blocked brand, they can't complete the Session. */ + /**Specify the card brands to block in the Checkout Session. If a customer enters or selects a card belonging to a blocked brand, they can't complete the Session.*/ brands_blocked: z .array( z.enum([ @@ -11951,7 +11374,7 @@ export namespace stripe { > export const CheckoutKakaoPayPaymentMethodOptionsSchema = z.object({ - /** Controls when the funds will be captured from the customer's account. */ + /**Controls when the funds will be captured from the customer's account.*/ capture_method: z .literal('manual') .describe( @@ -12000,11 +11423,10 @@ export namespace stripe { > export const CheckoutKonbiniPaymentMethodOptionsSchema = z.object({ - /** The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. */ + /**The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST.*/ expires_after_days: z .number() .int() - .nullable() .describe( 'The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST.' ) @@ -12030,7 +11452,7 @@ export namespace stripe { > export const CheckoutKrCardPaymentMethodOptionsSchema = z.object({ - /** Controls when the funds will be captured from the customer's account. */ + /**Controls when the funds will be captured from the customer's account.*/ capture_method: z .literal('manual') .describe( @@ -12121,7 +11543,7 @@ export namespace stripe { > export const CheckoutNaverPayPaymentMethodOptionsSchema = z.object({ - /** Controls when the funds will be captured from the customer's account. */ + /**Controls when the funds will be captured from the customer's account.*/ capture_method: z .literal('manual') .describe( @@ -12134,7 +11556,7 @@ export namespace stripe { > export const CheckoutOxxoPaymentMethodOptionsSchema = z.object({ - /** The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time. */ + /**The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.*/ expires_after_days: z .number() .int() @@ -12183,7 +11605,7 @@ export namespace stripe { > export const CheckoutPaycoPaymentMethodOptionsSchema = z.object({ - /** Controls when the funds will be captured from the customer's account. */ + /**Controls when the funds will be captured from the customer's account.*/ capture_method: z .literal('manual') .describe( @@ -12217,27 +11639,25 @@ export namespace stripe { > export const CheckoutPaypalPaymentMethodOptionsSchema = z.object({ - /** Controls when the funds will be captured from the customer's account. */ + /**Controls when the funds will be captured from the customer's account.*/ capture_method: z .literal('manual') .describe( "Controls when the funds will be captured from the customer's account." ) .optional(), - /** Preferred locale of the PayPal checkout page that the customer is redirected to. */ + /**Preferred locale of the PayPal checkout page that the customer is redirected to.*/ preferred_locale: z .string() .max(5000) - .nullable() .describe( 'Preferred locale of the PayPal checkout page that the customer is redirected to.' ) .optional(), - /** A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID. */ + /**A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.*/ reference: z .string() .max(5000) - .nullable() .describe( "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID." ) @@ -12263,11 +11683,10 @@ export namespace stripe { > export const CheckoutPixPaymentMethodOptionsSchema = z.object({ - /** The number of seconds after which Pix payment will expire. */ + /**The number of seconds after which Pix payment will expire.*/ expires_after_seconds: z .number() .int() - .nullable() .describe('The number of seconds after which Pix payment will expire.') .optional() }) @@ -12297,7 +11716,7 @@ export namespace stripe { > export const CheckoutSamsungPayPaymentMethodOptionsSchema = z.object({ - /** Controls when the funds will be captured from the customer's account. */ + /**Controls when the funds will be captured from the customer's account.*/ capture_method: z .literal('manual') .describe( @@ -12311,7 +11730,7 @@ export namespace stripe { export const CheckoutPaymentMethodOptionsMandateOptionsSepaDebitSchema = z.object({ - /** Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'. */ + /**Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.*/ reference_prefix: z .string() .max(5000) @@ -12346,11 +11765,10 @@ export namespace stripe { > export const CheckoutSwishPaymentMethodOptionsSchema = z.object({ - /** The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent. */ + /**The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent.*/ reference: z .string() .max(5000) - .nullable() .describe( 'The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent.' ) @@ -12362,7 +11780,7 @@ export namespace stripe { export const PaymentPagesCheckoutSessionPhoneNumberCollectionSchema = z.object({ - /** Indicates whether phone number collection is enabled for the session */ + /**Indicates whether phone number collection is enabled for the session*/ enabled: z .boolean() .describe( @@ -12375,26 +11793,23 @@ export namespace stripe { export const PaymentPagesCheckoutSessionSavedPaymentMethodOptionsSchema = z.object({ - /** Uses the `allow_redisplay` value of each saved payment method to filter the set presented to a returning customer. By default, only saved payment methods with ’allow_redisplay: ‘always’ are shown in Checkout. */ + /**Uses the `allow_redisplay` value of each saved payment method to filter the set presented to a returning customer. By default, only saved payment methods with ’allow_redisplay: ‘always’ are shown in Checkout.*/ allow_redisplay_filters: z .array(z.enum(['always', 'limited', 'unspecified'])) - .nullable() .describe( 'Uses the `allow_redisplay` value of each saved payment method to filter the set presented to a returning customer. By default, only saved payment methods with ’allow_redisplay: ‘always’ are shown in Checkout.' ) .optional(), - /** Enable customers to choose if they wish to remove their saved payment methods. Disabled by default. */ + /**Enable customers to choose if they wish to remove their saved payment methods. Disabled by default.*/ payment_method_remove: z .enum(['disabled', 'enabled']) - .nullable() .describe( 'Enable customers to choose if they wish to remove their saved payment methods. Disabled by default.' ) .optional(), - /** Enable customers to choose if they wish to save their payment method for future use. Disabled by default. */ + /**Enable customers to choose if they wish to save their payment method for future use. Disabled by default.*/ payment_method_save: z .enum(['disabled', 'enabled']) - .nullable() .describe( 'Enable customers to choose if they wish to save their payment method for future use. Disabled by default.' ) @@ -12662,13 +12077,13 @@ export namespace stripe { > export const PaymentPagesCheckoutSessionTaxIdCollectionSchema = z.object({ - /** Indicates whether tax ID collection is enabled for the session */ + /**Indicates whether tax ID collection is enabled for the session*/ enabled: z .boolean() .describe( 'Indicates whether tax ID collection is enabled for the session' ), - /** Indicates whether a tax ID is required on the payment page */ + /**Indicates whether a tax ID is required on the payment page*/ required: z .enum(['if_supported', 'never']) .describe('Indicates whether a tax ID is required on the payment page') @@ -12678,7 +12093,7 @@ export namespace stripe { > export const ClimateRemovalsBeneficiarySchema = z.object({ - /** Publicly displayable name for the end beneficiary of carbon removal. */ + /**Publicly displayable name for the end beneficiary of carbon removal.*/ public_name: z .string() .max(5000) @@ -12691,37 +12106,33 @@ export namespace stripe { > export const ClimateRemovalsLocationSchema = z.object({ - /** The city where the supplier is located. */ + /**The city where the supplier is located.*/ city: z .string() .max(5000) - .nullable() .describe('The city where the supplier is located.') .optional(), - /** Two-letter ISO code representing the country where the supplier is located. */ + /**Two-letter ISO code representing the country where the supplier is located.*/ country: z .string() .max(5000) .describe( 'Two-letter ISO code representing the country where the supplier is located.' ), - /** The geographic latitude where the supplier is located. */ + /**The geographic latitude where the supplier is located.*/ latitude: z .number() - .nullable() .describe('The geographic latitude where the supplier is located.') .optional(), - /** The geographic longitude where the supplier is located. */ + /**The geographic longitude where the supplier is located.*/ longitude: z .number() - .nullable() .describe('The geographic longitude where the supplier is located.') .optional(), - /** The state/county/province/region where the supplier is located. */ + /**The state/county/province/region where the supplier is located.*/ region: z .string() .max(5000) - .nullable() .describe( 'The state/county/province/region where the supplier is located.' ) @@ -12732,21 +12143,21 @@ export namespace stripe { > export const ClimateRemovalsProductsPriceSchema = z.object({ - /** Fees for one metric ton of carbon removal in the currency's smallest unit. */ + /**Fees for one metric ton of carbon removal in the currency's smallest unit.*/ amount_fees: z .number() .int() .describe( "Fees for one metric ton of carbon removal in the currency's smallest unit." ), - /** Subtotal for one metric ton of carbon removal (excluding fees) in the currency's smallest unit. */ + /**Subtotal for one metric ton of carbon removal (excluding fees) in the currency's smallest unit.*/ amount_subtotal: z .number() .int() .describe( "Subtotal for one metric ton of carbon removal (excluding fees) in the currency's smallest unit." ), - /** Total for one metric ton of carbon removal (including fees) in the currency's smallest unit. */ + /**Total for one metric ton of carbon removal (including fees) in the currency's smallest unit.*/ amount_total: z .number() .int() @@ -12758,24 +12169,22 @@ export namespace stripe { typeof ClimateRemovalsProductsPriceSchema > - /** This hash contains details about the online acceptance. */ + /**This hash contains details about the online acceptance.*/ export const ConfirmationTokensResourceMandateDataResourceCustomerAcceptanceResourceOnlineSchema = z .object({ - /** The IP address from which the Mandate was accepted by the customer. */ + /**The IP address from which the Mandate was accepted by the customer.*/ ip_address: z .string() .max(5000) - .nullable() .describe( 'The IP address from which the Mandate was accepted by the customer.' ) .optional(), - /** The user agent of the browser from which the Mandate was accepted by the customer. */ + /**The user agent of the browser from which the Mandate was accepted by the customer.*/ user_agent: z .string() .max(5000) - .nullable() .describe( 'The user agent of the browser from which the Mandate was accepted by the customer.' ) @@ -12787,15 +12196,14 @@ export namespace stripe { typeof ConfirmationTokensResourceMandateDataResourceCustomerAcceptanceResourceOnlineSchema > - /** This hash contains the card payment method options. */ + /**This hash contains the card payment method options.*/ export const ConfirmationTokensResourcePaymentMethodOptionsResourceCardSchema = z .object({ - /** The `cvc_update` Token collected from the Payment Element. */ + /**The `cvc_update` Token collected from the Payment Element.*/ cvc_token: z .string() .max(5000) - .nullable() .describe( 'The `cvc_update` Token collected from the Payment Element.' ) @@ -12808,11 +12216,11 @@ export namespace stripe { > export const CountrySpecVerificationFieldDetailsSchema = z.object({ - /** Additional fields which are only required for some users. */ + /**Additional fields which are only required for some users.*/ additional: z .array(z.string().max(5000)) .describe('Additional fields which are only required for some users.'), - /** Fields which every account must eventually provide. */ + /**Fields which every account must eventually provide.*/ minimum: z .array(z.string().max(5000)) .describe('Fields which every account must eventually provide.') @@ -12821,10 +12229,10 @@ export namespace stripe { typeof CountrySpecVerificationFieldDetailsSchema > - /** This hash contains whether the buy button is enabled. */ + /**This hash contains whether the buy button is enabled.*/ export const CustomerSessionResourceComponentsResourceBuyButtonSchema = z .object({ - /** Whether the buy button is enabled. */ + /**Whether the buy button is enabled.*/ enabled: z.boolean().describe('Whether the buy button is enabled.') }) .describe('This hash contains whether the buy button is enabled.') @@ -12832,7 +12240,7 @@ export namespace stripe { typeof CustomerSessionResourceComponentsResourceBuyButtonSchema > - /** This hash contains the features the Payment Element supports. */ + /**This hash contains the features the Payment Element supports.*/ export const CustomerSessionResourceComponentsResourcePaymentElementResourceFeaturesSchema = z .object({ @@ -12846,17 +12254,16 @@ export namespace stripe { .describe( 'A list of [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) values that controls which saved payment methods the Payment Element displays by filtering to only show payment methods with an `allow_redisplay` value that is present in this list.\n\nIf not specified, defaults to ["always"]. In order to display all saved payment methods, specify ["always", "limited", "unspecified"].' ), - /** Controls whether or not the Payment Element shows saved payment methods. This parameter defaults to `disabled`. */ + /**Controls whether or not the Payment Element shows saved payment methods. This parameter defaults to `disabled`.*/ payment_method_redisplay: z .enum(['disabled', 'enabled']) .describe( 'Controls whether or not the Payment Element shows saved payment methods. This parameter defaults to `disabled`.' ), - /** Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `3`. */ + /**Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `3`.*/ payment_method_redisplay_limit: z .number() .int() - .nullable() .describe( 'Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `3`.' ) @@ -12888,7 +12295,6 @@ export namespace stripe { */ payment_method_save_usage: z .enum(['off_session', 'on_session']) - .nullable() .describe( 'When using PaymentIntents and the customer checks the save checkbox, this field determines the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value used to confirm the PaymentIntent.\n\nWhen using SetupIntents, directly configure the [`usage`](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-usage) value on SetupIntent creation.' ) @@ -12900,10 +12306,10 @@ export namespace stripe { typeof CustomerSessionResourceComponentsResourcePaymentElementResourceFeaturesSchema > - /** This hash contains whether the pricing table is enabled. */ + /**This hash contains whether the pricing table is enabled.*/ export const CustomerSessionResourceComponentsResourcePricingTableSchema = z .object({ - /** Whether the pricing table is enabled. */ + /**Whether the pricing table is enabled.*/ enabled: z.boolean().describe('Whether the pricing table is enabled.') }) .describe('This hash contains whether the pricing table is enabled.') @@ -12917,41 +12323,41 @@ export namespace stripe { */ export const EntitlementsFeatureSchema = z .object({ - /** Inactive features cannot be attached to new products and will not be returned from the features list endpoint. */ + /**Inactive features cannot be attached to new products and will not be returned from the features list endpoint.*/ active: z .boolean() .describe( 'Inactive features cannot be attached to new products and will not be returned from the features list endpoint.' ), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** A unique key you provide as your own system identifier. This may be up to 80 characters. */ + /**A unique key you provide as your own system identifier. This may be up to 80 characters.*/ lookup_key: z .string() .max(5000) .describe( 'A unique key you provide as your own system identifier. This may be up to 80 characters.' ), - /** Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ), - /** The feature's name, for your own purpose, not meant to be displayable to the customer. */ + /**The feature's name, for your own purpose, not meant to be displayable to the customer.*/ name: z .string() .max(80) .describe( "The feature's name, for your own purpose, not meant to be displayable to the customer." ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('entitlements.feature') .describe( @@ -12964,35 +12370,35 @@ export namespace stripe { export type EntitlementsFeature = z.infer export const EphemeralKeySchema = z.object({ - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Time at which the key will expire. Measured in seconds since the Unix epoch. */ + /**Time at which the key will expire. Measured in seconds since the Unix epoch.*/ expires: z .number() .int() .describe( 'Time at which the key will expire. Measured in seconds since the Unix epoch.' ), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('ephemeral_key') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The key's secret. You can use this value to make authorized requests to the Stripe API. */ + /**The key's secret. You can use this value to make authorized requests to the Stripe API.*/ secret: z .string() .max(5000) @@ -13004,13 +12410,13 @@ export namespace stripe { export type EphemeralKey = z.infer export const NotificationEventDataSchema = z.object({ - /** Object containing the API resource relevant to the event. For example, an `invoice.created` event will have a full [invoice object](https://stripe.com/docs/api#invoice_object) as the value of the object key. */ + /**Object containing the API resource relevant to the event. For example, an `invoice.created` event will have a full [invoice object](https://stripe.com/docs/api#invoice_object) as the value of the object key.*/ object: z .record(z.any()) .describe( 'Object containing the API resource relevant to the event. For example, an `invoice.created` event will have a full [invoice object](https://stripe.com/docs/api#invoice_object) as the value of the object key.' ), - /** Object containing the names of the updated attributes and their values prior to the event (only included in events of type `*.updated`). If an array attribute has any updated elements, this object contains the entire array. In Stripe API versions 2017-04-06 or earlier, an updated array attribute in this object includes only the updated array elements. */ + /**Object containing the names of the updated attributes and their values prior to the event (only included in events of type `*.updated`). If an array attribute has any updated elements, this object contains the entire array. In Stripe API versions 2017-04-06 or earlier, an updated array attribute in this object includes only the updated array elements.*/ previous_attributes: z .record(z.any()) .describe( @@ -13023,20 +12429,18 @@ export namespace stripe { > export const NotificationEventRequestSchema = z.object({ - /** ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe's automatic subscription handling). Request logs are available in the [dashboard](https://dashboard.stripe.com/logs), but currently not in the API. */ + /**ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe's automatic subscription handling). Request logs are available in the [dashboard](https://dashboard.stripe.com/logs), but currently not in the API.*/ id: z .string() .max(5000) - .nullable() .describe( "ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe's automatic subscription handling). Request logs are available in the [dashboard](https://dashboard.stripe.com/logs), but currently not in the API." ) .optional(), - /** The idempotency key transmitted during the request, if any. *Note: This property is populated only for events on or after May 23, 2017*. */ + /**The idempotency key transmitted during the request, if any. *Note: This property is populated only for events on or after May 23, 2017*.*/ idempotency_key: z .string() .max(5000) - .nullable() .describe( 'The idempotency key transmitted during the request, if any. *Note: This property is populated only for events on or after May 23, 2017*.' ) @@ -13076,20 +12480,20 @@ export namespace stripe { */ export const ExchangeRateSchema = z .object({ - /** Unique identifier for the object. Represented as the three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. */ + /**Unique identifier for the object. Represented as the three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) in lowercase.*/ id: z .string() .max(5000) .describe( 'Unique identifier for the object. Represented as the three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) in lowercase.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('exchange_rate') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** Hash where the keys are supported currencies and the values are the exchange rate at which the base id currency converts to the key currency. */ + /**Hash where the keys are supported currencies and the values are the exchange rate at which the base id currency converts to the key currency.*/ rates: z .record(z.number()) .describe( @@ -13112,7 +12516,6 @@ export namespace stripe { */ available: z .record(z.number().int()) - .nullable() .describe( 'The funds available to the account holder. Typically this is the current balance after subtracting any outbound pending transactions and adding any inbound pending transactions.\n\nEach key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.\n\nEach value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.' ) @@ -13133,7 +12536,6 @@ export namespace stripe { */ used: z .record(z.number().int()) - .nullable() .describe( 'The credit that has been used by the account holder.\n\nEach key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.\n\nEach value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.' ) @@ -13144,23 +12546,22 @@ export namespace stripe { > export const BankConnectionsResourceBalanceRefreshSchema = z.object({ - /** The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch. */ + /**The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.*/ last_attempted_at: z .number() .int() .describe( 'The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.' ), - /** Time at which the next balance refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch. */ + /**Time at which the next balance refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch.*/ next_refresh_available_at: z .number() .int() - .nullable() .describe( 'Time at which the next balance refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch.' ) .optional(), - /** The status of the last refresh attempt. */ + /**The status of the last refresh attempt.*/ status: z .enum(['failed', 'pending', 'succeeded']) .describe('The status of the last refresh attempt.') @@ -13169,50 +12570,46 @@ export namespace stripe { typeof BankConnectionsResourceBalanceRefreshSchema > - /** Describes an owner of an account. */ + /**Describes an owner of an account.*/ export const FinancialConnectionsAccountOwnerSchema = z .object({ - /** The email address of the owner. */ + /**The email address of the owner.*/ email: z .string() .max(5000) - .nullable() .describe('The email address of the owner.') .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** The full name of the owner. */ + /**The full name of the owner.*/ name: z.string().max(5000).describe('The full name of the owner.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('financial_connections.account_owner') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The ownership object that this owner belongs to. */ + /**The ownership object that this owner belongs to.*/ ownership: z .string() .max(5000) .describe('The ownership object that this owner belongs to.'), - /** The raw phone number of the owner. */ + /**The raw phone number of the owner.*/ phone: z .string() .max(5000) - .nullable() .describe('The raw phone number of the owner.') .optional(), - /** The raw physical address of the owner. */ + /**The raw physical address of the owner.*/ raw_address: z .string() .max(5000) - .nullable() .describe('The raw physical address of the owner.') .optional(), - /** The timestamp of the refresh that updated this owner. */ + /**The timestamp of the refresh that updated this owner.*/ refreshed_at: z .number() .int() - .nullable() .describe('The timestamp of the refresh that updated this owner.') .optional() }) @@ -13222,23 +12619,22 @@ export namespace stripe { > export const BankConnectionsResourceOwnershipRefreshSchema = z.object({ - /** The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch. */ + /**The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.*/ last_attempted_at: z .number() .int() .describe( 'The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.' ), - /** Time at which the next ownership refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch. */ + /**Time at which the next ownership refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch.*/ next_refresh_available_at: z .number() .int() - .nullable() .describe( 'Time at which the next ownership refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch.' ) .optional(), - /** The status of the last refresh attempt. */ + /**The status of the last refresh attempt.*/ status: z .enum(['failed', 'pending', 'succeeded']) .describe('The status of the last refresh attempt.') @@ -13248,25 +12644,24 @@ export namespace stripe { > export const BankConnectionsResourceTransactionRefreshSchema = z.object({ - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch. */ + /**The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.*/ last_attempted_at: z .number() .int() .describe( 'The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.' ), - /** Time at which the next transaction refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch. */ + /**Time at which the next transaction refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch.*/ next_refresh_available_at: z .number() .int() - .nullable() .describe( 'Time at which the next transaction refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch.' ) .optional(), - /** The status of the last refresh attempt. */ + /**The status of the last refresh attempt.*/ status: z .enum(['failed', 'pending', 'succeeded']) .describe('The status of the last refresh attempt.') @@ -13277,7 +12672,7 @@ export namespace stripe { export const BankConnectionsResourceLinkAccountSessionFiltersSchema = z.object({ - /** Restricts the Session to subcategories of accounts that can be linked. Valid subcategories are: `checking`, `savings`, `mortgage`, `line_of_credit`, `credit_card`. */ + /**Restricts the Session to subcategories of accounts that can be linked. Valid subcategories are: `checking`, `savings`, `mortgage`, `line_of_credit`, `credit_card`.*/ account_subcategories: z .array( z.enum([ @@ -13288,15 +12683,13 @@ export namespace stripe { 'savings' ]) ) - .nullable() .describe( 'Restricts the Session to subcategories of accounts that can be linked. Valid subcategories are: `checking`, `savings`, `mortgage`, `line_of_credit`, `credit_card`.' ) .optional(), - /** List of countries from which to filter accounts. */ + /**List of countries from which to filter accounts.*/ countries: z .array(z.string().max(5000)) - .nullable() .describe('List of countries from which to filter accounts.') .optional() }) @@ -13306,20 +12699,18 @@ export namespace stripe { export const BankConnectionsResourceTransactionResourceStatusTransitionsSchema = z.object({ - /** Time at which this transaction posted. Measured in seconds since the Unix epoch. */ + /**Time at which this transaction posted. Measured in seconds since the Unix epoch.*/ posted_at: z .number() .int() - .nullable() .describe( 'Time at which this transaction posted. Measured in seconds since the Unix epoch.' ) .optional(), - /** Time at which this transaction was voided. Measured in seconds since the Unix epoch. */ + /**Time at which this transaction was voided. Measured in seconds since the Unix epoch.*/ void_at: z .number() .int() - .nullable() .describe( 'Time at which this transaction was voided. Measured in seconds since the Unix epoch.' ) @@ -13330,17 +12721,17 @@ export namespace stripe { typeof BankConnectionsResourceTransactionResourceStatusTransitionsSchema > - /** Metadata about the forwarded request. */ + /**Metadata about the forwarded request.*/ export const ForwardedRequestContextSchema = z .object({ - /** The time it took in milliseconds for the destination endpoint to respond. */ + /**The time it took in milliseconds for the destination endpoint to respond.*/ destination_duration: z .number() .int() .describe( 'The time it took in milliseconds for the destination endpoint to respond.' ), - /** The IP address of the destination. */ + /**The IP address of the destination.*/ destination_ip_address: z .string() .max(5000) @@ -13351,12 +12742,12 @@ export namespace stripe { typeof ForwardedRequestContextSchema > - /** Header data. */ + /**Header data.*/ export const ForwardedRequestHeaderSchema = z .object({ - /** The header name. */ + /**The header name.*/ name: z.string().max(5000).describe('The header name.'), - /** The header value. */ + /**The header value.*/ value: z.string().max(5000).describe('The header value.') }) .describe('Header data.') @@ -13364,30 +12755,23 @@ export namespace stripe { typeof ForwardedRequestHeaderSchema > - /** Point in Time */ + /**Point in Time*/ export const GelatoDataDocumentReportDateOfBirthSchema = z .object({ - /** Numerical day between 1 and 31. */ + /**Numerical day between 1 and 31.*/ day: z .number() .int() - .nullable() .describe('Numerical day between 1 and 31.') .optional(), - /** Numerical month between 1 and 12. */ + /**Numerical month between 1 and 12.*/ month: z .number() .int() - .nullable() .describe('Numerical month between 1 and 12.') .optional(), - /** The four-digit year. */ - year: z - .number() - .int() - .nullable() - .describe('The four-digit year.') - .optional() + /**The four-digit year.*/ + year: z.number().int().describe('The four-digit year.').optional() }) .describe('Point in Time') export type GelatoDataDocumentReportDateOfBirth = z.infer< @@ -13395,23 +12779,21 @@ export namespace stripe { > export const GelatoDocumentReportErrorSchema = z.object({ - /** A short machine-readable string giving the reason for the verification failure. */ + /**A short machine-readable string giving the reason for the verification failure.*/ code: z .enum([ 'document_expired', 'document_type_not_supported', 'document_unverified_other' ]) - .nullable() .describe( 'A short machine-readable string giving the reason for the verification failure.' ) .optional(), - /** A human-readable message giving the reason for the failure. These messages can be shown to your users. */ + /**A human-readable message giving the reason for the failure. These messages can be shown to your users.*/ reason: z .string() .max(5000) - .nullable() .describe( 'A human-readable message giving the reason for the failure. These messages can be shown to your users.' ) @@ -13421,60 +12803,46 @@ export namespace stripe { typeof GelatoDocumentReportErrorSchema > - /** Point in Time */ + /**Point in Time*/ export const GelatoDataDocumentReportExpirationDateSchema = z .object({ - /** Numerical day between 1 and 31. */ + /**Numerical day between 1 and 31.*/ day: z .number() .int() - .nullable() .describe('Numerical day between 1 and 31.') .optional(), - /** Numerical month between 1 and 12. */ + /**Numerical month between 1 and 12.*/ month: z .number() .int() - .nullable() .describe('Numerical month between 1 and 12.') .optional(), - /** The four-digit year. */ - year: z - .number() - .int() - .nullable() - .describe('The four-digit year.') - .optional() + /**The four-digit year.*/ + year: z.number().int().describe('The four-digit year.').optional() }) .describe('Point in Time') export type GelatoDataDocumentReportExpirationDate = z.infer< typeof GelatoDataDocumentReportExpirationDateSchema > - /** Point in Time */ + /**Point in Time*/ export const GelatoDataDocumentReportIssuedDateSchema = z .object({ - /** Numerical day between 1 and 31. */ + /**Numerical day between 1 and 31.*/ day: z .number() .int() - .nullable() .describe('Numerical day between 1 and 31.') .optional(), - /** Numerical month between 1 and 12. */ + /**Numerical month between 1 and 12.*/ month: z .number() .int() - .nullable() .describe('Numerical month between 1 and 12.') .optional(), - /** The four-digit year. */ - year: z - .number() - .int() - .nullable() - .describe('The four-digit year.') - .optional() + /**The four-digit year.*/ + year: z.number().int().describe('The four-digit year.').optional() }) .describe('Point in Time') export type GelatoDataDocumentReportIssuedDate = z.infer< @@ -13482,19 +12850,17 @@ export namespace stripe { > export const GelatoEmailReportErrorSchema = z.object({ - /** A short machine-readable string giving the reason for the verification failure. */ + /**A short machine-readable string giving the reason for the verification failure.*/ code: z .enum(['email_unverified_other', 'email_verification_declined']) - .nullable() .describe( 'A short machine-readable string giving the reason for the verification failure.' ) .optional(), - /** A human-readable message giving the reason for the failure. These messages can be shown to your users. */ + /**A human-readable message giving the reason for the failure. These messages can be shown to your users.*/ reason: z .string() .max(5000) - .nullable() .describe( 'A human-readable message giving the reason for the failure. These messages can be shown to your users.' ) @@ -13504,30 +12870,23 @@ export namespace stripe { typeof GelatoEmailReportErrorSchema > - /** Point in Time */ + /**Point in Time*/ export const GelatoDataIdNumberReportDateSchema = z .object({ - /** Numerical day between 1 and 31. */ + /**Numerical day between 1 and 31.*/ day: z .number() .int() - .nullable() .describe('Numerical day between 1 and 31.') .optional(), - /** Numerical month between 1 and 12. */ + /**Numerical month between 1 and 12.*/ month: z .number() .int() - .nullable() .describe('Numerical month between 1 and 12.') .optional(), - /** The four-digit year. */ - year: z - .number() - .int() - .nullable() - .describe('The four-digit year.') - .optional() + /**The four-digit year.*/ + year: z.number().int().describe('The four-digit year.').optional() }) .describe('Point in Time') export type GelatoDataIdNumberReportDate = z.infer< @@ -13535,23 +12894,21 @@ export namespace stripe { > export const GelatoIdNumberReportErrorSchema = z.object({ - /** A short machine-readable string giving the reason for the verification failure. */ + /**A short machine-readable string giving the reason for the verification failure.*/ code: z .enum([ 'id_number_insufficient_document_data', 'id_number_mismatch', 'id_number_unverified_other' ]) - .nullable() .describe( 'A short machine-readable string giving the reason for the verification failure.' ) .optional(), - /** A human-readable message giving the reason for the failure. These messages can be shown to your users. */ + /**A human-readable message giving the reason for the failure. These messages can be shown to your users.*/ reason: z .string() .max(5000) - .nullable() .describe( 'A human-readable message giving the reason for the failure. These messages can be shown to your users.' ) @@ -13562,28 +12919,28 @@ export namespace stripe { > export const GelatoReportDocumentOptionsSchema = z.object({ - /** Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code. */ + /**Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.*/ allowed_types: z .array(z.enum(['driving_license', 'id_card', 'passport'])) .describe( 'Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.' ) .optional(), - /** Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth. */ + /**Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.*/ require_id_number: z .boolean() .describe( 'Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.' ) .optional(), - /** Disable image uploads, identity document images have to be captured using the device’s camera. */ + /**Disable image uploads, identity document images have to be captured using the device’s camera.*/ require_live_capture: z .boolean() .describe( 'Disable image uploads, identity document images have to be captured using the device’s camera.' ) .optional(), - /** Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie). */ + /**Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie).*/ require_matching_selfie: z .boolean() .describe( @@ -13601,19 +12958,17 @@ export namespace stripe { > export const GelatoPhoneReportErrorSchema = z.object({ - /** A short machine-readable string giving the reason for the verification failure. */ + /**A short machine-readable string giving the reason for the verification failure.*/ code: z .enum(['phone_unverified_other', 'phone_verification_declined']) - .nullable() .describe( 'A short machine-readable string giving the reason for the verification failure.' ) .optional(), - /** A human-readable message giving the reason for the failure. These messages can be shown to your users. */ + /**A human-readable message giving the reason for the failure. These messages can be shown to your users.*/ reason: z .string() .max(5000) - .nullable() .describe( 'A human-readable message giving the reason for the failure. These messages can be shown to your users.' ) @@ -13624,7 +12979,7 @@ export namespace stripe { > export const GelatoSelfieReportErrorSchema = z.object({ - /** A short machine-readable string giving the reason for the verification failure. */ + /**A short machine-readable string giving the reason for the verification failure.*/ code: z .enum([ 'selfie_document_missing_photo', @@ -13632,16 +12987,14 @@ export namespace stripe { 'selfie_manipulated', 'selfie_unverified_other' ]) - .nullable() .describe( 'A short machine-readable string giving the reason for the verification failure.' ) .optional(), - /** A human-readable message giving the reason for the failure. These messages can be shown to your users. */ + /**A human-readable message giving the reason for the failure. These messages can be shown to your users.*/ reason: z .string() .max(5000) - .nullable() .describe( 'A human-readable message giving the reason for the failure. These messages can be shown to your users.' ) @@ -13651,10 +13004,10 @@ export namespace stripe { typeof GelatoSelfieReportErrorSchema > - /** Shows last VerificationSession error */ + /**Shows last VerificationSession error*/ export const GelatoSessionLastErrorSchema = z .object({ - /** A short machine-readable string giving the reason for the verification or user-session failure. */ + /**A short machine-readable string giving the reason for the verification or user-session failure.*/ code: z .enum([ 'abandoned', @@ -13677,16 +13030,14 @@ export namespace stripe { 'selfie_unverified_other', 'under_supported_age' ]) - .nullable() .describe( 'A short machine-readable string giving the reason for the verification or user-session failure.' ) .optional(), - /** A message that explains the reason for verification or user-session failure. */ + /**A message that explains the reason for verification or user-session failure.*/ reason: z .string() .max(5000) - .nullable() .describe( 'A message that explains the reason for verification or user-session failure.' ) @@ -13698,28 +13049,28 @@ export namespace stripe { > export const GelatoSessionDocumentOptionsSchema = z.object({ - /** Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code. */ + /**Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.*/ allowed_types: z .array(z.enum(['driving_license', 'id_card', 'passport'])) .describe( 'Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code.' ) .optional(), - /** Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth. */ + /**Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.*/ require_id_number: z .boolean() .describe( 'Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth.' ) .optional(), - /** Disable image uploads, identity document images have to be captured using the device’s camera. */ + /**Disable image uploads, identity document images have to be captured using the device’s camera.*/ require_live_capture: z .boolean() .describe( 'Disable image uploads, identity document images have to be captured using the device’s camera.' ) .optional(), - /** Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie). */ + /**Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie).*/ require_matching_selfie: z .boolean() .describe( @@ -13732,7 +13083,7 @@ export namespace stripe { > export const GelatoSessionEmailOptionsSchema = z.object({ - /** Request one time password verification of `provided_details.email`. */ + /**Request one time password verification of `provided_details.email`.*/ require_verification: z .boolean() .describe( @@ -13750,7 +13101,7 @@ export namespace stripe { > export const GelatoSessionPhoneOptionsSchema = z.object({ - /** Request one time password verification of `provided_details.phone`. */ + /**Request one time password verification of `provided_details.phone`.*/ require_verification: z .boolean() .describe( @@ -13763,13 +13114,13 @@ export namespace stripe { > export const GelatoProvidedDetailsSchema = z.object({ - /** Email of user being verified */ + /**Email of user being verified*/ email: z .string() .max(5000) .describe('Email of user being verified') .optional(), - /** Phone number of user being verified */ + /**Phone number of user being verified*/ phone: z .string() .max(5000) @@ -13781,7 +13132,7 @@ export namespace stripe { > export const VerificationSessionRedactionSchema = z.object({ - /** Indicates whether this object and its related objects have been redacted or not. */ + /**Indicates whether this object and its related objects have been redacted or not.*/ status: z .enum(['processing', 'redacted']) .describe( @@ -13792,30 +13143,23 @@ export namespace stripe { typeof VerificationSessionRedactionSchema > - /** Point in Time */ + /**Point in Time*/ export const GelatoDataVerifiedOutputsDateSchema = z .object({ - /** Numerical day between 1 and 31. */ + /**Numerical day between 1 and 31.*/ day: z .number() .int() - .nullable() .describe('Numerical day between 1 and 31.') .optional(), - /** Numerical month between 1 and 12. */ + /**Numerical month between 1 and 12.*/ month: z .number() .int() - .nullable() .describe('Numerical month between 1 and 12.') .optional(), - /** The four-digit year. */ - year: z - .number() - .int() - .nullable() - .describe('The four-digit year.') - .optional() + /**The four-digit year.*/ + year: z.number().int().describe('The four-digit year.').optional() }) .describe('Point in Time') export type GelatoDataVerifiedOutputsDate = z.infer< @@ -13828,47 +13172,45 @@ export namespace stripe { */ export const InvoiceRenderingTemplateSchema = z .object({ - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) - .nullable() .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ) .optional(), - /** A brief description of the template, hidden from customers */ + /**A brief description of the template, hidden from customers*/ nickname: z .string() .max(5000) - .nullable() .describe('A brief description of the template, hidden from customers') .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('invoice_rendering_template') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The status of the template, one of `active` or `archived`. */ + /**The status of the template, one of `active` or `archived`.*/ status: z .enum(['active', 'archived']) .describe('The status of the template, one of `active` or `archived`.'), - /** Version of this template; version increases by one when an update on the template changes any field that controls invoice rendering */ + /**Version of this template; version increases by one when an update on the template changes any field that controls invoice rendering*/ version: z .number() .int() @@ -13884,11 +13226,11 @@ export namespace stripe { > export const DeletedInvoiceitemSchema = z.object({ - /** Always true for a deleted object */ + /**Always true for a deleted object*/ deleted: z.literal(true).describe('Always true for a deleted object'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('invoiceitem') .describe( @@ -13897,103 +13239,103 @@ export namespace stripe { }) export type DeletedInvoiceitem = z.infer - /** When a non-stripe BIN is used, any use of an [issued card](https://stripe.com/docs/issuing) must be settled directly with the card network. The net amount owed is represented by an Issuing `Settlement` object. */ + /**When a non-stripe BIN is used, any use of an [issued card](https://stripe.com/docs/issuing) must be settled directly with the card network. The net amount owed is represented by an Issuing `Settlement` object.*/ export const IssuingSettlementSchema = z .object({ - /** The Bank Identification Number reflecting this settlement record. */ + /**The Bank Identification Number reflecting this settlement record.*/ bin: z .string() .max(5000) .describe( 'The Bank Identification Number reflecting this settlement record.' ), - /** The date that the transactions are cleared and posted to user's accounts. */ + /**The date that the transactions are cleared and posted to user's accounts.*/ clearing_date: z .number() .int() .describe( "The date that the transactions are cleared and posted to user's accounts." ), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** The total interchange received as reimbursement for the transactions. */ + /**The total interchange received as reimbursement for the transactions.*/ interchange_fees: z .number() .int() .describe( 'The total interchange received as reimbursement for the transactions.' ), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ), - /** The total net amount required to settle with the network. */ + /**The total net amount required to settle with the network.*/ net_total: z .number() .int() .describe('The total net amount required to settle with the network.'), - /** The card network for this settlement report. One of ["visa", "maestro"] */ + /**The card network for this settlement report. One of ["visa", "maestro"]*/ network: z .enum(['maestro', 'visa']) .describe( 'The card network for this settlement report. One of ["visa", "maestro"]' ), - /** The total amount of fees owed to the network. */ + /**The total amount of fees owed to the network.*/ network_fees: z .number() .int() .describe('The total amount of fees owed to the network.'), - /** The Settlement Identification Number assigned by the network. */ + /**The Settlement Identification Number assigned by the network.*/ network_settlement_identifier: z .string() .max(5000) .describe( 'The Settlement Identification Number assigned by the network.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('issuing.settlement') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** One of `international` or `uk_national_net`. */ + /**One of `international` or `uk_national_net`.*/ settlement_service: z .string() .max(5000) .describe('One of `international` or `uk_national_net`.'), - /** The current processing status of this settlement. */ + /**The current processing status of this settlement.*/ status: z .enum(['complete', 'pending']) .describe('The current processing status of this settlement.'), - /** The total number of transactions reflected in this settlement. */ + /**The total number of transactions reflected in this settlement.*/ transaction_count: z .number() .int() .describe( 'The total number of transactions reflected in this settlement.' ), - /** The total transaction amount reflected in this settlement. */ + /**The total transaction amount reflected in this settlement.*/ transaction_volume: z .number() .int() @@ -14005,19 +13347,18 @@ export namespace stripe { export type IssuingSettlement = z.infer export const PaymentMethodConfigResourceDisplayPreferenceSchema = z.object({ - /** For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used. */ + /**For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.*/ overridable: z .boolean() - .nullable() .describe( "For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used." ) .optional(), - /** The account's display preference. */ + /**The account's display preference.*/ preference: z .enum(['none', 'off', 'on']) .describe("The account's display preference."), - /** The effective display preference value. */ + /**The effective display preference value.*/ value: z .enum(['off', 'on']) .describe('The effective display preference value.') @@ -14026,10 +13367,10 @@ export namespace stripe { typeof PaymentMethodConfigResourceDisplayPreferenceSchema > - /** Contains additional details about the status of a payment method for a specific payment method domain. */ + /**Contains additional details about the status of a payment method for a specific payment method domain.*/ export const PaymentMethodDomainResourcePaymentMethodStatusDetailsSchema = z .object({ - /** The error message associated with the status of the payment method on the domain. */ + /**The error message associated with the status of the payment method on the domain.*/ error_message: z .string() .max(5000) @@ -14045,41 +13386,36 @@ export namespace stripe { > export const PlanTierSchema = z.object({ - /** Price for the entire tier. */ + /**Price for the entire tier.*/ flat_amount: z .number() .int() - .nullable() .describe('Price for the entire tier.') .optional(), - /** Same as `flat_amount`, but contains a decimal value with at most 12 decimal places. */ + /**Same as `flat_amount`, but contains a decimal value with at most 12 decimal places.*/ flat_amount_decimal: z .string() - .nullable() .describe( 'Same as `flat_amount`, but contains a decimal value with at most 12 decimal places.' ) .optional(), - /** Per unit price for units relevant to the tier. */ + /**Per unit price for units relevant to the tier.*/ unit_amount: z .number() .int() - .nullable() .describe('Per unit price for units relevant to the tier.') .optional(), - /** Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. */ + /**Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.*/ unit_amount_decimal: z .string() - .nullable() .describe( 'Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.' ) .optional(), - /** Up to and including to this quantity will be contained in the tier. */ + /**Up to and including to this quantity will be contained in the tier.*/ up_to: z .number() .int() - .nullable() .describe( 'Up to and including to this quantity will be contained in the tier.' ) @@ -14088,9 +13424,9 @@ export namespace stripe { export type PlanTier = z.infer export const TransformUsageSchema = z.object({ - /** Divide usage by this number. */ + /**Divide usage by this number.*/ divide_by: z.number().int().describe('Divide usage by this number.'), - /** After division, either round the result `up` or `down`. */ + /**After division, either round the result `up` or `down`.*/ round: z .enum(['down', 'up']) .describe('After division, either round the result `up` or `down`.') @@ -14098,11 +13434,11 @@ export namespace stripe { export type TransformUsage = z.infer export const DeletedPlanSchema = z.object({ - /** Always true for a deleted object */ + /**Always true for a deleted object*/ deleted: z.literal(true).describe('Always true for a deleted object'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('plan') .describe( @@ -14112,11 +13448,11 @@ export namespace stripe { export type DeletedPlan = z.infer export const DeletedProductFeatureSchema = z.object({ - /** Always true for a deleted object */ + /**Always true for a deleted object*/ deleted: z.literal(true).describe('Always true for a deleted object'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('product_feature') .describe( @@ -14134,37 +13470,37 @@ export namespace stripe { */ export const RadarValueListItemSchema = z .object({ - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** The name or email address of the user who added this item to the value list. */ + /**The name or email address of the user who added this item to the value list.*/ created_by: z .string() .max(5000) .describe( 'The name or email address of the user who added this item to the value list.' ), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('radar.value_list_item') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The value of the item. */ + /**The value of the item.*/ value: z.string().max(5000).describe('The value of the item.'), - /** The identifier of the value list this item belongs to. */ + /**The identifier of the value list this item belongs to.*/ value_list: z .string() .max(5000) @@ -14176,11 +13512,11 @@ export namespace stripe { export type RadarValueListItem = z.infer export const DeletedRadarValueListItemSchema = z.object({ - /** Always true for a deleted object */ + /**Always true for a deleted object*/ deleted: z.literal(true).describe('Always true for a deleted object'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('radar.value_list_item') .describe( @@ -14192,11 +13528,11 @@ export namespace stripe { > export const DeletedRadarValueListSchema = z.object({ - /** Always true for a deleted object */ + /**Always true for a deleted object*/ deleted: z.literal(true).describe('Always true for a deleted object'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('radar.value_list') .describe( @@ -14209,25 +13545,25 @@ export namespace stripe { export const FinancialReportingFinanceReportRunRunParametersSchema = z.object( { - /** The set of output columns requested for inclusion in the report run. */ + /**The set of output columns requested for inclusion in the report run.*/ columns: z .array(z.string().max(5000)) .describe( 'The set of output columns requested for inclusion in the report run.' ) .optional(), - /** Connected account ID by which to filter the report run. */ + /**Connected account ID by which to filter the report run.*/ connected_account: z .string() .max(5000) .describe('Connected account ID by which to filter the report run.') .optional(), - /** Currency of objects to be included in the report run. */ + /**Currency of objects to be included in the report run.*/ currency: z .string() .describe('Currency of objects to be included in the report run.') .optional(), - /** Ending timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after the user specified `interval_start` and 1 second before this report's last `data_available_end` value. */ + /**Ending timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after the user specified `interval_start` and 1 second before this report's last `data_available_end` value.*/ interval_end: z .number() .int() @@ -14235,7 +13571,7 @@ export namespace stripe { "Ending timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after the user specified `interval_start` and 1 second before this report's last `data_available_end` value." ) .optional(), - /** Starting timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after this report's `data_available_start` and 1 second before the user specified `interval_end` value. */ + /**Starting timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after this report's `data_available_start` and 1 second before the user specified `interval_end` value.*/ interval_start: z .number() .int() @@ -14243,13 +13579,13 @@ export namespace stripe { "Starting timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after this report's `data_available_start` and 1 second before the user specified `interval_end` value." ) .optional(), - /** Payout ID by which to filter the report run. */ + /**Payout ID by which to filter the report run.*/ payout: z .string() .max(5000) .describe('Payout ID by which to filter the report run.') .optional(), - /** Category of balance transactions to be included in the report run. */ + /**Category of balance transactions to be included in the report run.*/ reporting_category: z .string() .max(5000) @@ -14257,7 +13593,7 @@ export namespace stripe { 'Category of balance transactions to be included in the report run.' ) .optional(), - /** Defaults to `Etc/UTC`. The output timezone for all timestamps in the report. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones). Has no effect on `interval_start` or `interval_end`. */ + /**Defaults to `Etc/UTC`. The output timezone for all timestamps in the report. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones). Has no effect on `interval_start` or `interval_end`.*/ timezone: z .string() .max(5000) @@ -14283,60 +13619,59 @@ export namespace stripe { */ export const ReportingReportTypeSchema = z .object({ - /** Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch. */ + /**Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch.*/ data_available_end: z .number() .int() .describe( 'Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch.' ), - /** Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch. */ + /**Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch.*/ data_available_start: z .number() .int() .describe( 'Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch.' ), - /** List of column names that are included by default when this Report Type gets run. (If the Report Type doesn't support the `columns` parameter, this will be null.) */ + /**List of column names that are included by default when this Report Type gets run. (If the Report Type doesn't support the `columns` parameter, this will be null.)*/ default_columns: z .array(z.string().max(5000)) - .nullable() .describe( "List of column names that are included by default when this Report Type gets run. (If the Report Type doesn't support the `columns` parameter, this will be null.)" ) .optional(), - /** The [ID of the Report Type](https://stripe.com/docs/reporting/statements/api#available-report-types), such as `balance.summary.1`. */ + /**The [ID of the Report Type](https://stripe.com/docs/reporting/statements/api#available-report-types), such as `balance.summary.1`.*/ id: z .string() .max(5000) .describe( 'The [ID of the Report Type](https://stripe.com/docs/reporting/statements/api#available-report-types), such as `balance.summary.1`.' ), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Human-readable name of the Report Type */ + /**Human-readable name of the Report Type*/ name: z .string() .max(5000) .describe('Human-readable name of the Report Type'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('reporting.report_type') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** When this Report Type was latest updated. Measured in seconds since the Unix epoch. */ + /**When this Report Type was latest updated. Measured in seconds since the Unix epoch.*/ updated: z .number() .int() .describe( 'When this Report Type was latest updated. Measured in seconds since the Unix epoch.' ), - /** Version of the Report Type. Different versions report with the same ID will have the same purpose, but may take different run parameters or have different result schemas. */ + /**Version of the Report Type. Different versions report with the same ID will have the same purpose, but may take different run parameters or have different result schemas.*/ version: z .number() .int() @@ -14350,7 +13685,7 @@ export namespace stripe { export type ReportingReportType = z.infer export const SigmaScheduledQueryRunErrorSchema = z.object({ - /** Information about the run failure. */ + /**Information about the run failure.*/ message: z.string().max(5000).describe('Information about the run failure.') }) export type SigmaScheduledQueryRunError = z.infer< @@ -14358,7 +13693,7 @@ export namespace stripe { > export const SourceMandateNotificationAcssDebitDataSchema = z.object({ - /** The statement descriptor associate with the debit. */ + /**The statement descriptor associate with the debit.*/ statement_descriptor: z .string() .max(5000) @@ -14370,7 +13705,7 @@ export namespace stripe { > export const SourceMandateNotificationBacsDebitDataSchema = z.object({ - /** Last 4 digits of the account number associated with the debit. */ + /**Last 4 digits of the account number associated with the debit.*/ last4: z .string() .max(5000) @@ -14384,13 +13719,13 @@ export namespace stripe { > export const SourceMandateNotificationSepaDebitDataSchema = z.object({ - /** SEPA creditor ID. */ + /**SEPA creditor ID.*/ creditor_identifier: z .string() .max(5000) .describe('SEPA creditor ID.') .optional(), - /** Last 4 digits of the account number associated with the debit. */ + /**Last 4 digits of the account number associated with the debit.*/ last4: z .string() .max(5000) @@ -14398,7 +13733,7 @@ export namespace stripe { 'Last 4 digits of the account number associated with the debit.' ) .optional(), - /** Mandate reference associated with the debit. */ + /**Mandate reference associated with the debit.*/ mandate_reference: z .string() .max(5000) @@ -14410,19 +13745,19 @@ export namespace stripe { > export const SourceTransactionAchCreditTransferDataSchema = z.object({ - /** Customer data associated with the transfer. */ + /**Customer data associated with the transfer.*/ customer_data: z .string() .max(5000) .describe('Customer data associated with the transfer.') .optional(), - /** Bank account fingerprint associated with the transfer. */ + /**Bank account fingerprint associated with the transfer.*/ fingerprint: z .string() .max(5000) .describe('Bank account fingerprint associated with the transfer.') .optional(), - /** Last 4 digits of the account number associated with the transfer. */ + /**Last 4 digits of the account number associated with the transfer.*/ last4: z .string() .max(5000) @@ -14430,7 +13765,7 @@ export namespace stripe { 'Last 4 digits of the account number associated with the transfer.' ) .optional(), - /** Routing number associated with the transfer. */ + /**Routing number associated with the transfer.*/ routing_number: z .string() .max(5000) @@ -14442,31 +13777,31 @@ export namespace stripe { > export const SourceTransactionChfCreditTransferDataSchema = z.object({ - /** Reference associated with the transfer. */ + /**Reference associated with the transfer.*/ reference: z .string() .max(5000) .describe('Reference associated with the transfer.') .optional(), - /** Sender's country address. */ + /**Sender's country address.*/ sender_address_country: z .string() .max(5000) .describe("Sender's country address.") .optional(), - /** Sender's line 1 address. */ + /**Sender's line 1 address.*/ sender_address_line1: z .string() .max(5000) .describe("Sender's line 1 address.") .optional(), - /** Sender's bank account IBAN. */ + /**Sender's bank account IBAN.*/ sender_iban: z .string() .max(5000) .describe("Sender's bank account IBAN.") .optional(), - /** Sender's name. */ + /**Sender's name.*/ sender_name: z.string().max(5000).describe("Sender's name.").optional() }) export type SourceTransactionChfCreditTransferData = z.infer< @@ -14474,7 +13809,7 @@ export namespace stripe { > export const SourceTransactionGbpCreditTransferDataSchema = z.object({ - /** Bank account fingerprint associated with the Stripe owned bank account receiving the transfer. */ + /**Bank account fingerprint associated with the Stripe owned bank account receiving the transfer.*/ fingerprint: z .string() .max(5000) @@ -14482,7 +13817,7 @@ export namespace stripe { 'Bank account fingerprint associated with the Stripe owned bank account receiving the transfer.' ) .optional(), - /** The credit transfer rails the sender used to push this transfer. The possible rails are: Faster Payments, BACS, CHAPS, and wire transfers. Currently only Faster Payments is supported. */ + /**The credit transfer rails the sender used to push this transfer. The possible rails are: Faster Payments, BACS, CHAPS, and wire transfers. Currently only Faster Payments is supported.*/ funding_method: z .string() .max(5000) @@ -14490,7 +13825,7 @@ export namespace stripe { 'The credit transfer rails the sender used to push this transfer. The possible rails are: Faster Payments, BACS, CHAPS, and wire transfers. Currently only Faster Payments is supported.' ) .optional(), - /** Last 4 digits of sender account number associated with the transfer. */ + /**Last 4 digits of sender account number associated with the transfer.*/ last4: z .string() .max(5000) @@ -14498,25 +13833,25 @@ export namespace stripe { 'Last 4 digits of sender account number associated with the transfer.' ) .optional(), - /** Sender entered arbitrary information about the transfer. */ + /**Sender entered arbitrary information about the transfer.*/ reference: z .string() .max(5000) .describe('Sender entered arbitrary information about the transfer.') .optional(), - /** Sender account number associated with the transfer. */ + /**Sender account number associated with the transfer.*/ sender_account_number: z .string() .max(5000) .describe('Sender account number associated with the transfer.') .optional(), - /** Sender name associated with the transfer. */ + /**Sender name associated with the transfer.*/ sender_name: z .string() .max(5000) .describe('Sender name associated with the transfer.') .optional(), - /** Sender sort code associated with the transfer. */ + /**Sender sort code associated with the transfer.*/ sender_sort_code: z .string() .max(5000) @@ -14528,7 +13863,7 @@ export namespace stripe { > export const SourceTransactionPaperCheckDataSchema = z.object({ - /** Time at which the deposited funds will be available for use. Measured in seconds since the Unix epoch. */ + /**Time at which the deposited funds will be available for use. Measured in seconds since the Unix epoch.*/ available_at: z .string() .max(5000) @@ -14536,7 +13871,7 @@ export namespace stripe { 'Time at which the deposited funds will be available for use. Measured in seconds since the Unix epoch.' ) .optional(), - /** Comma-separated list of invoice IDs associated with the paper check. */ + /**Comma-separated list of invoice IDs associated with the paper check.*/ invoices: z .string() .max(5000) @@ -14550,19 +13885,19 @@ export namespace stripe { > export const SourceTransactionSepaCreditTransferDataSchema = z.object({ - /** Reference associated with the transfer. */ + /**Reference associated with the transfer.*/ reference: z .string() .max(5000) .describe('Reference associated with the transfer.') .optional(), - /** Sender's bank account IBAN. */ + /**Sender's bank account IBAN.*/ sender_iban: z .string() .max(5000) .describe("Sender's bank account IBAN.") .optional(), - /** Sender's name. */ + /**Sender's name.*/ sender_name: z.string().max(5000).describe("Sender's name.").optional() }) export type SourceTransactionSepaCreditTransferData = z.infer< @@ -14570,11 +13905,11 @@ export namespace stripe { > export const DeletedSubscriptionItemSchema = z.object({ - /** Always true for a deleted object */ + /**Always true for a deleted object*/ deleted: z.literal(true).describe('Always true for a deleted object'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('subscription_item') .describe( @@ -14586,20 +13921,18 @@ export namespace stripe { > export const PeriodSchema = z.object({ - /** The end date of this usage period. All usage up to and including this point in time is included. */ + /**The end date of this usage period. All usage up to and including this point in time is included.*/ end: z .number() .int() - .nullable() .describe( 'The end date of this usage period. All usage up to and including this point in time is included.' ) .optional(), - /** The start date of this usage period. All usage after this point in time is included. */ + /**The start date of this usage period. All usage after this point in time is included.*/ start: z .number() .int() - .nullable() .describe( 'The start date of this usage period. All usage after this point in time is included.' ) @@ -14617,33 +13950,33 @@ export namespace stripe { */ export const UsageRecordSchema = z .object({ - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('usage_record') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The usage quantity for the specified date. */ + /**The usage quantity for the specified date.*/ quantity: z .number() .int() .describe('The usage quantity for the specified date.'), - /** The ID of the subscription item this usage record contains data for. */ + /**The ID of the subscription item this usage record contains data for.*/ subscription_item: z .string() .max(5000) .describe( 'The ID of the subscription item this usage record contains data for.' ), - /** The timestamp when this usage occurred. */ + /**The timestamp when this usage occurred.*/ timestamp: z .number() .int() @@ -14655,46 +13988,41 @@ export namespace stripe { export type UsageRecord = z.infer export const TaxProductResourcePostalAddressSchema = z.object({ - /** City, district, suburb, town, or village. */ + /**City, district, suburb, town, or village.*/ city: z .string() .max(5000) - .nullable() .describe('City, district, suburb, town, or village.') .optional(), - /** Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ + /**Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).*/ country: z .string() .max(5000) .describe( 'Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).' ), - /** Address line 1 (e.g., street, PO Box, or company name). */ + /**Address line 1 (e.g., street, PO Box, or company name).*/ line1: z .string() .max(5000) - .nullable() .describe('Address line 1 (e.g., street, PO Box, or company name).') .optional(), - /** Address line 2 (e.g., apartment, suite, unit, or building). */ + /**Address line 2 (e.g., apartment, suite, unit, or building).*/ line2: z .string() .max(5000) - .nullable() .describe('Address line 2 (e.g., apartment, suite, unit, or building).') .optional(), - /** ZIP or postal code. */ + /**ZIP or postal code.*/ postal_code: z .string() .max(5000) - .nullable() .describe('ZIP or postal code.') .optional(), - /** State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix. Example: "NY" or "TX". */ + /**State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix. Example: "NY" or "TX".*/ state: z .string() .max(5000) - .nullable() .describe( 'State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix. Example: "NY" or "TX".' ) @@ -14705,7 +14033,7 @@ export namespace stripe { > export const TaxProductResourceCustomerDetailsResourceTaxIdSchema = z.object({ - /** The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or `unknown` */ + /**The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or `unknown`*/ type: z .enum([ 'ad_nrt', @@ -14813,7 +14141,7 @@ export namespace stripe { .describe( 'The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or `unknown`' ), - /** The value of the tax ID. */ + /**The value of the tax ID.*/ value: z.string().max(5000).describe('The value of the tax ID.') }) export type TaxProductResourceCustomerDetailsResourceTaxId = z.infer< @@ -14821,27 +14149,26 @@ export namespace stripe { > export const TaxProductResourceJurisdictionSchema = z.object({ - /** Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ + /**Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).*/ country: z .string() .max(5000) .describe( 'Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).' ), - /** A human-readable name for the jurisdiction imposing the tax. */ + /**A human-readable name for the jurisdiction imposing the tax.*/ display_name: z .string() .max(5000) .describe('A human-readable name for the jurisdiction imposing the tax.'), - /** Indicates the level of the jurisdiction imposing the tax. */ + /**Indicates the level of the jurisdiction imposing the tax.*/ level: z .enum(['city', 'country', 'county', 'district', 'state']) .describe('Indicates the level of the jurisdiction imposing the tax.'), - /** [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States. */ + /**[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States.*/ state: z .string() .max(5000) - .nullable() .describe( '[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States.' ) @@ -14852,21 +14179,21 @@ export namespace stripe { > export const TaxProductResourceLineItemTaxRateDetailsSchema = z.object({ - /** A localized display name for tax type, intended to be human-readable. For example, "Local Sales and Use Tax", "Value-added tax (VAT)", or "Umsatzsteuer (USt.)". */ + /**A localized display name for tax type, intended to be human-readable. For example, "Local Sales and Use Tax", "Value-added tax (VAT)", or "Umsatzsteuer (USt.)".*/ display_name: z .string() .max(5000) .describe( 'A localized display name for tax type, intended to be human-readable. For example, "Local Sales and Use Tax", "Value-added tax (VAT)", or "Umsatzsteuer (USt.)".' ), - /** The tax rate percentage as a string. For example, 8.5% is represented as "8.5". */ + /**The tax rate percentage as a string. For example, 8.5% is represented as "8.5".*/ percentage_decimal: z .string() .max(5000) .describe( 'The tax rate percentage as a string. For example, 8.5% is represented as "8.5".' ), - /** The tax type, such as `vat` or `sales_tax`. */ + /**The tax type, such as `vat` or `sales_tax`.*/ tax_type: z .enum([ 'amusement_tax', @@ -14892,7 +14219,7 @@ export namespace stripe { export const TaxProductRegistrationsResourceCountryOptionsDefaultSchema = z.object({ - /** Type of registration in `country`. */ + /**Type of registration in `country`.*/ type: z.literal('standard').describe('Type of registration in `country`.') }) export type TaxProductRegistrationsResourceCountryOptionsDefault = z.infer< @@ -14901,7 +14228,7 @@ export namespace stripe { export const TaxProductRegistrationsResourceCountryOptionsSimplifiedSchema = z.object({ - /** Type of registration in `country`. */ + /**Type of registration in `country`.*/ type: z .literal('simplified') .describe('Type of registration in `country`.') @@ -14912,7 +14239,7 @@ export namespace stripe { export const TaxProductRegistrationsResourceCountryOptionsEuStandardSchema = z.object({ - /** Place of supply scheme used in an EU standard registration. */ + /**Place of supply scheme used in an EU standard registration.*/ place_of_supply_scheme: z .enum(['small_seller', 'standard']) .describe('Place of supply scheme used in an EU standard registration.') @@ -14923,7 +14250,7 @@ export namespace stripe { export const TaxProductRegistrationsResourceCountryOptionsCaProvinceStandardSchema = z.object({ - /** Two-letter CA province code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). */ + /**Two-letter CA province code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).*/ province: z .string() .max(5000) @@ -14938,7 +14265,7 @@ export namespace stripe { export const TaxProductRegistrationsResourceCountryOptionsUsLocalAmusementTaxSchema = z.object({ - /** A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. */ + /**A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction.*/ jurisdiction: z .string() .max(5000) @@ -14953,7 +14280,7 @@ export namespace stripe { export const TaxProductRegistrationsResourceCountryOptionsUsLocalLeaseTaxSchema = z.object({ - /** A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. */ + /**A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction.*/ jurisdiction: z .string() .max(5000) @@ -14968,7 +14295,7 @@ export namespace stripe { export const TaxProductRegistrationsResourceCountryOptionsUsStateSalesTaxElectionSchema = z.object({ - /** A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. */ + /**A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction.*/ jurisdiction: z .string() .max(5000) @@ -14976,7 +14303,7 @@ export namespace stripe { 'A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction.' ) .optional(), - /** The type of the election for the state sales tax registration. */ + /**The type of the election for the state sales tax registration.*/ type: z .enum([ 'local_use_tax', @@ -14993,19 +14320,17 @@ export namespace stripe { > export const TaxProductResourceTaxSettingsDefaultsSchema = z.object({ - /** Default [tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#tax-behavior) used to specify whether the price is considered inclusive of taxes or exclusive of taxes. If the item's price has a tax behavior set, it will take precedence over the default tax behavior. */ + /**Default [tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#tax-behavior) used to specify whether the price is considered inclusive of taxes or exclusive of taxes. If the item's price has a tax behavior set, it will take precedence over the default tax behavior.*/ tax_behavior: z .enum(['exclusive', 'inclusive', 'inferred_by_currency']) - .nullable() .describe( "Default [tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#tax-behavior) used to specify whether the price is considered inclusive of taxes or exclusive of taxes. If the item's price has a tax behavior set, it will take precedence over the default tax behavior." ) .optional(), - /** Default [tax code](https://stripe.com/docs/tax/tax-categories) used to classify your products and prices. */ + /**Default [tax code](https://stripe.com/docs/tax/tax-categories) used to classify your products and prices.*/ tax_code: z .string() .max(5000) - .nullable() .describe( 'Default [tax code](https://stripe.com/docs/tax/tax-categories) used to classify your products and prices.' ) @@ -15024,10 +14349,9 @@ export namespace stripe { export const TaxProductResourceTaxSettingsStatusDetailsResourcePendingSchema = z.object({ - /** The list of missing fields that are required to perform calculations. It includes the entry `head_office` when the status is `pending`. It is recommended to set the optional values even if they aren't listed as required for calculating taxes. Calculations can fail if missing fields aren't explicitly provided on every call. */ + /**The list of missing fields that are required to perform calculations. It includes the entry `head_office` when the status is `pending`. It is recommended to set the optional values even if they aren't listed as required for calculating taxes. Calculations can fail if missing fields aren't explicitly provided on every call.*/ missing_fields: z .array(z.string().max(5000)) - .nullable() .describe( "The list of missing fields that are required to perform calculations. It includes the entry `head_office` when the status is `pending`. It is recommended to set the optional values even if they aren't listed as required for calculating taxes. Calculations can fail if missing fields aren't explicitly provided on every call." ) @@ -15040,7 +14364,7 @@ export namespace stripe { export const TaxProductResourceTaxTransactionLineItemResourceReversalSchema = z.object({ - /** The `id` of the line item to reverse in the original transaction. */ + /**The `id` of the line item to reverse in the original transaction.*/ original_line_item: z .string() .max(5000) @@ -15055,11 +14379,10 @@ export namespace stripe { export const TaxProductResourceTaxTransactionResourceReversalSchema = z.object({ - /** The `id` of the reversed `Transaction` object. */ + /**The `id` of the reversed `Transaction` object.*/ original_transaction: z .string() .max(5000) - .nullable() .describe('The `id` of the reversed `Transaction` object.') .optional() }) @@ -15068,21 +14391,21 @@ export namespace stripe { > export const TaxProductResourceTaxTransactionShippingCostSchema = z.object({ - /** The shipping amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. */ + /**The shipping amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.*/ amount: z .number() .int() .describe( 'The shipping amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.' ), - /** The amount of tax calculated for shipping, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /**The amount of tax calculated for shipping, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).*/ amount_tax: z .number() .int() .describe( 'The amount of tax calculated for shipping, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).' ), - /** The ID of an existing [ShippingRate](https://stripe.com/docs/api/shipping_rates/object). */ + /**The ID of an existing [ShippingRate](https://stripe.com/docs/api/shipping_rates/object).*/ shipping_rate: z .string() .max(5000) @@ -15090,13 +14413,13 @@ export namespace stripe { 'The ID of an existing [ShippingRate](https://stripe.com/docs/api/shipping_rates/object).' ) .optional(), - /** Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes. */ + /**Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.*/ tax_behavior: z .enum(['exclusive', 'inclusive']) .describe( 'Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.' ), - /** The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for shipping. */ + /**The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for shipping.*/ tax_code: z .string() .max(5000) @@ -15110,10 +14433,9 @@ export namespace stripe { export const TerminalConfigurationConfigurationResourceOfflineConfigSchema = z.object({ - /** Determines whether to allow transactions to be collected while reader is offline. Defaults to false. */ + /**Determines whether to allow transactions to be collected while reader is offline. Defaults to false.*/ enabled: z .boolean() - .nullable() .describe( 'Determines whether to allow transactions to be collected while reader is offline. Defaults to false.' ) @@ -15125,14 +14447,14 @@ export namespace stripe { export const TerminalConfigurationConfigurationResourceRebootWindowSchema = z.object({ - /** Integer between 0 to 23 that represents the end hour of the reboot time window. The value must be different than the start_hour. */ + /**Integer between 0 to 23 that represents the end hour of the reboot time window. The value must be different than the start_hour.*/ end_hour: z .number() .int() .describe( 'Integer between 0 to 23 that represents the end hour of the reboot time window. The value must be different than the start_hour.' ), - /** Integer between 0 to 23 that represents the start hour of the reboot time window. */ + /**Integer between 0 to 23 that represents the start hour of the reboot time window.*/ start_hour: z .number() .int() @@ -15146,19 +14468,17 @@ export namespace stripe { export const TerminalConfigurationConfigurationResourceCurrencySpecificConfigSchema = z.object({ - /** Fixed amounts displayed when collecting a tip */ + /**Fixed amounts displayed when collecting a tip*/ fixed_amounts: z .array(z.number().int()) - .nullable() .describe('Fixed amounts displayed when collecting a tip') .optional(), - /** Percentages displayed when collecting a tip */ + /**Percentages displayed when collecting a tip*/ percentages: z .array(z.number().int()) - .nullable() .describe('Percentages displayed when collecting a tip') .optional(), - /** Below this amount, fixed amounts will be displayed; above it, percentages will be displayed */ + /**Below this amount, fixed amounts will be displayed; above it, percentages will be displayed*/ smart_tip_threshold: z .number() .int() @@ -15173,11 +14493,11 @@ export namespace stripe { > export const DeletedTerminalConfigurationSchema = z.object({ - /** Always true for a deleted object */ + /**Always true for a deleted object*/ deleted: z.literal(true).describe('Always true for a deleted object'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('terminal.configuration') .describe( @@ -15195,7 +14515,7 @@ export namespace stripe { */ export const TerminalConnectionTokenSchema = z .object({ - /** The id of the location that this connection token is scoped to. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://docs.stripe.com/terminal/fleet/locations-and-zones?dashboard-or-api=api#connection-tokens). */ + /**The id of the location that this connection token is scoped to. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://docs.stripe.com/terminal/fleet/locations-and-zones?dashboard-or-api=api#connection-tokens).*/ location: z .string() .max(5000) @@ -15203,13 +14523,13 @@ export namespace stripe { 'The id of the location that this connection token is scoped to. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://docs.stripe.com/terminal/fleet/locations-and-zones?dashboard-or-api=api#connection-tokens).' ) .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('terminal.connection_token') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** Your application should pass this token to the Stripe Terminal SDK. */ + /**Your application should pass this token to the Stripe Terminal SDK.*/ secret: z .string() .max(5000) @@ -15225,11 +14545,11 @@ export namespace stripe { > export const DeletedTerminalLocationSchema = z.object({ - /** Always true for a deleted object */ + /**Always true for a deleted object*/ deleted: z.literal(true).describe('Always true for a deleted object'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('terminal.location') .describe( @@ -15240,10 +14560,10 @@ export namespace stripe { typeof DeletedTerminalLocationSchema > - /** Represents a per-transaction tipping configuration */ + /**Represents a per-transaction tipping configuration*/ export const TerminalReaderReaderResourceTippingConfigSchema = z .object({ - /** Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents to represent $1.00 or 100 to represent ¥100, a zero-decimal currency). */ + /**Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents to represent $1.00 or 100 to represent ¥100, a zero-decimal currency).*/ amount_eligible: z .number() .int() @@ -15257,10 +14577,10 @@ export namespace stripe { typeof TerminalReaderReaderResourceTippingConfigSchema > - /** Represents a per-setup override of a reader configuration */ + /**Represents a per-setup override of a reader configuration*/ export const TerminalReaderReaderResourceProcessSetupConfigSchema = z .object({ - /** Enable customer initiated cancellation when processing this SetupIntent. */ + /**Enable customer initiated cancellation when processing this SetupIntent.*/ enable_customer_cancellation: z .boolean() .describe( @@ -15273,10 +14593,10 @@ export namespace stripe { typeof TerminalReaderReaderResourceProcessSetupConfigSchema > - /** Represents a per-transaction override of a reader configuration */ + /**Represents a per-transaction override of a reader configuration*/ export const TerminalReaderReaderResourceRefundPaymentConfigSchema = z .object({ - /** Enable customer initiated cancellation when refunding this payment. */ + /**Enable customer initiated cancellation when refunding this payment.*/ enable_customer_cancellation: z .boolean() .describe( @@ -15289,22 +14609,22 @@ export namespace stripe { typeof TerminalReaderReaderResourceRefundPaymentConfigSchema > - /** Represents a line item to be displayed on the reader */ + /**Represents a line item to be displayed on the reader*/ export const TerminalReaderReaderResourceLineItemSchema = z .object({ - /** The amount of the line item. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /**The amount of the line item. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).*/ amount: z .number() .int() .describe( 'The amount of the line item. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).' ), - /** Description of the line item. */ + /**Description of the line item.*/ description: z .string() .max(5000) .describe('Description of the line item.'), - /** The quantity of the line item. */ + /**The quantity of the line item.*/ quantity: z.number().int().describe('The quantity of the line item.') }) .describe('Represents a line item to be displayed on the reader') @@ -15313,11 +14633,11 @@ export namespace stripe { > export const DeletedTerminalReaderSchema = z.object({ - /** Always true for a deleted object */ + /**Always true for a deleted object*/ deleted: z.literal(true).describe('Always true for a deleted object'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('terminal.reader') .describe( @@ -15329,11 +14649,11 @@ export namespace stripe { > export const DeletedTestHelpersTestClockSchema = z.object({ - /** Always true for a deleted object */ + /**Always true for a deleted object*/ deleted: z.literal(true).describe('Always true for a deleted object'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('test_helpers.test_clock') .describe( @@ -15345,7 +14665,7 @@ export namespace stripe { > export const TreasuryInboundTransfersResourceFailureDetailsSchema = z.object({ - /** Reason for the failure. */ + /**Reason for the failure.*/ code: z .enum([ 'account_closed', @@ -15370,11 +14690,10 @@ export namespace stripe { export const TreasuryInboundTransfersResourceInboundTransferResourceLinkedFlowsSchema = z.object({ - /** If funds for this flow were returned after the flow went to the `succeeded` state, this field contains a reference to the ReceivedDebit return. */ + /**If funds for this flow were returned after the flow went to the `succeeded` state, this field contains a reference to the ReceivedDebit return.*/ received_debit: z .string() .max(5000) - .nullable() .describe( 'If funds for this flow were returned after the flow went to the `succeeded` state, this field contains a reference to the ReceivedDebit return.' ) @@ -15387,29 +14706,26 @@ export namespace stripe { export const TreasuryInboundTransfersResourceInboundTransferResourceStatusTransitionsSchema = z.object({ - /** Timestamp describing when an InboundTransfer changed status to `canceled`. */ + /**Timestamp describing when an InboundTransfer changed status to `canceled`.*/ canceled_at: z .number() .int() - .nullable() .describe( 'Timestamp describing when an InboundTransfer changed status to `canceled`.' ) .optional(), - /** Timestamp describing when an InboundTransfer changed status to `failed`. */ + /**Timestamp describing when an InboundTransfer changed status to `failed`.*/ failed_at: z .number() .int() - .nullable() .describe( 'Timestamp describing when an InboundTransfer changed status to `failed`.' ) .optional(), - /** Timestamp describing when an InboundTransfer changed status to `succeeded`. */ + /**Timestamp describing when an InboundTransfer changed status to `succeeded`.*/ succeeded_at: z .number() .int() - .nullable() .describe( 'Timestamp describing when an InboundTransfer changed status to `succeeded`.' ) @@ -15420,22 +14736,22 @@ export namespace stripe { typeof TreasuryInboundTransfersResourceInboundTransferResourceStatusTransitionsSchema > - /** Change to a FinancialAccount's balance */ + /**Change to a FinancialAccount's balance*/ export const TreasuryTransactionsResourceBalanceImpactSchema = z .object({ - /** The change made to funds the user can spend right now. */ + /**The change made to funds the user can spend right now.*/ cash: z .number() .int() .describe('The change made to funds the user can spend right now.'), - /** The change made to funds that are not spendable yet, but will become available at a later time. */ + /**The change made to funds that are not spendable yet, but will become available at a later time.*/ inbound_pending: z .number() .int() .describe( 'The change made to funds that are not spendable yet, but will become available at a later time.' ), - /** The change made to funds in the account, but not spendable because they are being held for pending outbound flows. */ + /**The change made to funds in the account, but not spendable because they are being held for pending outbound flows.*/ outbound_pending: z .number() .int() @@ -15450,11 +14766,10 @@ export namespace stripe { export const TreasuryReceivedCreditsResourceStatusTransitionsSchema = z.object({ - /** Timestamp describing when the CreditReversal changed status to `posted` */ + /**Timestamp describing when the CreditReversal changed status to `posted`*/ posted_at: z .number() .int() - .nullable() .describe( 'Timestamp describing when the CreditReversal changed status to `posted`' ) @@ -15466,11 +14781,10 @@ export namespace stripe { export const TreasuryReceivedDebitsResourceDebitReversalLinkedFlowsSchema = z.object({ - /** Set if there is an Issuing dispute associated with the DebitReversal. */ + /**Set if there is an Issuing dispute associated with the DebitReversal.*/ issuing_dispute: z .string() .max(5000) - .nullable() .describe( 'Set if there is an Issuing dispute associated with the DebitReversal.' ) @@ -15482,11 +14796,10 @@ export namespace stripe { export const TreasuryReceivedDebitsResourceStatusTransitionsSchema = z.object( { - /** Timestamp describing when the DebitReversal changed status to `completed`. */ + /**Timestamp describing when the DebitReversal changed status to `completed`.*/ completed_at: z .number() .int() - .nullable() .describe( 'Timestamp describing when the DebitReversal changed status to `completed`.' ) @@ -15499,9 +14812,9 @@ export namespace stripe { export const OutboundPaymentsPaymentMethodDetailsFinancialAccountSchema = z.object({ - /** Token of the FinancialAccount. */ + /**Token of the FinancialAccount.*/ id: z.string().max(5000).describe('Token of the FinancialAccount.'), - /** The rails used to send funds. */ + /**The rails used to send funds.*/ network: z.literal('stripe').describe('The rails used to send funds.') }) export type OutboundPaymentsPaymentMethodDetailsFinancialAccount = z.infer< @@ -15510,16 +14823,15 @@ export namespace stripe { export const TreasuryOutboundPaymentsResourceOutboundPaymentResourceEndUserDetailsSchema = z.object({ - /** IP address of the user initiating the OutboundPayment. Set if `present` is set to `true`. IP address collection is required for risk and compliance reasons. This will be used to help determine if the OutboundPayment is authorized or should be blocked. */ + /**IP address of the user initiating the OutboundPayment. Set if `present` is set to `true`. IP address collection is required for risk and compliance reasons. This will be used to help determine if the OutboundPayment is authorized or should be blocked.*/ ip_address: z .string() .max(5000) - .nullable() .describe( 'IP address of the user initiating the OutboundPayment. Set if `present` is set to `true`. IP address collection is required for risk and compliance reasons. This will be used to help determine if the OutboundPayment is authorized or should be blocked.' ) .optional(), - /** `true` if the OutboundPayment creation request is being made on behalf of an end user by a platform. Otherwise, `false`. */ + /**`true` if the OutboundPayment creation request is being made on behalf of an end user by a platform. Otherwise, `false`.*/ present: z .boolean() .describe( @@ -15533,38 +14845,34 @@ export namespace stripe { export const TreasuryOutboundPaymentsResourceOutboundPaymentResourceStatusTransitionsSchema = z.object({ - /** Timestamp describing when an OutboundPayment changed status to `canceled`. */ + /**Timestamp describing when an OutboundPayment changed status to `canceled`.*/ canceled_at: z .number() .int() - .nullable() .describe( 'Timestamp describing when an OutboundPayment changed status to `canceled`.' ) .optional(), - /** Timestamp describing when an OutboundPayment changed status to `failed`. */ + /**Timestamp describing when an OutboundPayment changed status to `failed`.*/ failed_at: z .number() .int() - .nullable() .describe( 'Timestamp describing when an OutboundPayment changed status to `failed`.' ) .optional(), - /** Timestamp describing when an OutboundPayment changed status to `posted`. */ + /**Timestamp describing when an OutboundPayment changed status to `posted`.*/ posted_at: z .number() .int() - .nullable() .describe( 'Timestamp describing when an OutboundPayment changed status to `posted`.' ) .optional(), - /** Timestamp describing when an OutboundPayment changed status to `returned`. */ + /**Timestamp describing when an OutboundPayment changed status to `returned`.*/ returned_at: z .number() .int() - .nullable() .describe( 'Timestamp describing when an OutboundPayment changed status to `returned`.' ) @@ -15577,7 +14885,7 @@ export namespace stripe { export const TreasuryOutboundPaymentsResourceAchTrackingDetailsSchema = z.object({ - /** ACH trace ID of the OutboundPayment for payments sent over the `ach` network. */ + /**ACH trace ID of the OutboundPayment for payments sent over the `ach` network.*/ trace_id: z .string() .max(5000) @@ -15591,29 +14899,26 @@ export namespace stripe { export const TreasuryOutboundPaymentsResourceUsDomesticWireTrackingDetailsSchema = z.object({ - /** CHIPS System Sequence Number (SSN) of the OutboundPayment for payments sent over the `us_domestic_wire` network. */ + /**CHIPS System Sequence Number (SSN) of the OutboundPayment for payments sent over the `us_domestic_wire` network.*/ chips: z .string() .max(5000) - .nullable() .describe( 'CHIPS System Sequence Number (SSN) of the OutboundPayment for payments sent over the `us_domestic_wire` network.' ) .optional(), - /** IMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network. */ + /**IMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network.*/ imad: z .string() .max(5000) - .nullable() .describe( 'IMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network.' ) .optional(), - /** OMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network. */ + /**OMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network.*/ omad: z .string() .max(5000) - .nullable() .describe( 'OMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network.' ) @@ -15626,9 +14931,9 @@ export namespace stripe { export const OutboundTransfersPaymentMethodDetailsFinancialAccountSchema = z.object({ - /** Token of the FinancialAccount. */ + /**Token of the FinancialAccount.*/ id: z.string().max(5000).describe('Token of the FinancialAccount.'), - /** The rails used to send funds. */ + /**The rails used to send funds.*/ network: z.literal('stripe').describe('The rails used to send funds.') }) export type OutboundTransfersPaymentMethodDetailsFinancialAccount = z.infer< @@ -15637,38 +14942,34 @@ export namespace stripe { export const TreasuryOutboundTransfersResourceStatusTransitionsSchema = z.object({ - /** Timestamp describing when an OutboundTransfer changed status to `canceled` */ + /**Timestamp describing when an OutboundTransfer changed status to `canceled`*/ canceled_at: z .number() .int() - .nullable() .describe( 'Timestamp describing when an OutboundTransfer changed status to `canceled`' ) .optional(), - /** Timestamp describing when an OutboundTransfer changed status to `failed` */ + /**Timestamp describing when an OutboundTransfer changed status to `failed`*/ failed_at: z .number() .int() - .nullable() .describe( 'Timestamp describing when an OutboundTransfer changed status to `failed`' ) .optional(), - /** Timestamp describing when an OutboundTransfer changed status to `posted` */ + /**Timestamp describing when an OutboundTransfer changed status to `posted`*/ posted_at: z .number() .int() - .nullable() .describe( 'Timestamp describing when an OutboundTransfer changed status to `posted`' ) .optional(), - /** Timestamp describing when an OutboundTransfer changed status to `returned` */ + /**Timestamp describing when an OutboundTransfer changed status to `returned`*/ returned_at: z .number() .int() - .nullable() .describe( 'Timestamp describing when an OutboundTransfer changed status to `returned`' ) @@ -15680,7 +14981,7 @@ export namespace stripe { export const TreasuryOutboundTransfersResourceAchTrackingDetailsSchema = z.object({ - /** ACH trace ID of the OutboundTransfer for transfers sent over the `ach` network. */ + /**ACH trace ID of the OutboundTransfer for transfers sent over the `ach` network.*/ trace_id: z .string() .max(5000) @@ -15694,29 +14995,26 @@ export namespace stripe { export const TreasuryOutboundTransfersResourceUsDomesticWireTrackingDetailsSchema = z.object({ - /** CHIPS System Sequence Number (SSN) of the OutboundTransfer for transfers sent over the `us_domestic_wire` network. */ + /**CHIPS System Sequence Number (SSN) of the OutboundTransfer for transfers sent over the `us_domestic_wire` network.*/ chips: z .string() .max(5000) - .nullable() .describe( 'CHIPS System Sequence Number (SSN) of the OutboundTransfer for transfers sent over the `us_domestic_wire` network.' ) .optional(), - /** IMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network. */ + /**IMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network.*/ imad: z .string() .max(5000) - .nullable() .describe( 'IMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network.' ) .optional(), - /** OMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network. */ + /**OMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network.*/ omad: z .string() .max(5000) - .nullable() .describe( 'OMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network.' ) @@ -15728,9 +15026,9 @@ export namespace stripe { > export const ReceivedPaymentMethodDetailsFinancialAccountSchema = z.object({ - /** The FinancialAccount ID. */ + /**The FinancialAccount ID.*/ id: z.string().max(5000).describe('The FinancialAccount ID.'), - /** The rails the ReceivedCredit was sent over. A FinancialAccount can only send funds over `stripe`. */ + /**The rails the ReceivedCredit was sent over. A FinancialAccount can only send funds over `stripe`.*/ network: z .literal('stripe') .describe( @@ -15743,25 +15041,18 @@ export namespace stripe { export const TreasurySharedResourceInitiatingPaymentMethodDetailsUsBankAccountSchema = z.object({ - /** Bank name. */ - bank_name: z - .string() - .max(5000) - .nullable() - .describe('Bank name.') - .optional(), - /** The last four digits of the bank account number. */ + /**Bank name.*/ + bank_name: z.string().max(5000).describe('Bank name.').optional(), + /**The last four digits of the bank account number.*/ last4: z .string() .max(5000) - .nullable() .describe('The last four digits of the bank account number.') .optional(), - /** The routing number for the bank account. */ + /**The routing number for the bank account.*/ routing_number: z .string() .max(5000) - .nullable() .describe('The routing number for the bank account.') .optional() }) @@ -15771,14 +15062,13 @@ export namespace stripe { > export const TreasuryReceivedCreditsResourceReversalDetailsSchema = z.object({ - /** Time before which a ReceivedCredit can be reversed. */ + /**Time before which a ReceivedCredit can be reversed.*/ deadline: z .number() .int() - .nullable() .describe('Time before which a ReceivedCredit can be reversed.') .optional(), - /** Set if a ReceivedCredit cannot be reversed. */ + /**Set if a ReceivedCredit cannot be reversed.*/ restricted_reason: z .enum([ 'already_reversed', @@ -15787,7 +15077,6 @@ export namespace stripe { 'other', 'source_flow_restricted' ]) - .nullable() .describe('Set if a ReceivedCredit cannot be reversed.') .optional() }) @@ -15796,47 +15085,42 @@ export namespace stripe { > export const TreasuryReceivedDebitsResourceLinkedFlowsSchema = z.object({ - /** The DebitReversal created as a result of this ReceivedDebit being reversed. */ + /**The DebitReversal created as a result of this ReceivedDebit being reversed.*/ debit_reversal: z .string() .max(5000) - .nullable() .describe( 'The DebitReversal created as a result of this ReceivedDebit being reversed.' ) .optional(), - /** Set if the ReceivedDebit is associated with an InboundTransfer's return of funds. */ + /**Set if the ReceivedDebit is associated with an InboundTransfer's return of funds.*/ inbound_transfer: z .string() .max(5000) - .nullable() .describe( "Set if the ReceivedDebit is associated with an InboundTransfer's return of funds." ) .optional(), - /** Set if the ReceivedDebit was created due to an [Issuing Authorization](https://stripe.com/docs/api#issuing_authorizations) object. */ + /**Set if the ReceivedDebit was created due to an [Issuing Authorization](https://stripe.com/docs/api#issuing_authorizations) object.*/ issuing_authorization: z .string() .max(5000) - .nullable() .describe( 'Set if the ReceivedDebit was created due to an [Issuing Authorization](https://stripe.com/docs/api#issuing_authorizations) object.' ) .optional(), - /** Set if the ReceivedDebit is also viewable as an [Issuing Dispute](https://stripe.com/docs/api#issuing_disputes) object. */ + /**Set if the ReceivedDebit is also viewable as an [Issuing Dispute](https://stripe.com/docs/api#issuing_disputes) object.*/ issuing_transaction: z .string() .max(5000) - .nullable() .describe( 'Set if the ReceivedDebit is also viewable as an [Issuing Dispute](https://stripe.com/docs/api#issuing_disputes) object.' ) .optional(), - /** Set if the ReceivedDebit was created due to a [Payout](https://stripe.com/docs/api#payouts) object. */ + /**Set if the ReceivedDebit was created due to a [Payout](https://stripe.com/docs/api#payouts) object.*/ payout: z .string() .max(5000) - .nullable() .describe( 'Set if the ReceivedDebit was created due to a [Payout](https://stripe.com/docs/api#payouts) object.' ) @@ -15847,14 +15131,13 @@ export namespace stripe { > export const TreasuryReceivedDebitsResourceReversalDetailsSchema = z.object({ - /** Time before which a ReceivedDebit can be reversed. */ + /**Time before which a ReceivedDebit can be reversed.*/ deadline: z .number() .int() - .nullable() .describe('Time before which a ReceivedDebit can be reversed.') .optional(), - /** Set if a ReceivedDebit can't be reversed. */ + /**Set if a ReceivedDebit can't be reversed.*/ restricted_reason: z .enum([ 'already_reversed', @@ -15863,7 +15146,6 @@ export namespace stripe { 'other', 'source_flow_restricted' ]) - .nullable() .describe("Set if a ReceivedDebit can't be reversed.") .optional() }) @@ -15873,20 +15155,18 @@ export namespace stripe { export const TreasuryTransactionsResourceAbstractTransactionResourceStatusTransitionsSchema = z.object({ - /** Timestamp describing when the Transaction changed status to `posted`. */ + /**Timestamp describing when the Transaction changed status to `posted`.*/ posted_at: z .number() .int() - .nullable() .describe( 'Timestamp describing when the Transaction changed status to `posted`.' ) .optional(), - /** Timestamp describing when the Transaction changed status to `void`. */ + /**Timestamp describing when the Transaction changed status to `void`.*/ void_at: z .number() .int() - .nullable() .describe( 'Timestamp describing when the Transaction changed status to `void`.' ) @@ -15897,20 +15177,20 @@ export namespace stripe { typeof TreasuryTransactionsResourceAbstractTransactionResourceStatusTransitionsSchema > - /** Balance information for the FinancialAccount */ + /**Balance information for the FinancialAccount*/ export const TreasuryFinancialAccountsResourceBalanceSchema = z .object({ - /** Funds the user can spend right now. */ + /**Funds the user can spend right now.*/ cash: z .record(z.number().int()) .describe('Funds the user can spend right now.'), - /** Funds not spendable yet, but will become available at a later time. */ + /**Funds not spendable yet, but will become available at a later time.*/ inbound_pending: z .record(z.number().int()) .describe( 'Funds not spendable yet, but will become available at a later time.' ), - /** Funds in the account, but not spendable because they are being held for pending outbound flows. */ + /**Funds in the account, but not spendable because they are being held for pending outbound flows.*/ outbound_pending: z .record(z.number().int()) .describe( @@ -15922,11 +15202,11 @@ export namespace stripe { typeof TreasuryFinancialAccountsResourceBalanceSchema > - /** Additional details on the FinancialAccount Features information. */ + /**Additional details on the FinancialAccount Features information.*/ export const TreasuryFinancialAccountsResourceTogglesSettingStatusDetailsSchema = z .object({ - /** Represents the reason why the status is `pending` or `restricted`. */ + /**Represents the reason why the status is `pending` or `restricted`.*/ code: z .enum([ 'activating', @@ -15942,15 +15222,14 @@ export namespace stripe { .describe( 'Represents the reason why the status is `pending` or `restricted`.' ), - /** Represents what the user should do, if anything, to activate the Feature. */ + /**Represents what the user should do, if anything, to activate the Feature.*/ resolution: z .enum(['contact_stripe', 'provide_information', 'remove_restriction']) - .nullable() .describe( 'Represents what the user should do, if anything, to activate the Feature.' ) .optional(), - /** The `platform_restrictions` that are restricting this Feature. */ + /**The `platform_restrictions` that are restricting this Feature.*/ restriction: z .enum(['inbound_flows', 'outbound_flows']) .describe( @@ -15966,31 +15245,30 @@ export namespace stripe { typeof TreasuryFinancialAccountsResourceTogglesSettingStatusDetailsSchema > - /** ABA Records contain U.S. bank account details per the ABA format. */ + /**ABA Records contain U.S. bank account details per the ABA format.*/ export const TreasuryFinancialAccountsResourceAbaRecordSchema = z .object({ - /** The name of the person or business that owns the bank account. */ + /**The name of the person or business that owns the bank account.*/ account_holder_name: z .string() .max(5000) .describe( 'The name of the person or business that owns the bank account.' ), - /** The account number. */ + /**The account number.*/ account_number: z .string() .max(5000) - .nullable() .describe('The account number.') .optional(), - /** The last four characters of the account number. */ + /**The last four characters of the account number.*/ account_number_last4: z .string() .max(5000) .describe('The last four characters of the account number.'), - /** Name of the bank. */ + /**Name of the bank.*/ bank_name: z.string().max(5000).describe('Name of the bank.'), - /** Routing number for the account. */ + /**Routing number for the account.*/ routing_number: z .string() .max(5000) @@ -16003,19 +15281,17 @@ export namespace stripe { typeof TreasuryFinancialAccountsResourceAbaRecordSchema > - /** Restrictions that a Connect Platform has placed on this FinancialAccount. */ + /**Restrictions that a Connect Platform has placed on this FinancialAccount.*/ export const TreasuryFinancialAccountsResourcePlatformRestrictionsSchema = z .object({ - /** Restricts all inbound money movement. */ + /**Restricts all inbound money movement.*/ inbound_flows: z .enum(['restricted', 'unrestricted']) - .nullable() .describe('Restricts all inbound money movement.') .optional(), - /** Restricts all outbound money movement. */ + /**Restricts all outbound money movement.*/ outbound_flows: z .enum(['restricted', 'unrestricted']) - .nullable() .describe('Restricts all outbound money movement.') .optional() }) @@ -16028,7 +15304,7 @@ export namespace stripe { export const TreasuryFinancialAccountsResourceClosedStatusDetailsSchema = z.object({ - /** The array that contains reasons for a FinancialAccount closure. */ + /**The array that contains reasons for a FinancialAccount closure.*/ reasons: z .array(z.enum(['account_rejected', 'closed_by_platform', 'other'])) .describe( @@ -16050,63 +15326,60 @@ export namespace stripe { */ export const WebhookEndpointSchema = z .object({ - /** The API version events are rendered as for this webhook endpoint. */ + /**The API version events are rendered as for this webhook endpoint.*/ api_version: z .string() .max(5000) - .nullable() .describe( 'The API version events are rendered as for this webhook endpoint.' ) .optional(), - /** The ID of the associated Connect application. */ + /**The ID of the associated Connect application.*/ application: z .string() .max(5000) - .nullable() .describe('The ID of the associated Connect application.') .optional(), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** An optional description of what the webhook is used for. */ + /**An optional description of what the webhook is used for.*/ description: z .string() .max(5000) - .nullable() .describe('An optional description of what the webhook is used for.') .optional(), - /** The list of events to enable for this endpoint. `['*']` indicates that all events are enabled, except those that require explicit selection. */ + /**The list of events to enable for this endpoint. `['*']` indicates that all events are enabled, except those that require explicit selection.*/ enabled_events: z .array(z.string().max(5000)) .describe( "The list of events to enable for this endpoint. `['*']` indicates that all events are enabled, except those that require explicit selection." ), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('webhook_endpoint') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The endpoint's secret, used to generate [webhook signatures](https://docs.stripe.com/webhooks/signatures). Only returned at creation. */ + /**The endpoint's secret, used to generate [webhook signatures](https://docs.stripe.com/webhooks/signatures). Only returned at creation.*/ secret: z .string() .max(5000) @@ -16114,14 +15387,14 @@ export namespace stripe { "The endpoint's secret, used to generate [webhook signatures](https://docs.stripe.com/webhooks/signatures). Only returned at creation." ) .optional(), - /** The status of the webhook. It can be `enabled` or `disabled`. */ + /**The status of the webhook. It can be `enabled` or `disabled`.*/ status: z .string() .max(5000) .describe( 'The status of the webhook. It can be `enabled` or `disabled`.' ), - /** The URL of the webhook endpoint. */ + /**The URL of the webhook endpoint.*/ url: z.string().max(5000).describe('The URL of the webhook endpoint.') }) .describe( @@ -16130,11 +15403,11 @@ export namespace stripe { export type WebhookEndpoint = z.infer export const DeletedWebhookEndpointSchema = z.object({ - /** Always true for a deleted object */ + /**Always true for a deleted object*/ deleted: z.literal(true).describe('Always true for a deleted object'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('webhook_endpoint') .describe( @@ -16156,67 +15429,64 @@ export namespace stripe { */ export const FileSchema = z .object({ - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** The file expires and isn't available at this time in epoch seconds. */ + /**The file expires and isn't available at this time in epoch seconds.*/ expires_at: z .number() .int() - .nullable() .describe( "The file expires and isn't available at this time in epoch seconds." ) .optional(), - /** The suitable name for saving the file to a filesystem. */ + /**The suitable name for saving the file to a filesystem.*/ filename: z .string() .max(5000) - .nullable() .describe('The suitable name for saving the file to a filesystem.') .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** A list of [file links](https://stripe.com/docs/api#file_links) that point at this file. */ + /**A list of [file links](https://stripe.com/docs/api#file_links) that point at this file.*/ links: z .object({ - /** Details about each object. */ + /**Details about each object.*/ data: z.array(FileLinkSchema).describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/file_links')) .max(5000) .describe('The URL where this list can be accessed.') }) - .nullable() .describe( 'A list of [file links](https://stripe.com/docs/api#file_links) that point at this file.' ) .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('file') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file. */ + /**The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file.*/ purpose: z .enum([ 'account_requirement', @@ -16240,29 +15510,26 @@ export namespace stripe { .describe( 'The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file.' ), - /** The size of the file object in bytes. */ + /**The size of the file object in bytes.*/ size: z.number().int().describe('The size of the file object in bytes.'), - /** A suitable title for the document. */ + /**A suitable title for the document.*/ title: z .string() .max(5000) - .nullable() .describe('A suitable title for the document.') .optional(), - /** The returned file type (for example, `csv`, `pdf`, `jpg`, or `png`). */ + /**The returned file type (for example, `csv`, `pdf`, `jpg`, or `png`).*/ type: z .string() .max(5000) - .nullable() .describe( 'The returned file type (for example, `csv`, `pdf`, `jpg`, or `png`).' ) .optional(), - /** Use your live secret API key to download the file from this URL. */ + /**Use your live secret API key to download the file from this URL.*/ url: z .string() .max(5000) - .nullable() .describe( 'Use your live secret API key to download the file from this URL.' ) @@ -16280,51 +15547,49 @@ export namespace stripe { */ export const FileLinkSchema = z .object({ - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Returns if the link is already expired. */ + /**Returns if the link is already expired.*/ expired: z.boolean().describe('Returns if the link is already expired.'), - /** Time that the link expires. */ + /**Time that the link expires.*/ expires_at: z .number() .int() - .nullable() .describe('Time that the link expires.') .optional(), - /** The file object this link points to. */ + /**The file object this link points to.*/ file: z .union([z.string().max(5000), FileSchema]) .describe('The file object this link points to.'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('file_link') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The publicly accessible URL to download the file. */ + /**The publicly accessible URL to download the file.*/ url: z .string() .max(5000) - .nullable() .describe('The publicly accessible URL to download the file.') .optional() }) @@ -16333,31 +15598,30 @@ export namespace stripe { ) export type FileLink = z.infer - /** A customer's `Cash balance` represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account. */ + /**A customer's `Cash balance` represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account.*/ export const CashBalanceSchema = z .object({ - /** A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /**A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).*/ available: z .record(z.number().int()) - .nullable() .describe( 'A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).' ) .optional(), - /** The ID of the customer whose cash balance this object represents. */ + /**The ID of the customer whose cash balance this object represents.*/ customer: z .string() .max(5000) .describe( 'The ID of the customer whose cash balance this object represents.' ), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('cash_balance') .describe( @@ -16371,58 +15635,42 @@ export namespace stripe { export type CashBalance = z.infer export const SourceOwnerSchema = z.object({ - /** Owner's address. */ - address: AddressSchema.nullable().describe("Owner's address.").optional(), - /** Owner's email address. */ - email: z - .string() - .max(5000) - .nullable() - .describe("Owner's email address.") - .optional(), - /** Owner's full name. */ - name: z - .string() - .max(5000) - .nullable() - .describe("Owner's full name.") - .optional(), - /** Owner's phone number (including extension). */ + /**Owner's address.*/ + address: AddressSchema.describe("Owner's address.").optional(), + /**Owner's email address.*/ + email: z.string().max(5000).describe("Owner's email address.").optional(), + /**Owner's full name.*/ + name: z.string().max(5000).describe("Owner's full name.").optional(), + /**Owner's phone number (including extension).*/ phone: z .string() .max(5000) - .nullable() .describe("Owner's phone number (including extension).") .optional(), - /** Verified owner's address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - verified_address: AddressSchema.nullable() - .describe( - "Verified owner's address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated." - ) - .optional(), - /** Verified owner's email address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /**Verified owner's address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.*/ + verified_address: AddressSchema.describe( + "Verified owner's address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated." + ).optional(), + /**Verified owner's email address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.*/ verified_email: z .string() .max(5000) - .nullable() .describe( "Verified owner's email address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated." ) .optional(), - /** Verified owner's full name. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /**Verified owner's full name. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.*/ verified_name: z .string() .max(5000) - .nullable() .describe( "Verified owner's full name. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated." ) .optional(), - /** Verified owner's phone number (including extension). Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /**Verified owner's phone number (including extension). Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.*/ verified_phone: z .string() .max(5000) - .nullable() .describe( "Verified owner's phone number (including extension). Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated." ) @@ -16432,29 +15680,26 @@ export namespace stripe { export const ShippingSchema = z.object({ address: AddressSchema.optional(), - /** The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. */ + /**The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.*/ carrier: z .string() .max(5000) - .nullable() .describe( 'The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.' ) .optional(), - /** Recipient name. */ + /**Recipient name.*/ name: z.string().max(5000).describe('Recipient name.').optional(), - /** Recipient phone (including extension). */ + /**Recipient phone (including extension).*/ phone: z .string() .max(5000) - .nullable() .describe('Recipient phone (including extension).') .optional(), - /** The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas. */ + /**The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.*/ tracking_number: z .string() .max(5000) - .nullable() .describe( 'The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.' ) @@ -16463,33 +15708,31 @@ export namespace stripe { export type Shipping = z.infer export const PromotionCodesResourceRestrictionsSchema = z.object({ - /** Promotion code restrictions defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). */ + /**Promotion code restrictions defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).*/ currency_options: z .record(PromotionCodeCurrencyOptionSchema) .describe( 'Promotion code restrictions defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).' ) .optional(), - /** A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices */ + /**A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices*/ first_time_transaction: z .boolean() .describe( 'A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices' ), - /** Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work). */ + /**Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).*/ minimum_amount: z .number() .int() - .nullable() .describe( 'Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).' ) .optional(), - /** Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount */ + /**Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount*/ minimum_amount_currency: z .string() .max(5000) - .nullable() .describe( 'Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount' ) @@ -16500,22 +15743,16 @@ export namespace stripe { > export const BillingDetailsSchema = z.object({ - /** Billing address. */ - address: AddressSchema.nullable().describe('Billing address.').optional(), - /** Email address. */ - email: z - .string() - .max(5000) - .nullable() - .describe('Email address.') - .optional(), - /** Full name. */ - name: z.string().max(5000).nullable().describe('Full name.').optional(), - /** Billing phone number (including extension). */ + /**Billing address.*/ + address: AddressSchema.describe('Billing address.').optional(), + /**Email address.*/ + email: z.string().max(5000).describe('Email address.').optional(), + /**Full name.*/ + name: z.string().max(5000).describe('Full name.').optional(), + /**Billing phone number (including extension).*/ phone: z .string() .max(5000) - .nullable() .describe('Billing phone number (including extension).') .optional() }) @@ -16537,7 +15774,7 @@ export namespace stripe { export const RefundNextActionDisplayDetailsSchema = z.object({ email_sent: EmailSentSchema, - /** The expiry timestamp. */ + /**The expiry timestamp.*/ expires_at: z.number().int().describe('The expiry timestamp.') }) export type RefundNextActionDisplayDetails = z.infer< @@ -16546,68 +15783,59 @@ export namespace stripe { export const DisputeVisaCompellingEvidence3DisputedTransactionSchema = z.object({ - /** User Account ID used to log into business platform. Must be recognizable by the user. */ + /**User Account ID used to log into business platform. Must be recognizable by the user.*/ customer_account_id: z .string() .max(5000) - .nullable() .describe( 'User Account ID used to log into business platform. Must be recognizable by the user.' ) .optional(), - /** Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters. */ + /**Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters.*/ customer_device_fingerprint: z .string() .max(5000) - .nullable() .describe( 'Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters.' ) .optional(), - /** Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters. */ + /**Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters.*/ customer_device_id: z .string() .max(5000) - .nullable() .describe( 'Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters.' ) .optional(), - /** The email address of the customer. */ + /**The email address of the customer.*/ customer_email_address: z .string() .max(5000) - .nullable() .describe('The email address of the customer.') .optional(), - /** The IP address that the customer used when making the purchase. */ + /**The IP address that the customer used when making the purchase.*/ customer_purchase_ip: z .string() .max(5000) - .nullable() .describe( 'The IP address that the customer used when making the purchase.' ) .optional(), - /** Categorization of disputed payment. */ + /**Categorization of disputed payment.*/ merchandise_or_services: z .enum(['merchandise', 'services']) - .nullable() .describe('Categorization of disputed payment.') .optional(), - /** A description of the product or service that was sold. */ + /**A description of the product or service that was sold.*/ product_description: z .string() .max(150_000) - .nullable() .describe('A description of the product or service that was sold.') .optional(), - /** The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission. */ - shipping_address: DisputeTransactionShippingAddressSchema.nullable() - .describe( - 'The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission.' - ) - .optional() + /**The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission.*/ + shipping_address: DisputeTransactionShippingAddressSchema.describe( + 'The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission.' + ).optional() }) export type DisputeVisaCompellingEvidence3DisputedTransaction = z.infer< typeof DisputeVisaCompellingEvidence3DisputedTransactionSchema @@ -16615,69 +15843,61 @@ export namespace stripe { export const DisputeVisaCompellingEvidence3PriorUndisputedTransactionSchema = z.object({ - /** Stripe charge ID for the Visa Compelling Evidence 3.0 eligible prior charge. */ + /**Stripe charge ID for the Visa Compelling Evidence 3.0 eligible prior charge.*/ charge: z .string() .max(5000) .describe( 'Stripe charge ID for the Visa Compelling Evidence 3.0 eligible prior charge.' ), - /** User Account ID used to log into business platform. Must be recognizable by the user. */ + /**User Account ID used to log into business platform. Must be recognizable by the user.*/ customer_account_id: z .string() .max(5000) - .nullable() .describe( 'User Account ID used to log into business platform. Must be recognizable by the user.' ) .optional(), - /** Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters. */ + /**Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters.*/ customer_device_fingerprint: z .string() .max(5000) - .nullable() .describe( 'Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters.' ) .optional(), - /** Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters. */ + /**Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters.*/ customer_device_id: z .string() .max(5000) - .nullable() .describe( 'Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters.' ) .optional(), - /** The email address of the customer. */ + /**The email address of the customer.*/ customer_email_address: z .string() .max(5000) - .nullable() .describe('The email address of the customer.') .optional(), - /** The IP address that the customer used when making the purchase. */ + /**The IP address that the customer used when making the purchase.*/ customer_purchase_ip: z .string() .max(5000) - .nullable() .describe( 'The IP address that the customer used when making the purchase.' ) .optional(), - /** A description of the product or service that was sold. */ + /**A description of the product or service that was sold.*/ product_description: z .string() .max(150_000) - .nullable() .describe('A description of the product or service that was sold.') .optional(), - /** The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission. */ - shipping_address: DisputeTransactionShippingAddressSchema.nullable() - .describe( - 'The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission.' - ) - .optional() + /**The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission.*/ + shipping_address: DisputeTransactionShippingAddressSchema.describe( + 'The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission.' + ).optional() }) export type DisputeVisaCompellingEvidence3PriorUndisputedTransaction = z.infer< @@ -16692,19 +15912,17 @@ export namespace stripe { > export const IssuingCardholderCardIssuingSchema = z.object({ - /** Information about cardholder acceptance of Celtic [Authorized User Terms](https://stripe.com/docs/issuing/cards#accept-authorized-user-terms). Required for cards backed by a Celtic program. */ - user_terms_acceptance: IssuingCardholderUserTermsAcceptanceSchema.nullable() - .describe( - 'Information about cardholder acceptance of Celtic [Authorized User Terms](https://stripe.com/docs/issuing/cards#accept-authorized-user-terms). Required for cards backed by a Celtic program.' - ) - .optional() + /**Information about cardholder acceptance of Celtic [Authorized User Terms](https://stripe.com/docs/issuing/cards#accept-authorized-user-terms). Required for cards backed by a Celtic program.*/ + user_terms_acceptance: IssuingCardholderUserTermsAcceptanceSchema.describe( + 'Information about cardholder acceptance of Celtic [Authorized User Terms](https://stripe.com/docs/issuing/cards#accept-authorized-user-terms). Required for cards backed by a Celtic program.' + ).optional() }) export type IssuingCardholderCardIssuing = z.infer< typeof IssuingCardholderCardIssuingSchema > export const IssuingCardholderAuthorizationControlsSchema = z.object({ - /** Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. */ + /**Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.*/ allowed_categories: z .array( z.enum([ @@ -17005,20 +16223,18 @@ export namespace stripe { 'wrecking_and_salvage_yards' ]) ) - .nullable() .describe( 'Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.' ) .optional(), - /** Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control. */ + /**Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.*/ allowed_merchant_countries: z .array(z.string().max(5000)) - .nullable() .describe( 'Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.' ) .optional(), - /** Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. */ + /**Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.*/ blocked_categories: z .array( z.enum([ @@ -17319,31 +16535,27 @@ export namespace stripe { 'wrecking_and_salvage_yards' ]) ) - .nullable() .describe( 'Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.' ) .optional(), - /** Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control. */ + /**Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.*/ blocked_merchant_countries: z .array(z.string().max(5000)) - .nullable() .describe( 'Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.' ) .optional(), - /** Limit spending with amount-based rules that apply across this cardholder's cards. */ + /**Limit spending with amount-based rules that apply across this cardholder's cards.*/ spending_limits: z .array(IssuingCardholderSpendingLimitSchema) - .nullable() .describe( "Limit spending with amount-based rules that apply across this cardholder's cards." ) .optional(), - /** Currency of the amounts within `spending_limits`. */ + /**Currency of the amounts within `spending_limits`.*/ spending_limits_currency: z .string() - .nullable() .describe('Currency of the amounts within `spending_limits`.') .optional() }) @@ -17351,31 +16563,31 @@ export namespace stripe { typeof IssuingCardholderAuthorizationControlsSchema > - /** A Physical Bundle represents the bundle of physical items - card stock, carrier letter, and envelope - that is shipped to a cardholder when you create a physical card. */ + /**A Physical Bundle represents the bundle of physical items - card stock, carrier letter, and envelope - that is shipped to a cardholder when you create a physical card.*/ export const IssuingPhysicalBundleSchema = z .object({ features: IssuingPhysicalBundleFeaturesSchema, - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Friendly display name. */ + /**Friendly display name.*/ name: z.string().max(5000).describe('Friendly display name.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('issuing.physical_bundle') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** Whether this physical bundle can be used to create cards. */ + /**Whether this physical bundle can be used to create cards.*/ status: z .enum(['active', 'inactive', 'review']) .describe('Whether this physical bundle can be used to create cards.'), - /** Whether this physical bundle is a standard Stripe offering or custom-made for you. */ + /**Whether this physical bundle is a standard Stripe offering or custom-made for you.*/ type: z .enum(['custom', 'standard']) .describe( @@ -17390,18 +16602,17 @@ export namespace stripe { > export const IssuingCardShippingAddressValidationSchema = z.object({ - /** The address validation capabilities to use. */ + /**The address validation capabilities to use.*/ mode: z .enum(['disabled', 'normalization_only', 'validation_and_normalization']) .describe('The address validation capabilities to use.'), - /** The normalized shipping address. */ - normalized_address: AddressSchema.nullable() - .describe('The normalized shipping address.') - .optional(), - /** The validation result for the shipping address. */ + /**The normalized shipping address.*/ + normalized_address: AddressSchema.describe( + 'The normalized shipping address.' + ).optional(), + /**The validation result for the shipping address.*/ result: z .enum(['indeterminate', 'likely_deliverable', 'likely_undeliverable']) - .nullable() .describe('The validation result for the shipping address.') .optional() }) @@ -17410,7 +16621,7 @@ export namespace stripe { > export const IssuingCardAuthorizationControlsSchema = z.object({ - /** Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. */ + /**Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.*/ allowed_categories: z .array( z.enum([ @@ -17711,20 +16922,18 @@ export namespace stripe { 'wrecking_and_salvage_yards' ]) ) - .nullable() .describe( 'Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.' ) .optional(), - /** Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control. */ + /**Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.*/ allowed_merchant_countries: z .array(z.string().max(5000)) - .nullable() .describe( 'Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control.' ) .optional(), - /** Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. */ + /**Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.*/ blocked_categories: z .array( z.enum([ @@ -18025,31 +17234,27 @@ export namespace stripe { 'wrecking_and_salvage_yards' ]) ) - .nullable() .describe( 'Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`.' ) .optional(), - /** Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control. */ + /**Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.*/ blocked_merchant_countries: z .array(z.string().max(5000)) - .nullable() .describe( 'Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control.' ) .optional(), - /** Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain). */ + /**Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain).*/ spending_limits: z .array(IssuingCardSpendingLimitSchema) - .nullable() .describe( "Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain)." ) .optional(), - /** Currency of the amounts within `spending_limits`. Always the same as the currency of the card. */ + /**Currency of the amounts within `spending_limits`. Always the same as the currency of the card.*/ spending_limits_currency: z .string() - .nullable() .describe( 'Currency of the amounts within `spending_limits`. Always the same as the currency of the card.' ) @@ -18060,47 +17265,44 @@ export namespace stripe { > export const IssuingAuthorizationPendingRequestSchema = z.object({ - /** The additional amount Stripe will hold if the authorization is approved, in the card's [currency](https://stripe.com/docs/api#issuing_authorization_object-pending-request-currency) and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /**The additional amount Stripe will hold if the authorization is approved, in the card's [currency](https://stripe.com/docs/api#issuing_authorization_object-pending-request-currency) and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).*/ amount: z .number() .int() .describe( "The additional amount Stripe will hold if the authorization is approved, in the card's [currency](https://stripe.com/docs/api#issuing_authorization_object-pending-request-currency) and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal)." ), - /** Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ - amount_details: IssuingAuthorizationAmountDetailsSchema.nullable() - .describe( - 'Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).' - ) - .optional(), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).*/ + amount_details: IssuingAuthorizationAmountDetailsSchema.describe( + 'Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).' + ).optional(), + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization. */ + /**If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization.*/ is_amount_controllable: z .boolean() .describe( 'If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization.' ), - /** The amount the merchant is requesting to be authorized in the `merchant_currency`. The amount is in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /**The amount the merchant is requesting to be authorized in the `merchant_currency`. The amount is in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).*/ merchant_amount: z .number() .int() .describe( 'The amount the merchant is requesting to be authorized in the `merchant_currency`. The amount is in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).' ), - /** The local currency the merchant is requesting to authorize. */ + /**The local currency the merchant is requesting to authorize.*/ merchant_currency: z .string() .describe('The local currency the merchant is requesting to authorize.'), - /** The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99. */ + /**The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99.*/ network_risk_score: z .number() .int() - .nullable() .describe( "The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99." ) @@ -18111,68 +17313,64 @@ export namespace stripe { > export const IssuingAuthorizationRequestSchema = z.object({ - /** The `pending_request.amount` at the time of the request, presented in your card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Stripe held this amount from your account to fund the authorization if the request was approved. */ + /**The `pending_request.amount` at the time of the request, presented in your card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Stripe held this amount from your account to fund the authorization if the request was approved.*/ amount: z .number() .int() .describe( "The `pending_request.amount` at the time of the request, presented in your card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Stripe held this amount from your account to fund the authorization if the request was approved." ), - /** Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ - amount_details: IssuingAuthorizationAmountDetailsSchema.nullable() - .describe( - 'Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).' - ) - .optional(), - /** Whether this request was approved. */ + /**Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).*/ + amount_details: IssuingAuthorizationAmountDetailsSchema.describe( + 'Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).' + ).optional(), + /**Whether this request was approved.*/ approved: z.boolean().describe('Whether this request was approved.'), - /** A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter "S", followed by a six-digit number. For example, "S498162". Please note that the code is not guaranteed to be unique across authorizations. */ + /**A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter "S", followed by a six-digit number. For example, "S498162". Please note that the code is not guaranteed to be unique across authorizations.*/ authorization_code: z .string() .max(5000) - .nullable() .describe( 'A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter "S", followed by a six-digit number. For example, "S498162". Please note that the code is not guaranteed to be unique across authorizations.' ) .optional(), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .max(5000) .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** The `pending_request.merchant_amount` at the time of the request, presented in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /**The `pending_request.merchant_amount` at the time of the request, presented in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).*/ merchant_amount: z .number() .int() .describe( 'The `pending_request.merchant_amount` at the time of the request, presented in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).' ), - /** The currency that was collected by the merchant and presented to the cardholder for the authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**The currency that was collected by the merchant and presented to the cardholder for the authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ merchant_currency: z .string() .max(5000) .describe( 'The currency that was collected by the merchant and presented to the cardholder for the authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99. */ + /**The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99.*/ network_risk_score: z .number() .int() - .nullable() .describe( "The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99." ) .optional(), - /** When an authorization is approved or declined by you or by Stripe, this field provides additional detail on the reason for the outcome. */ + /**When an authorization is approved or declined by you or by Stripe, this field provides additional detail on the reason for the outcome.*/ reason: z .enum([ 'account_disabled', @@ -18198,20 +17396,18 @@ export namespace stripe { .describe( 'When an authorization is approved or declined by you or by Stripe, this field provides additional detail on the reason for the outcome.' ), - /** If the `request_history.reason` is `webhook_error` because the direct webhook response is invalid (for example, parsing errors or missing parameters), we surface a more detailed error message via this field. */ + /**If the `request_history.reason` is `webhook_error` because the direct webhook response is invalid (for example, parsing errors or missing parameters), we surface a more detailed error message via this field.*/ reason_message: z .string() .max(5000) - .nullable() .describe( 'If the `request_history.reason` is `webhook_error` because the direct webhook response is invalid (for example, parsing errors or missing parameters), we surface a more detailed error message via this field.' ) .optional(), - /** Time when the card network received an authorization request from the acquirer in UTC. Referred to by networks as transmission time. */ + /**Time when the card network received an authorization request from the acquirer in UTC. Referred to by networks as transmission time.*/ requested_at: z .number() .int() - .nullable() .describe( 'Time when the card network received an authorization request from the acquirer in UTC. Referred to by networks as transmission time.' ) @@ -18222,7 +17418,7 @@ export namespace stripe { > export const IssuingNetworkTokenWalletProviderSchema = z.object({ - /** The wallet provider-given account ID of the digital wallet the token belongs to. */ + /**The wallet provider-given account ID of the digital wallet the token belongs to.*/ account_id: z .string() .max(5000) @@ -18230,7 +17426,7 @@ export namespace stripe { 'The wallet provider-given account ID of the digital wallet the token belongs to.' ) .optional(), - /** An evaluation on the trustworthiness of the wallet account between 1 and 5. A higher score indicates more trustworthy. */ + /**An evaluation on the trustworthiness of the wallet account between 1 and 5. A higher score indicates more trustworthy.*/ account_trust_score: z .number() .int() @@ -18238,19 +17434,19 @@ export namespace stripe { 'An evaluation on the trustworthiness of the wallet account between 1 and 5. A higher score indicates more trustworthy.' ) .optional(), - /** The method used for tokenizing a card. */ + /**The method used for tokenizing a card.*/ card_number_source: z .enum(['app', 'manual', 'on_file', 'other']) .describe('The method used for tokenizing a card.') .optional(), cardholder_address: IssuingNetworkTokenAddressSchema.optional(), - /** The name of the cardholder tokenizing the card. */ + /**The name of the cardholder tokenizing the card.*/ cardholder_name: z .string() .max(5000) .describe('The name of the cardholder tokenizing the card.') .optional(), - /** An evaluation on the trustworthiness of the device. A higher score indicates more trustworthy. */ + /**An evaluation on the trustworthiness of the device. A higher score indicates more trustworthy.*/ device_trust_score: z .number() .int() @@ -18258,7 +17454,7 @@ export namespace stripe { 'An evaluation on the trustworthiness of the device. A higher score indicates more trustworthy.' ) .optional(), - /** The hashed email address of the cardholder's account with the wallet provider. */ + /**The hashed email address of the cardholder's account with the wallet provider.*/ hashed_account_email_address: z .string() .max(5000) @@ -18266,7 +17462,7 @@ export namespace stripe { "The hashed email address of the cardholder's account with the wallet provider." ) .optional(), - /** The reasons for suggested tokenization given by the card network. */ + /**The reasons for suggested tokenization given by the card network.*/ reason_codes: z .array( z.enum([ @@ -18304,12 +17500,12 @@ export namespace stripe { 'The reasons for suggested tokenization given by the card network.' ) .optional(), - /** The recommendation on responding to the tokenization request. */ + /**The recommendation on responding to the tokenization request.*/ suggested_decision: z .enum(['approve', 'decline', 'require_auth']) .describe('The recommendation on responding to the tokenization request.') .optional(), - /** The version of the standard for mapping reason codes followed by the wallet provider. */ + /**The version of the standard for mapping reason codes followed by the wallet provider.*/ suggested_decision_version: z .string() .max(5000) @@ -18323,37 +17519,32 @@ export namespace stripe { > export const IssuingTransactionFlightDataSchema = z.object({ - /** The time that the flight departed. */ + /**The time that the flight departed.*/ departure_at: z .number() .int() - .nullable() .describe('The time that the flight departed.') .optional(), - /** The name of the passenger. */ + /**The name of the passenger.*/ passenger_name: z .string() .max(5000) - .nullable() .describe('The name of the passenger.') .optional(), - /** Whether the ticket is refundable. */ + /**Whether the ticket is refundable.*/ refundable: z .boolean() - .nullable() .describe('Whether the ticket is refundable.') .optional(), - /** The legs of the trip. */ + /**The legs of the trip.*/ segments: z .array(IssuingTransactionFlightDataLegSchema) - .nullable() .describe('The legs of the trip.') .optional(), - /** The travel agency that issued the ticket. */ + /**The travel agency that issued the ticket.*/ travel_agency: z .string() .max(5000) - .nullable() .describe('The travel agency that issued the ticket.') .optional() }) @@ -18362,51 +17553,46 @@ export namespace stripe { > export const ChargeOutcomeSchema = z.object({ - /** An enumerated value providing a more detailed explanation on [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines). */ + /**An enumerated value providing a more detailed explanation on [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines).*/ advice_code: z .enum(['confirm_card_data', 'do_not_try_again', 'try_again_later']) - .nullable() .describe( 'An enumerated value providing a more detailed explanation on [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines).' ) .optional(), - /** For charges declined by the network, a 2 digit code which indicates the advice returned by the network on how to proceed with an error. */ + /**For charges declined by the network, a 2 digit code which indicates the advice returned by the network on how to proceed with an error.*/ network_advice_code: z .string() .max(5000) - .nullable() .describe( 'For charges declined by the network, a 2 digit code which indicates the advice returned by the network on how to proceed with an error.' ) .optional(), - /** For charges declined by the network, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed. */ + /**For charges declined by the network, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed.*/ network_decline_code: z .string() .max(5000) - .nullable() .describe( 'For charges declined by the network, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed.' ) .optional(), - /** Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was [blocked by Stripe](https://stripe.com/docs/declines#blocked-payments) after bank authorization, and may temporarily appear as "pending" on a cardholder's statement. */ + /**Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was [blocked by Stripe](https://stripe.com/docs/declines#blocked-payments) after bank authorization, and may temporarily appear as "pending" on a cardholder's statement.*/ network_status: z .string() .max(5000) - .nullable() .describe( 'Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was [blocked by Stripe](https://stripe.com/docs/declines#blocked-payments) after bank authorization, and may temporarily appear as "pending" on a cardholder\'s statement.' ) .optional(), - /** An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See [understanding declines](https://stripe.com/docs/declines) for more details. */ + /**An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See [understanding declines](https://stripe.com/docs/declines) for more details.*/ reason: z .string() .max(5000) - .nullable() .describe( "An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See [understanding declines](https://stripe.com/docs/declines) for more details." ) .optional(), - /** Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are `normal`, `elevated`, `highest`. For non-card payments, and card-based payments predating the public assignment of risk levels, this field will have the value `not_assessed`. In the event of an error in the evaluation, this field will have the value `unknown`. This field is only available with Radar. */ + /**Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are `normal`, `elevated`, `highest`. For non-card payments, and card-based payments predating the public assignment of risk levels, this field will have the value `not_assessed`. In the event of an error in the evaluation, this field will have the value `unknown`. This field is only available with Radar.*/ risk_level: z .string() .max(5000) @@ -18414,7 +17600,7 @@ export namespace stripe { "Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are `normal`, `elevated`, `highest`. For non-card payments, and card-based payments predating the public assignment of risk levels, this field will have the value `not_assessed`. In the event of an error in the evaluation, this field will have the value `unknown`. This field is only available with Radar." ) .optional(), - /** Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are between 0 and 100. For non-card payments, card-based payments predating the public assignment of risk scores, or in the event of an error during evaluation, this field will not be present. This field is only available with Radar for Fraud Teams. */ + /**Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are between 0 and 100. For non-card payments, card-based payments predating the public assignment of risk scores, or in the event of an error during evaluation, this field will not be present. This field is only available with Radar for Fraud Teams.*/ risk_score: z .number() .int() @@ -18422,23 +17608,22 @@ export namespace stripe { "Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are between 0 and 100. For non-card payments, card-based payments predating the public assignment of risk scores, or in the event of an error during evaluation, this field will not be present. This field is only available with Radar for Fraud Teams." ) .optional(), - /** The ID of the Radar rule that matched the payment, if applicable. */ + /**The ID of the Radar rule that matched the payment, if applicable.*/ rule: z .union([z.string().max(5000), RuleSchema]) .describe( 'The ID of the Radar rule that matched the payment, if applicable.' ) .optional(), - /** A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer. */ + /**A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer.*/ seller_message: z .string() .max(5000) - .nullable() .describe( 'A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer.' ) .optional(), - /** Possible values are `authorized`, `manual_review`, `issuer_declined`, `blocked`, and `invalid`. See [understanding declines](https://stripe.com/docs/declines) and [Radar reviews](https://stripe.com/docs/radar/reviews) for details. */ + /**Possible values are `authorized`, `manual_review`, `issuer_declined`, `blocked`, and `invalid`. See [understanding declines](https://stripe.com/docs/declines) and [Radar reviews](https://stripe.com/docs/radar/reviews) for details.*/ type: z .string() .max(5000) @@ -18450,10 +17635,9 @@ export namespace stripe { export const AmazonPayUnderlyingPaymentMethodFundingDetailsSchema = z.object({ card: PaymentMethodDetailsPassthroughCardSchema.optional(), - /** funding type of the underlying payment method. */ + /**funding type of the underlying payment method.*/ type: z .literal('card') - .nullable() .describe('funding type of the underlying payment method.') .optional() }) @@ -18462,135 +17646,118 @@ export namespace stripe { > export const PaymentMethodDetailsCardInstallmentsSchema = z.object({ - /** Installment plan selected for the payment. */ - plan: PaymentMethodDetailsCardInstallmentsPlanSchema.nullable() - .describe('Installment plan selected for the payment.') - .optional() + /**Installment plan selected for the payment.*/ + plan: PaymentMethodDetailsCardInstallmentsPlanSchema.describe( + 'Installment plan selected for the payment.' + ).optional() }) export type PaymentMethodDetailsCardInstallments = z.infer< typeof PaymentMethodDetailsCardInstallmentsSchema > export const PaymentMethodDetailsCardWalletMasterpassSchema = z.object({ - /** Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - billing_address: AddressSchema.nullable() - .describe( - "Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated." - ) - .optional(), - /** Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /**Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.*/ + billing_address: AddressSchema.describe( + "Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated." + ).optional(), + /**Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.*/ email: z .string() .max(5000) - .nullable() .describe( "Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated." ) .optional(), - /** Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /**Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.*/ name: z .string() .max(5000) - .nullable() .describe( "Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated." ) .optional(), - /** Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - shipping_address: AddressSchema.nullable() - .describe( - "Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated." - ) - .optional() + /**Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.*/ + shipping_address: AddressSchema.describe( + "Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated." + ).optional() }) export type PaymentMethodDetailsCardWalletMasterpass = z.infer< typeof PaymentMethodDetailsCardWalletMasterpassSchema > export const PaymentMethodDetailsCardWalletVisaCheckoutSchema = z.object({ - /** Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - billing_address: AddressSchema.nullable() - .describe( - "Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated." - ) - .optional(), - /** Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /**Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.*/ + billing_address: AddressSchema.describe( + "Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated." + ).optional(), + /**Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.*/ email: z .string() .max(5000) - .nullable() .describe( "Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated." ) .optional(), - /** Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /**Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.*/ name: z .string() .max(5000) - .nullable() .describe( "Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated." ) .optional(), - /** Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - shipping_address: AddressSchema.nullable() - .describe( - "Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated." - ) - .optional() + /**Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.*/ + shipping_address: AddressSchema.describe( + "Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated." + ).optional() }) export type PaymentMethodDetailsCardWalletVisaCheckout = z.infer< typeof PaymentMethodDetailsCardWalletVisaCheckoutSchema > export const PaymentMethodDetailsInteracPresentSchema = z.object({ - /** Card brand. Can be `interac`, `mastercard` or `visa`. */ + /**Card brand. Can be `interac`, `mastercard` or `visa`.*/ brand: z .string() .max(5000) - .nullable() .describe('Card brand. Can be `interac`, `mastercard` or `visa`.') .optional(), - /** The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay. */ + /**The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.*/ cardholder_name: z .string() .max(5000) - .nullable() .describe( 'The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.' ) .optional(), - /** Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. */ + /**Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.*/ country: z .string() .max(5000) - .nullable() .describe( "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected." ) .optional(), - /** A high-level description of the type of cards issued in this range. */ + /**A high-level description of the type of cards issued in this range.*/ description: z .string() .max(5000) - .nullable() .describe( 'A high-level description of the type of cards issued in this range.' ) .optional(), - /** Authorization response cryptogram. */ + /**Authorization response cryptogram.*/ emv_auth_data: z .string() .max(5000) - .nullable() .describe('Authorization response cryptogram.') .optional(), - /** Two-digit number representing the card's expiration month. */ + /**Two-digit number representing the card's expiration month.*/ exp_month: z .number() .int() .describe("Two-digit number representing the card's expiration month."), - /** Four-digit number representing the card's expiration year. */ + /**Four-digit number representing the card's expiration year.*/ exp_year: z .number() .int() @@ -18603,70 +17770,62 @@ export namespace stripe { fingerprint: z .string() .max(5000) - .nullable() .describe( 'Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*' ) .optional(), - /** Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ + /**Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.*/ funding: z .string() .max(5000) - .nullable() .describe( 'Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.' ) .optional(), - /** ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod. */ + /**ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.*/ generated_card: z .string() .max(5000) - .nullable() .describe( 'ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.' ) .optional(), - /** The name of the card's issuing bank. */ + /**The name of the card's issuing bank.*/ issuer: z .string() .max(5000) - .nullable() .describe("The name of the card's issuing bank.") .optional(), - /** The last four digits of the card. */ + /**The last four digits of the card.*/ last4: z .string() .max(5000) - .nullable() .describe('The last four digits of the card.') .optional(), - /** Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /**Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.*/ network: z .string() .max(5000) - .nullable() .describe( 'Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.' ) .optional(), - /** This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise. */ + /**This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.*/ network_transaction_id: z .string() .max(5000) - .nullable() .describe( 'This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.' ) .optional(), - /** EMV tag 5F2D. Preferred languages specified by the integrated circuit chip. */ + /**EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.*/ preferred_locales: z .array(z.string().max(5000)) - .nullable() .describe( 'EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.' ) .optional(), - /** How card details were read in this transaction. */ + /**How card details were read in this transaction.*/ read_method: z .enum([ 'contact_emv', @@ -18675,56 +17834,46 @@ export namespace stripe { 'magnetic_stripe_fallback', 'magnetic_stripe_track2' ]) - .nullable() .describe('How card details were read in this transaction.') .optional(), - /** A collection of fields required to be displayed on receipts. Only required for EMV transactions. */ - receipt: PaymentMethodDetailsInteracPresentReceiptSchema.nullable() - .describe( - 'A collection of fields required to be displayed on receipts. Only required for EMV transactions.' - ) - .optional() + /**A collection of fields required to be displayed on receipts. Only required for EMV transactions.*/ + receipt: PaymentMethodDetailsInteracPresentReceiptSchema.describe( + 'A collection of fields required to be displayed on receipts. Only required for EMV transactions.' + ).optional() }) export type PaymentMethodDetailsInteracPresent = z.infer< typeof PaymentMethodDetailsInteracPresentSchema > export const KlarnaPayerDetailsSchema = z.object({ - /** The payer's address */ - address: KlarnaAddressSchema.nullable() - .describe("The payer's address") - .optional() + /**The payer's address*/ + address: KlarnaAddressSchema.describe("The payer's address").optional() }) export type KlarnaPayerDetails = z.infer export const PaymentMethodDetailsKonbiniSchema = z.object({ - /** If the payment succeeded, this contains the details of the convenience store where the payment was completed. */ - store: PaymentMethodDetailsKonbiniStoreSchema.nullable() - .describe( - 'If the payment succeeded, this contains the details of the convenience store where the payment was completed.' - ) - .optional() + /**If the payment succeeded, this contains the details of the convenience store where the payment was completed.*/ + store: PaymentMethodDetailsKonbiniStoreSchema.describe( + 'If the payment succeeded, this contains the details of the convenience store where the payment was completed.' + ).optional() }) export type PaymentMethodDetailsKonbini = z.infer< typeof PaymentMethodDetailsKonbiniSchema > export const PaymentMethodDetailsMobilepaySchema = z.object({ - /** Internal card details */ - card: InternalCardSchema.nullable() - .describe('Internal card details') - .optional() + /**Internal card details*/ + card: InternalCardSchema.describe('Internal card details').optional() }) export type PaymentMethodDetailsMobilepay = z.infer< typeof PaymentMethodDetailsMobilepaySchema > export const PaymentMethodDetailsPaypalSchema = z.object({ - /** Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /**Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.*/ country: z .string() .max(5000) - .nullable() .describe( "Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated." ) @@ -18736,16 +17885,14 @@ export namespace stripe { payer_email: z .string() .max(5000) - .nullable() .describe( "Owner's email. Values are provided by PayPal directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated." ) .optional(), - /** PayPal account PayerID. This identifier uniquely identifies the PayPal customer. */ + /**PayPal account PayerID. This identifier uniquely identifies the PayPal customer.*/ payer_id: z .string() .max(5000) - .nullable() .describe( 'PayPal account PayerID. This identifier uniquely identifies the PayPal customer.' ) @@ -18757,22 +17904,18 @@ export namespace stripe { payer_name: z .string() .max(5000) - .nullable() .describe( "Owner's full name. Values provided by PayPal directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated." ) .optional(), - /** The level of protection offered as defined by PayPal Seller Protection for Merchants, for this transaction. */ - seller_protection: PaypalSellerProtectionSchema.nullable() - .describe( - 'The level of protection offered as defined by PayPal Seller Protection for Merchants, for this transaction.' - ) - .optional(), - /** A unique ID generated by PayPal for this transaction. */ + /**The level of protection offered as defined by PayPal Seller Protection for Merchants, for this transaction.*/ + seller_protection: PaypalSellerProtectionSchema.describe( + 'The level of protection offered as defined by PayPal Seller Protection for Merchants, for this transaction.' + ).optional(), + /**A unique ID generated by PayPal for this transaction.*/ transaction_id: z .string() .max(5000) - .nullable() .describe('A unique ID generated by PayPal for this transaction.') .optional() }) @@ -18783,10 +17926,9 @@ export namespace stripe { export const RevolutPayUnderlyingPaymentMethodFundingDetailsSchema = z.object( { card: PaymentMethodDetailsPassthroughCardSchema.optional(), - /** funding type of the underlying payment method. */ + /**funding type of the underlying payment method.*/ type: z .literal('card') - .nullable() .describe('funding type of the underlying payment method.') .optional() } @@ -18802,38 +17944,36 @@ export namespace stripe { */ export const TaxRateSchema = z .object({ - /** Defaults to `true`. When set to `false`, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. */ + /**Defaults to `true`. When set to `false`, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.*/ active: z .boolean() .describe( 'Defaults to `true`. When set to `false`, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.' ), - /** Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ + /**Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).*/ country: z .string() .max(5000) - .nullable() .describe( 'Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).' ) .optional(), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers. */ + /**An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.*/ description: z .string() .max(5000) - .nullable() .describe( 'An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.' ) .optional(), - /** The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page. */ + /**The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.*/ display_name: z .string() .max(5000) @@ -18847,84 +17987,76 @@ export namespace stripe { */ effective_percentage: z .number() - .nullable() .describe( "Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true,\nthis percentage reflects the rate actually used to calculate tax based on the product's taxability\nand whether the user is registered to collect taxes in the corresponding jurisdiction." ) .optional(), - /** The amount of the tax rate when the `rate_type` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate. */ - flat_amount: TaxRateFlatAmountSchema.nullable() - .describe( - 'The amount of the tax rate when the `rate_type` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate.' - ) - .optional(), - /** Unique identifier for the object. */ + /**The amount of the tax rate when the `rate_type` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate.*/ + flat_amount: TaxRateFlatAmountSchema.describe( + 'The amount of the tax rate when the `rate_type` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate.' + ).optional(), + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** This specifies if the tax rate is inclusive or exclusive. */ + /**This specifies if the tax rate is inclusive or exclusive.*/ inclusive: z .boolean() .describe('This specifies if the tax rate is inclusive or exclusive.'), - /** The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice. */ + /**The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.*/ jurisdiction: z .string() .max(5000) - .nullable() .describe( 'The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.' ) .optional(), - /** The level of the jurisdiction that imposes this tax rate. Will be `null` for manually defined tax rates. */ + /**The level of the jurisdiction that imposes this tax rate. Will be `null` for manually defined tax rates.*/ jurisdiction_level: z .enum(['city', 'country', 'county', 'district', 'multiple', 'state']) - .nullable() .describe( 'The level of the jurisdiction that imposes this tax rate. Will be `null` for manually defined tax rates.' ) .optional(), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) - .nullable() .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ) .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('tax_rate') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions. */ + /**Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.*/ percentage: z .number() .describe( 'Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.' ), - /** Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location. */ + /**Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location.*/ rate_type: z .enum(['flat_amount', 'percentage']) - .nullable() .describe( 'Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location.' ) .optional(), - /** [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States. */ + /**[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States.*/ state: z .string() .max(5000) - .nullable() .describe( '[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States.' ) .optional(), - /** The high-level tax type, such as `vat` or `sales_tax`. */ + /**The high-level tax type, such as `vat` or `sales_tax`.*/ tax_type: z .enum([ 'amusement_tax', @@ -18942,7 +18074,6 @@ export namespace stripe { 'service_tax', 'vat' ]) - .nullable() .describe('The high-level tax type, such as `vat` or `sales_tax`.') .optional() }) @@ -18954,7 +18085,7 @@ export namespace stripe { export const InvoicePaymentMethodOptionsAcssDebitSchema = z.object({ mandate_options: InvoicePaymentMethodOptionsAcssDebitMandateOptionsSchema.optional(), - /** Bank account verification method. */ + /**Bank account verification method.*/ verification_method: z .enum(['automatic', 'instant', 'microdeposits']) .describe('Bank account verification method.') @@ -18966,7 +18097,7 @@ export namespace stripe { export const SubscriptionPaymentMethodOptionsCardSchema = z.object({ mandate_options: InvoiceMandateOptionsCardSchema.optional(), - /** Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time. */ + /**Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.*/ network: z .enum([ 'amex', @@ -18983,15 +18114,13 @@ export namespace stripe { 'unknown', 'visa' ]) - .nullable() .describe( 'Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.' ) .optional(), - /** We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. */ + /**We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.*/ request_three_d_secure: z .enum(['any', 'automatic', 'challenge']) - .nullable() .describe( 'We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.' ) @@ -19005,10 +18134,9 @@ export namespace stripe { z.object({ eu_bank_transfer: InvoicePaymentMethodOptionsCustomerBalanceBankTransferEuBankTransferSchema.optional(), - /** The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`. */ + /**The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.*/ type: z .string() - .nullable() .describe( 'The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.' ) @@ -19022,7 +18150,7 @@ export namespace stripe { z.object({ filters: InvoicePaymentMethodOptionsUsBankAccountLinkedAccountOptionsFiltersSchema.optional(), - /** The list of permissions to request. The `payment_method` permission must be included. */ + /**The list of permissions to request. The `payment_method` permission must be included.*/ permissions: z .array( z.enum(['balances', 'ownership', 'payment_method', 'transactions']) @@ -19031,10 +18159,9 @@ export namespace stripe { 'The list of permissions to request. The `payment_method` permission must be included.' ) .optional(), - /** Data features requested to be retrieved upon account creation. */ + /**Data features requested to be retrieved upon account creation.*/ prefetch: z .array(z.enum(['balances', 'ownership', 'transactions'])) - .nullable() .describe( 'Data features requested to be retrieved upon account creation.' ) @@ -19047,14 +18174,14 @@ export namespace stripe { export const PaymentIntentNextActionCashappHandleRedirectOrDisplayQrCodeSchema = z.object({ - /** The URL to the hosted Cash App Pay instructions page, which allows customers to view the QR code, and supports QR code refreshing on expiration. */ + /**The URL to the hosted Cash App Pay instructions page, which allows customers to view the QR code, and supports QR code refreshing on expiration.*/ hosted_instructions_url: z .string() .max(5000) .describe( 'The URL to the hosted Cash App Pay instructions page, which allows customers to view the QR code, and supports QR code refreshing on expiration.' ), - /** The url for mobile redirect based auth */ + /**The url for mobile redirect based auth*/ mobile_auth_url: z .string() .max(5000) @@ -19067,15 +18194,14 @@ export namespace stripe { > export const SetupIntentPaymentMethodOptionsAcssDebitSchema = z.object({ - /** Currency supported by the bank account */ + /**Currency supported by the bank account*/ currency: z .enum(['cad', 'usd']) - .nullable() .describe('Currency supported by the bank account') .optional(), mandate_options: SetupIntentPaymentMethodOptionsMandateOptionsAcssDebitSchema.optional(), - /** Bank account verification method. */ + /**Bank account verification method.*/ verification_method: z .enum(['automatic', 'instant', 'microdeposits']) .describe('Bank account verification method.') @@ -19094,14 +18220,12 @@ export namespace stripe { > export const SetupIntentPaymentMethodOptionsCardSchema = z.object({ - /** Configuration options for setting up an eMandate for cards issued in India. */ + /**Configuration options for setting up an eMandate for cards issued in India.*/ mandate_options: - SetupIntentPaymentMethodOptionsCardMandateOptionsSchema.nullable() - .describe( - 'Configuration options for setting up an eMandate for cards issued in India.' - ) - .optional(), - /** Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the setup intent. Can be only set confirm-time. */ + SetupIntentPaymentMethodOptionsCardMandateOptionsSchema.describe( + 'Configuration options for setting up an eMandate for cards issued in India.' + ).optional(), + /**Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the setup intent. Can be only set confirm-time.*/ network: z .enum([ 'amex', @@ -19118,15 +18242,13 @@ export namespace stripe { 'unknown', 'visa' ]) - .nullable() .describe( 'Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the setup intent. Can be only set confirm-time.' ) .optional(), - /** We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. */ + /**We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.*/ request_three_d_secure: z .enum(['any', 'automatic', 'challenge']) - .nullable() .describe( 'We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.' ) @@ -19147,7 +18269,7 @@ export namespace stripe { export const LinkedAccountOptionsUsBankAccountSchema = z.object({ filters: PaymentFlowsPrivatePaymentMethodsUsBankAccountLinkedAccountOptionsFiltersSchema.optional(), - /** The list of permissions to request. The `payment_method` permission must be included. */ + /**The list of permissions to request. The `payment_method` permission must be included.*/ permissions: z .array( z.enum(['balances', 'ownership', 'payment_method', 'transactions']) @@ -19156,15 +18278,14 @@ export namespace stripe { 'The list of permissions to request. The `payment_method` permission must be included.' ) .optional(), - /** Data features requested to be retrieved upon account creation. */ + /**Data features requested to be retrieved upon account creation.*/ prefetch: z .array(z.enum(['balances', 'ownership', 'transactions'])) - .nullable() .describe( 'Data features requested to be retrieved upon account creation.' ) .optional(), - /** For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. */ + /**For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.*/ return_url: z .string() .max(5000) @@ -19187,7 +18308,7 @@ export namespace stripe { typeof BillingClocksResourceStatusDetailsStatusDetailsSchema > - /** Configures how this subscription behaves during the trial period. */ + /**Configures how this subscription behaves during the trial period.*/ export const SubscriptionsTrialsResourceTrialSettingsSchema = z .object({ end_behavior: SubscriptionsTrialsResourceEndBehaviorSchema }) .describe( @@ -19198,11 +18319,11 @@ export namespace stripe { > export const BillingCreditGrantsResourceAmountSchema = z.object({ - /** The monetary amount. */ - monetary: BillingCreditGrantsResourceMonetaryAmountSchema.nullable() - .describe('The monetary amount.') - .optional(), - /** The type of this amount. We currently only support `monetary` billing credits. */ + /**The monetary amount.*/ + monetary: BillingCreditGrantsResourceMonetaryAmountSchema.describe( + 'The monetary amount.' + ).optional(), + /**The type of this amount. We currently only support `monetary` billing credits.*/ type: z .literal('monetary') .describe( @@ -19214,14 +18335,14 @@ export namespace stripe { > export const BillingCreditGrantsResourceScopeSchema = z.object({ - /** The price type that credit grants can apply to. We currently only support the `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them. */ + /**The price type that credit grants can apply to. We currently only support the `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them.*/ price_type: z .literal('metered') .describe( 'The price type that credit grants can apply to. We currently only support the `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them.' ) .optional(), - /** The prices that credit grants can apply to. We currently only support `metered` prices. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them. */ + /**The prices that credit grants can apply to. We currently only support `metered` prices. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them.*/ prices: z .array(BillingCreditGrantsResourceApplicablePriceSchema) .describe( @@ -19234,12 +18355,10 @@ export namespace stripe { > export const InvoicesResourceLineItemsProrationDetailsSchema = z.object({ - /** For a credit proration `line_item`, the original debit line_items to which the credit proration applies. */ - credited_items: InvoicesResourceLineItemsCreditedItemsSchema.nullable() - .describe( - 'For a credit proration `line_item`, the original debit line_items to which the credit proration applies.' - ) - .optional() + /**For a credit proration `line_item`, the original debit line_items to which the credit proration applies.*/ + credited_items: InvoicesResourceLineItemsCreditedItemsSchema.describe( + 'For a credit proration `line_item`, the original debit line_items to which the credit proration applies.' + ).optional() }) export type InvoicesResourceLineItemsProrationDetails = z.infer< typeof InvoicesResourceLineItemsProrationDetailsSchema @@ -19247,10 +18366,9 @@ export namespace stripe { export const InvoicePaymentMethodOptionsCardSchema = z.object({ installments: InvoiceInstallmentsCardSchema.optional(), - /** We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. */ + /**We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.*/ request_three_d_secure: z .enum(['any', 'automatic', 'challenge']) - .nullable() .describe( 'We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.' ) @@ -19261,33 +18379,30 @@ export namespace stripe { > export const InvoicesResourceInvoiceRenderingSchema = z.object({ - /** How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. */ + /**How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.*/ amount_tax_display: z .string() .max(5000) - .nullable() .describe( 'How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.' ) .optional(), - /** Invoice pdf rendering options */ - pdf: InvoiceRenderingPdfSchema.nullable() - .describe('Invoice pdf rendering options') - .optional(), - /** ID of the rendering template that the invoice is formatted by. */ + /**Invoice pdf rendering options*/ + pdf: InvoiceRenderingPdfSchema.describe( + 'Invoice pdf rendering options' + ).optional(), + /**ID of the rendering template that the invoice is formatted by.*/ template: z .string() .max(5000) - .nullable() .describe( 'ID of the rendering template that the invoice is formatted by.' ) .optional(), - /** Version of the rendering template that the invoice is using. */ + /**Version of the rendering template that the invoice is using.*/ template_version: z .number() .int() - .nullable() .describe('Version of the rendering template that the invoice is using.') .optional() }) @@ -19296,38 +18411,34 @@ export namespace stripe { > export const ShippingRateDeliveryEstimateSchema = z.object({ - /** The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite. */ - maximum: ShippingRateDeliveryEstimateBoundSchema.nullable() - .describe( - 'The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.' - ) - .optional(), - /** The lower bound of the estimated range. If empty, represents no lower bound. */ - minimum: ShippingRateDeliveryEstimateBoundSchema.nullable() - .describe( - 'The lower bound of the estimated range. If empty, represents no lower bound.' - ) - .optional() + /**The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.*/ + maximum: ShippingRateDeliveryEstimateBoundSchema.describe( + 'The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.' + ).optional(), + /**The lower bound of the estimated range. If empty, represents no lower bound.*/ + minimum: ShippingRateDeliveryEstimateBoundSchema.describe( + 'The lower bound of the estimated range. If empty, represents no lower bound.' + ).optional() }) export type ShippingRateDeliveryEstimate = z.infer< typeof ShippingRateDeliveryEstimateSchema > export const ShippingRateFixedAmountSchema = z.object({ - /** A non-negative integer in cents representing how much to charge. */ + /**A non-negative integer in cents representing how much to charge.*/ amount: z .number() .int() .describe( 'A non-negative integer in cents representing how much to charge.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). */ + /**Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).*/ currency_options: z .record(ShippingRateCurrencyOptionSchema) .describe( @@ -19340,16 +18451,15 @@ export namespace stripe { > export const InvoiceThresholdReasonSchema = z.object({ - /** The total invoice amount threshold boundary if it triggered the threshold invoice. */ + /**The total invoice amount threshold boundary if it triggered the threshold invoice.*/ amount_gte: z .number() .int() - .nullable() .describe( 'The total invoice amount threshold boundary if it triggered the threshold invoice.' ) .optional(), - /** Indicates which line items triggered a threshold invoice. */ + /**Indicates which line items triggered a threshold invoice.*/ item_reasons: z .array(InvoiceItemThresholdReasonSchema) .describe('Indicates which line items triggered a threshold invoice.') @@ -19358,23 +18468,23 @@ export namespace stripe { typeof InvoiceThresholdReasonSchema > - /** ABA Records contain U.S. bank account details per the ABA format. */ + /**ABA Records contain U.S. bank account details per the ABA format.*/ export const FundingInstructionsBankTransferAbaRecordSchema = z .object({ account_holder_address: AddressSchema, - /** The account holder name */ + /**The account holder name*/ account_holder_name: z .string() .max(5000) .describe('The account holder name'), - /** The ABA account number */ + /**The ABA account number*/ account_number: z.string().max(5000).describe('The ABA account number'), - /** The account type */ + /**The account type*/ account_type: z.string().max(5000).describe('The account type'), bank_address: AddressSchema, - /** The bank name */ + /**The bank name*/ bank_name: z.string().max(5000).describe('The bank name'), - /** The ABA routing number */ + /**The ABA routing number*/ routing_number: z.string().max(5000).describe('The ABA routing number') }) .describe( @@ -19384,11 +18494,11 @@ export namespace stripe { typeof FundingInstructionsBankTransferAbaRecordSchema > - /** Iban Records contain E.U. bank account details per the SEPA format. */ + /**Iban Records contain E.U. bank account details per the SEPA format.*/ export const FundingInstructionsBankTransferIbanRecordSchema = z .object({ account_holder_address: AddressSchema, - /** The name of the person or business that owns the bank account */ + /**The name of the person or business that owns the bank account*/ account_holder_name: z .string() .max(5000) @@ -19396,16 +18506,16 @@ export namespace stripe { 'The name of the person or business that owns the bank account' ), bank_address: AddressSchema, - /** The BIC/SWIFT code of the account. */ + /**The BIC/SWIFT code of the account.*/ bic: z.string().max(5000).describe('The BIC/SWIFT code of the account.'), - /** Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ + /**Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).*/ country: z .string() .max(5000) .describe( 'Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).' ), - /** The IBAN of the account. */ + /**The IBAN of the account.*/ iban: z.string().max(5000).describe('The IBAN of the account.') }) .describe( @@ -19415,21 +18525,21 @@ export namespace stripe { typeof FundingInstructionsBankTransferIbanRecordSchema > - /** Sort Code Records contain U.K. bank account details per the sort code format. */ + /**Sort Code Records contain U.K. bank account details per the sort code format.*/ export const FundingInstructionsBankTransferSortCodeRecordSchema = z .object({ account_holder_address: AddressSchema, - /** The name of the person or business that owns the bank account */ + /**The name of the person or business that owns the bank account*/ account_holder_name: z .string() .max(5000) .describe( 'The name of the person or business that owns the bank account' ), - /** The account number */ + /**The account number*/ account_number: z.string().max(5000).describe('The account number'), bank_address: AddressSchema, - /** The six-digit sort code */ + /**The six-digit sort code*/ sort_code: z.string().max(5000).describe('The six-digit sort code') }) .describe( @@ -19439,24 +18549,24 @@ export namespace stripe { typeof FundingInstructionsBankTransferSortCodeRecordSchema > - /** SPEI Records contain Mexico bank account details per the SPEI format. */ + /**SPEI Records contain Mexico bank account details per the SPEI format.*/ export const FundingInstructionsBankTransferSpeiRecordSchema = z .object({ account_holder_address: AddressSchema, - /** The account holder name */ + /**The account holder name*/ account_holder_name: z .string() .max(5000) .describe('The account holder name'), bank_address: AddressSchema, - /** The three-digit bank code */ + /**The three-digit bank code*/ bank_code: z.string().max(5000).describe('The three-digit bank code'), - /** The short banking institution name */ + /**The short banking institution name*/ bank_name: z .string() .max(5000) .describe('The short banking institution name'), - /** The CLABE number */ + /**The CLABE number*/ clabe: z.string().max(5000).describe('The CLABE number') }) .describe( @@ -19466,23 +18576,23 @@ export namespace stripe { typeof FundingInstructionsBankTransferSpeiRecordSchema > - /** SWIFT Records contain U.S. bank account details per the SWIFT format. */ + /**SWIFT Records contain U.S. bank account details per the SWIFT format.*/ export const FundingInstructionsBankTransferSwiftRecordSchema = z .object({ account_holder_address: AddressSchema, - /** The account holder name */ + /**The account holder name*/ account_holder_name: z .string() .max(5000) .describe('The account holder name'), - /** The account number */ + /**The account number*/ account_number: z.string().max(5000).describe('The account number'), - /** The account type */ + /**The account type*/ account_type: z.string().max(5000).describe('The account type'), bank_address: AddressSchema, - /** The bank name */ + /**The bank name*/ bank_name: z.string().max(5000).describe('The bank name'), - /** The SWIFT code */ + /**The SWIFT code*/ swift_code: z.string().max(5000).describe('The SWIFT code') }) .describe( @@ -19492,60 +18602,53 @@ export namespace stripe { typeof FundingInstructionsBankTransferSwiftRecordSchema > - /** Zengin Records contain Japan bank account details per the Zengin format. */ + /**Zengin Records contain Japan bank account details per the Zengin format.*/ export const FundingInstructionsBankTransferZenginRecordSchema = z .object({ account_holder_address: AddressSchema, - /** The account holder name */ + /**The account holder name*/ account_holder_name: z .string() .max(5000) - .nullable() .describe('The account holder name') .optional(), - /** The account number */ + /**The account number*/ account_number: z .string() .max(5000) - .nullable() .describe('The account number') .optional(), - /** The bank account type. In Japan, this can only be `futsu` or `toza`. */ + /**The bank account type. In Japan, this can only be `futsu` or `toza`.*/ account_type: z .string() .max(5000) - .nullable() .describe( 'The bank account type. In Japan, this can only be `futsu` or `toza`.' ) .optional(), bank_address: AddressSchema, - /** The bank code of the account */ + /**The bank code of the account*/ bank_code: z .string() .max(5000) - .nullable() .describe('The bank code of the account') .optional(), - /** The bank name of the account */ + /**The bank name of the account*/ bank_name: z .string() .max(5000) - .nullable() .describe('The bank name of the account') .optional(), - /** The branch code of the account */ + /**The branch code of the account*/ branch_code: z .string() .max(5000) - .nullable() .describe('The branch code of the account') .optional(), - /** The branch name of the account */ + /**The branch name of the account*/ branch_name: z .string() .max(5000) - .nullable() .describe('The branch name of the account') .optional() }) @@ -19558,7 +18661,7 @@ export namespace stripe { export const PaymentIntentNextActionSwishHandleRedirectOrDisplayQrCodeSchema = z.object({ - /** The URL to the hosted Swish instructions page, which allows customers to view the QR code. */ + /**The URL to the hosted Swish instructions page, which allows customers to view the QR code.*/ hosted_instructions_url: z .string() .max(5000) @@ -19590,7 +18693,7 @@ export namespace stripe { "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)." ) .optional(), - /** Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now. */ + /**Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.*/ target_date: z .string() .max(5000) @@ -19598,7 +18701,7 @@ export namespace stripe { "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now." ) .optional(), - /** Bank account verification method. */ + /**Bank account verification method.*/ verification_method: z .enum(['automatic', 'instant', 'microdeposits']) .describe('Bank account verification method.') @@ -19634,7 +18737,7 @@ export namespace stripe { "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)." ) .optional(), - /** Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now. */ + /**Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.*/ target_date: z .string() .max(5000) @@ -19648,40 +18751,37 @@ export namespace stripe { > export const PaymentMethodOptionsCardInstallmentsSchema = z.object({ - /** Installment plans that may be selected for this PaymentIntent. */ + /**Installment plans that may be selected for this PaymentIntent.*/ available_plans: z .array(PaymentMethodDetailsCardInstallmentsPlanSchema) - .nullable() .describe( 'Installment plans that may be selected for this PaymentIntent.' ) .optional(), - /** Whether Installments are enabled for this PaymentIntent. */ + /**Whether Installments are enabled for this PaymentIntent.*/ enabled: z .boolean() .describe('Whether Installments are enabled for this PaymentIntent.'), - /** Installment plan selected for this PaymentIntent. */ - plan: PaymentMethodDetailsCardInstallmentsPlanSchema.nullable() - .describe('Installment plan selected for this PaymentIntent.') - .optional() + /**Installment plan selected for this PaymentIntent.*/ + plan: PaymentMethodDetailsCardInstallmentsPlanSchema.describe( + 'Installment plan selected for this PaymentIntent.' + ).optional() }) export type PaymentMethodOptionsCardInstallments = z.infer< typeof PaymentMethodOptionsCardInstallmentsSchema > export const PaymentMethodOptionsCardPresentSchema = z.object({ - /** Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity) */ + /**Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity)*/ request_extended_authorization: z .boolean() - .nullable() .describe( 'Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity)' ) .optional(), - /** Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support. */ + /**Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.*/ request_incremental_authorization_support: z .boolean() - .nullable() .describe( 'Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.' ) @@ -19717,7 +18817,7 @@ export namespace stripe { 'List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.' ) .optional(), - /** The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`. */ + /**The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.*/ type: z .enum([ 'eu_bank_transfer', @@ -19726,7 +18826,6 @@ export namespace stripe { 'mx_bank_transfer', 'us_bank_transfer' ]) - .nullable() .describe( 'The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.' ) @@ -19755,7 +18854,7 @@ export namespace stripe { "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)." ) .optional(), - /** Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now. */ + /**Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.*/ target_date: z .string() .max(5000) @@ -19777,118 +18876,102 @@ export namespace stripe { > export const PaymentMethodCardWalletMasterpassSchema = z.object({ - /** Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - billing_address: AddressSchema.nullable() - .describe( - "Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated." - ) - .optional(), - /** Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /**Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.*/ + billing_address: AddressSchema.describe( + "Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated." + ).optional(), + /**Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.*/ email: z .string() .max(5000) - .nullable() .describe( "Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated." ) .optional(), - /** Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /**Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.*/ name: z .string() .max(5000) - .nullable() .describe( "Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated." ) .optional(), - /** Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - shipping_address: AddressSchema.nullable() - .describe( - "Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated." - ) - .optional() + /**Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.*/ + shipping_address: AddressSchema.describe( + "Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated." + ).optional() }) export type PaymentMethodCardWalletMasterpass = z.infer< typeof PaymentMethodCardWalletMasterpassSchema > export const PaymentMethodCardWalletVisaCheckoutSchema = z.object({ - /** Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - billing_address: AddressSchema.nullable() - .describe( - "Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated." - ) - .optional(), - /** Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /**Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.*/ + billing_address: AddressSchema.describe( + "Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated." + ).optional(), + /**Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.*/ email: z .string() .max(5000) - .nullable() .describe( "Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated." ) .optional(), - /** Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + /**Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.*/ name: z .string() .max(5000) - .nullable() .describe( "Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated." ) .optional(), - /** Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ - shipping_address: AddressSchema.nullable() - .describe( - "Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated." - ) - .optional() + /**Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.*/ + shipping_address: AddressSchema.describe( + "Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated." + ).optional() }) export type PaymentMethodCardWalletVisaCheckout = z.infer< typeof PaymentMethodCardWalletVisaCheckoutSchema > export const PaymentMethodInteracPresentSchema = z.object({ - /** Card brand. Can be `interac`, `mastercard` or `visa`. */ + /**Card brand. Can be `interac`, `mastercard` or `visa`.*/ brand: z .string() .max(5000) - .nullable() .describe('Card brand. Can be `interac`, `mastercard` or `visa`.') .optional(), - /** The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay. */ + /**The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.*/ cardholder_name: z .string() .max(5000) - .nullable() .describe( 'The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.' ) .optional(), - /** Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. */ + /**Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.*/ country: z .string() .max(5000) - .nullable() .describe( "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected." ) .optional(), - /** A high-level description of the type of cards issued in this range. */ + /**A high-level description of the type of cards issued in this range.*/ description: z .string() .max(5000) - .nullable() .describe( 'A high-level description of the type of cards issued in this range.' ) .optional(), - /** Two-digit number representing the card's expiration month. */ + /**Two-digit number representing the card's expiration month.*/ exp_month: z .number() .int() .describe("Two-digit number representing the card's expiration month."), - /** Four-digit number representing the card's expiration year. */ + /**Four-digit number representing the card's expiration year.*/ exp_year: z .number() .int() @@ -19901,49 +18984,42 @@ export namespace stripe { fingerprint: z .string() .max(5000) - .nullable() .describe( 'Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*' ) .optional(), - /** Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ + /**Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.*/ funding: z .string() .max(5000) - .nullable() .describe( 'Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.' ) .optional(), - /** The name of the card's issuing bank. */ + /**The name of the card's issuing bank.*/ issuer: z .string() .max(5000) - .nullable() .describe("The name of the card's issuing bank.") .optional(), - /** The last four digits of the card. */ + /**The last four digits of the card.*/ last4: z .string() .max(5000) - .nullable() .describe('The last four digits of the card.') .optional(), - /** Contains information about card networks that can be used to process the payment. */ - networks: PaymentMethodCardPresentNetworksSchema.nullable() - .describe( - 'Contains information about card networks that can be used to process the payment.' - ) - .optional(), - /** EMV tag 5F2D. Preferred languages specified by the integrated circuit chip. */ + /**Contains information about card networks that can be used to process the payment.*/ + networks: PaymentMethodCardPresentNetworksSchema.describe( + 'Contains information about card networks that can be used to process the payment.' + ).optional(), + /**EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.*/ preferred_locales: z .array(z.string().max(5000)) - .nullable() .describe( 'EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.' ) .optional(), - /** How card details were read in this transaction. */ + /**How card details were read in this transaction.*/ read_method: z .enum([ 'contact_emv', @@ -19952,7 +19028,6 @@ export namespace stripe { 'magnetic_stripe_fallback', 'magnetic_stripe_track2' ]) - .nullable() .describe('How card details were read in this transaction.') .optional() }) @@ -19961,10 +19036,10 @@ export namespace stripe { > export const PaymentMethodKlarnaSchema = z.object({ - /** The customer's date of birth, if provided. */ - dob: PaymentFlowsPrivatePaymentMethodsKlarnaDobSchema.nullable() - .describe("The customer's date of birth, if provided.") - .optional() + /**The customer's date of birth, if provided.*/ + dob: PaymentFlowsPrivatePaymentMethodsKlarnaDobSchema.describe( + "The customer's date of birth, if provided." + ).optional() }) export type PaymentMethodKlarna = z.infer @@ -19976,57 +19051,52 @@ export namespace stripe { > export const CustomerTaxSchema = z.object({ - /** Surfaces if automatic tax computation is possible given the current customer location information. */ + /**Surfaces if automatic tax computation is possible given the current customer location information.*/ automatic_tax: z .enum(['failed', 'not_collecting', 'supported', 'unrecognized_location']) .describe( 'Surfaces if automatic tax computation is possible given the current customer location information.' ), - /** A recent IP address of the customer used for tax reporting and tax location inference. */ + /**A recent IP address of the customer used for tax reporting and tax location inference.*/ ip_address: z .string() .max(5000) - .nullable() .describe( 'A recent IP address of the customer used for tax reporting and tax location inference.' ) .optional(), - /** The customer's location as identified by Stripe Tax. */ - location: CustomerTaxLocationSchema.nullable() - .describe("The customer's location as identified by Stripe Tax.") - .optional() + /**The customer's location as identified by Stripe Tax.*/ + location: CustomerTaxLocationSchema.describe( + "The customer's location as identified by Stripe Tax." + ).optional() }) export type CustomerTax = z.infer export const ExternalAccountRequirementsSchema = z.object({ - /** Fields that need to be collected to keep the external account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled. */ + /**Fields that need to be collected to keep the external account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled.*/ currently_due: z .array(z.string().max(5000)) - .nullable() .describe( 'Fields that need to be collected to keep the external account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled.' ) .optional(), - /** Fields that are `currently_due` and need to be collected again because validation or verification failed. */ + /**Fields that are `currently_due` and need to be collected again because validation or verification failed.*/ errors: z .array(AccountRequirementsErrorSchema) - .nullable() .describe( 'Fields that are `currently_due` and need to be collected again because validation or verification failed.' ) .optional(), - /** Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the external account. */ + /**Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the external account.*/ past_due: z .array(z.string().max(5000)) - .nullable() .describe( "Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the external account." ) .optional(), - /** Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending. */ + /**Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.*/ pending_verification: z .array(z.string().max(5000)) - .nullable() .describe( "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending." ) @@ -20037,12 +19107,10 @@ export namespace stripe { > export const PersonAdditionalTosAcceptancesSchema = z.object({ - /** Details on the legal guardian's acceptance of the main Stripe service agreement. */ - account: PersonAdditionalTosAcceptanceSchema.nullable() - .describe( - "Details on the legal guardian's acceptance of the main Stripe service agreement." - ) - .optional() + /**Details on the legal guardian's acceptance of the main Stripe service agreement.*/ + account: PersonAdditionalTosAcceptanceSchema.describe( + "Details on the legal guardian's acceptance of the main Stripe service agreement." + ).optional() }) export type PersonAdditionalTosAcceptances = z.infer< typeof PersonAdditionalTosAcceptancesSchema @@ -20057,29 +19125,26 @@ export namespace stripe { export const AccountCardPaymentsSettingsSchema = z.object({ decline_on: AccountDeclineChargeOnSchema.optional(), - /** The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion. */ + /**The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion.*/ statement_descriptor_prefix: z .string() .max(5000) - .nullable() .describe( 'The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion.' ) .optional(), - /** The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kana` specified on the charge. `statement_descriptor_prefix_kana` is useful for maximizing descriptor space for the dynamic portion. */ + /**The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kana` specified on the charge. `statement_descriptor_prefix_kana` is useful for maximizing descriptor space for the dynamic portion.*/ statement_descriptor_prefix_kana: z .string() .max(5000) - .nullable() .describe( 'The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kana` specified on the charge. `statement_descriptor_prefix_kana` is useful for maximizing descriptor space for the dynamic portion.' ) .optional(), - /** The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kanji` specified on the charge. `statement_descriptor_prefix_kanji` is useful for maximizing descriptor space for the dynamic portion. */ + /**The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kanji` specified on the charge. `statement_descriptor_prefix_kanji` is useful for maximizing descriptor space for the dynamic portion.*/ statement_descriptor_prefix_kanji: z .string() .max(5000) - .nullable() .describe( 'The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kanji` specified on the charge. `statement_descriptor_prefix_kanji` is useful for maximizing descriptor space for the dynamic portion.' ) @@ -20090,18 +19155,17 @@ export namespace stripe { > export const AccountPayoutSettingsSchema = z.object({ - /** A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See [Understanding Connect account balances](/connect/account-balances) for details. The default value is `false` when [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, otherwise `true`. */ + /**A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See [Understanding Connect account balances](/connect/account-balances) for details. The default value is `false` when [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, otherwise `true`.*/ debit_negative_balances: z .boolean() .describe( 'A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See [Understanding Connect account balances](/connect/account-balances) for details. The default value is `false` when [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, otherwise `true`.' ), schedule: TransferScheduleSchema, - /** The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard. */ + /**The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.*/ statement_descriptor: z .string() .max(5000) - .nullable() .describe( "The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard." ) @@ -20119,7 +19183,7 @@ export namespace stripe { > export const ConnectEmbeddedAccountConfigClaimSchema = z.object({ - /** Whether the embedded component is enabled. */ + /**Whether the embedded component is enabled.*/ enabled: z.boolean().describe('Whether the embedded component is enabled.'), features: ConnectEmbeddedAccountFeaturesClaimSchema }) @@ -20128,7 +19192,7 @@ export namespace stripe { > export const ConnectEmbeddedPayoutsConfigSchema = z.object({ - /** Whether the embedded component is enabled. */ + /**Whether the embedded component is enabled.*/ enabled: z.boolean().describe('Whether the embedded component is enabled.'), features: ConnectEmbeddedPayoutsFeaturesSchema }) @@ -20137,7 +19201,7 @@ export namespace stripe { > export const ConnectEmbeddedBaseConfigClaimSchema = z.object({ - /** Whether the embedded component is enabled. */ + /**Whether the embedded component is enabled.*/ enabled: z.boolean().describe('Whether the embedded component is enabled.'), features: ConnectEmbeddedBaseFeaturesSchema }) @@ -20146,7 +19210,7 @@ export namespace stripe { > export const ConnectEmbeddedFinancialAccountConfigClaimSchema = z.object({ - /** Whether the embedded component is enabled. */ + /**Whether the embedded component is enabled.*/ enabled: z.boolean().describe('Whether the embedded component is enabled.'), features: ConnectEmbeddedFinancialAccountFeaturesSchema }) @@ -20156,7 +19220,7 @@ export namespace stripe { export const ConnectEmbeddedFinancialAccountTransactionsConfigClaimSchema = z.object({ - /** Whether the embedded component is enabled. */ + /**Whether the embedded component is enabled.*/ enabled: z .boolean() .describe('Whether the embedded component is enabled.'), @@ -20167,7 +19231,7 @@ export namespace stripe { > export const ConnectEmbeddedIssuingCardConfigClaimSchema = z.object({ - /** Whether the embedded component is enabled. */ + /**Whether the embedded component is enabled.*/ enabled: z.boolean().describe('Whether the embedded component is enabled.'), features: ConnectEmbeddedIssuingCardFeaturesSchema }) @@ -20176,7 +19240,7 @@ export namespace stripe { > export const ConnectEmbeddedIssuingCardsListConfigClaimSchema = z.object({ - /** Whether the embedded component is enabled. */ + /**Whether the embedded component is enabled.*/ enabled: z.boolean().describe('Whether the embedded component is enabled.'), features: ConnectEmbeddedIssuingCardsListFeaturesSchema }) @@ -20185,7 +19249,7 @@ export namespace stripe { > export const ConnectEmbeddedPaymentsConfigClaimSchema = z.object({ - /** Whether the embedded component is enabled. */ + /**Whether the embedded component is enabled.*/ enabled: z.boolean().describe('Whether the embedded component is enabled.'), features: ConnectEmbeddedPaymentsFeaturesSchema }) @@ -20206,51 +19270,49 @@ export namespace stripe { */ export const AppsSecretSchema = z .object({ - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** If true, indicates that this secret has been deleted */ + /**If true, indicates that this secret has been deleted*/ deleted: z .boolean() .describe('If true, indicates that this secret has been deleted') .optional(), - /** The Unix timestamp for the expiry time of the secret, after which the secret deletes. */ + /**The Unix timestamp for the expiry time of the secret, after which the secret deletes.*/ expires_at: z .number() .int() - .nullable() .describe( 'The Unix timestamp for the expiry time of the secret, after which the secret deletes.' ) .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** A name for the secret that's unique within the scope. */ + /**A name for the secret that's unique within the scope.*/ name: z .string() .max(5000) .describe("A name for the secret that's unique within the scope."), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('apps.secret') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The plaintext secret value to be stored. */ + /**The plaintext secret value to be stored.*/ payload: z .string() .max(5000) - .nullable() .describe('The plaintext secret value to be stored.') .optional(), scope: SecretServiceResourceScopeSchema @@ -20261,9 +19323,9 @@ export namespace stripe { export type AppsSecret = z.infer export const BalanceAmountSchema = z.object({ - /** Balance amount. */ + /**Balance amount.*/ amount: z.number().int().describe('Balance amount.'), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( @@ -20274,14 +19336,14 @@ export namespace stripe { export type BalanceAmount = z.infer export const BalanceNetAvailableSchema = z.object({ - /** Net balance amount, subtracting fees from platform-set pricing. */ + /**Net balance amount, subtracting fees from platform-set pricing.*/ amount: z .number() .int() .describe( 'Net balance amount, subtracting fees from platform-set pricing.' ), - /** ID of the external account for this net balance (not expandable). */ + /**ID of the external account for this net balance (not expandable).*/ destination: z .string() .max(5000) @@ -20292,38 +19354,38 @@ export namespace stripe { }) export type BalanceNetAvailable = z.infer - /** A billing meter event adjustment is a resource that allows you to cancel a meter event. For example, you might create a billing meter event adjustment to cancel a meter event that was created in error or attached to the wrong customer. */ + /**A billing meter event adjustment is a resource that allows you to cancel a meter event. For example, you might create a billing meter event adjustment to cancel a meter event that was created in error or attached to the wrong customer.*/ export const BillingMeterEventAdjustmentSchema = z .object({ - /** Specifies which event to cancel. */ + /**Specifies which event to cancel.*/ cancel: - BillingMeterResourceBillingMeterEventAdjustmentCancelSchema.nullable() - .describe('Specifies which event to cancel.') - .optional(), - /** The name of the meter event. Corresponds with the `event_name` field on a meter. */ + BillingMeterResourceBillingMeterEventAdjustmentCancelSchema.describe( + 'Specifies which event to cancel.' + ).optional(), + /**The name of the meter event. Corresponds with the `event_name` field on a meter.*/ event_name: z .string() .max(100) .describe( 'The name of the meter event. Corresponds with the `event_name` field on a meter.' ), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('billing.meter_event_adjustment') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The meter event adjustment's status. */ + /**The meter event adjustment's status.*/ status: z .enum(['complete', 'pending']) .describe("The meter event adjustment's status."), - /** Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet. */ + /**Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.*/ type: z .literal('cancel') .describe( @@ -20339,15 +19401,15 @@ export namespace stripe { export const PortalSubscriptionCancelSchema = z.object({ cancellation_reason: PortalSubscriptionCancellationReasonSchema, - /** Whether the feature is enabled. */ + /**Whether the feature is enabled.*/ enabled: z.boolean().describe('Whether the feature is enabled.'), - /** Whether to cancel subscriptions immediately or at the end of the billing period. */ + /**Whether to cancel subscriptions immediately or at the end of the billing period.*/ mode: z .enum(['at_period_end', 'immediately']) .describe( 'Whether to cancel subscriptions immediately or at the end of the billing period.' ), - /** Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`. */ + /**Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`.*/ proration_behavior: z .enum(['always_invoice', 'create_prorations', 'none']) .describe( @@ -20359,7 +19421,7 @@ export namespace stripe { > export const PortalResourceScheduleUpdateAtPeriodEndSchema = z.object({ - /** List of conditions. When any condition is true, an update will be scheduled at the end of the current period. */ + /**List of conditions. When any condition is true, an update will be scheduled at the end of the current period.*/ conditions: z .array(PortalResourceScheduleUpdateAtPeriodEndConditionSchema) .describe( @@ -20371,11 +19433,11 @@ export namespace stripe { > export const PortalFlowsRetentionSchema = z.object({ - /** Configuration when `retention.type=coupon_offer`. */ - coupon_offer: PortalFlowsCouponOfferSchema.nullable() - .describe('Configuration when `retention.type=coupon_offer`.') - .optional(), - /** Type of retention strategy that will be used. */ + /**Configuration when `retention.type=coupon_offer`.*/ + coupon_offer: PortalFlowsCouponOfferSchema.describe( + 'Configuration when `retention.type=coupon_offer`.' + ).optional(), + /**Type of retention strategy that will be used.*/ type: z .literal('coupon_offer') .describe('Type of retention strategy that will be used.') @@ -20383,26 +19445,21 @@ export namespace stripe { export type PortalFlowsRetention = z.infer export const PaymentPagesCheckoutSessionAfterExpirationSchema = z.object({ - /** When set, configuration used to recover the Checkout Session on expiry. */ - recovery: - PaymentPagesCheckoutSessionAfterExpirationRecoverySchema.nullable() - .describe( - 'When set, configuration used to recover the Checkout Session on expiry.' - ) - .optional() + /**When set, configuration used to recover the Checkout Session on expiry.*/ + recovery: PaymentPagesCheckoutSessionAfterExpirationRecoverySchema.describe( + 'When set, configuration used to recover the Checkout Session on expiry.' + ).optional() }) export type PaymentPagesCheckoutSessionAfterExpiration = z.infer< typeof PaymentPagesCheckoutSessionAfterExpirationSchema > export const PaymentPagesCheckoutSessionConsentCollectionSchema = z.object({ - /** If set to `hidden`, it will hide legal text related to the reuse of a payment method. */ + /**If set to `hidden`, it will hide legal text related to the reuse of a payment method.*/ payment_method_reuse_agreement: - PaymentPagesCheckoutSessionPaymentMethodReuseAgreementSchema.nullable() - .describe( - 'If set to `hidden`, it will hide legal text related to the reuse of a payment method.' - ) - .optional(), + PaymentPagesCheckoutSessionPaymentMethodReuseAgreementSchema.describe( + 'If set to `hidden`, it will hide legal text related to the reuse of a payment method.' + ).optional(), /** * If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout * Session will determine whether to display an option to opt into promotional communication @@ -20410,15 +19467,13 @@ export namespace stripe { */ promotions: z .enum(['auto', 'none']) - .nullable() .describe( "If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout\nSession will determine whether to display an option to opt into promotional communication\nfrom the merchant depending on the customer's locale. Only available to US merchants." ) .optional(), - /** If set to `required`, it requires customers to accept the terms of service before being able to pay. */ + /**If set to `required`, it requires customers to accept the terms of service before being able to pay.*/ terms_of_service: z .enum(['none', 'required']) - .nullable() .describe( 'If set to `required`, it requires customers to accept the terms of service before being able to pay.' ) @@ -20430,24 +19485,22 @@ export namespace stripe { export const PaymentPagesCheckoutSessionCustomFieldsDropdownSchema = z.object( { - /** The value that will pre-fill on the payment page. */ + /**The value that will pre-fill on the payment page.*/ default_value: z .string() .max(5000) - .nullable() .describe('The value that will pre-fill on the payment page.') .optional(), - /** The options available for the customer to select. Up to 200 options allowed. */ + /**The options available for the customer to select. Up to 200 options allowed.*/ options: z .array(PaymentPagesCheckoutSessionCustomFieldsOptionSchema) .describe( 'The options available for the customer to select. Up to 200 options allowed.' ), - /** The option selected by the customer. This will be the `value` for the option. */ + /**The option selected by the customer. This will be the `value` for the option.*/ value: z .string() .max(5000) - .nullable() .describe( 'The option selected by the customer. This will be the `value` for the option.' ) @@ -20459,57 +19512,45 @@ export namespace stripe { > export const PaymentPagesCheckoutSessionCustomTextSchema = z.object({ - /** Custom text that should be displayed after the payment confirmation button. */ - after_submit: PaymentPagesCheckoutSessionCustomTextPositionSchema.nullable() - .describe( - 'Custom text that should be displayed after the payment confirmation button.' - ) - .optional(), - /** Custom text that should be displayed alongside shipping address collection. */ + /**Custom text that should be displayed after the payment confirmation button.*/ + after_submit: PaymentPagesCheckoutSessionCustomTextPositionSchema.describe( + 'Custom text that should be displayed after the payment confirmation button.' + ).optional(), + /**Custom text that should be displayed alongside shipping address collection.*/ shipping_address: - PaymentPagesCheckoutSessionCustomTextPositionSchema.nullable() - .describe( - 'Custom text that should be displayed alongside shipping address collection.' - ) - .optional(), - /** Custom text that should be displayed alongside the payment confirmation button. */ - submit: PaymentPagesCheckoutSessionCustomTextPositionSchema.nullable() - .describe( - 'Custom text that should be displayed alongside the payment confirmation button.' - ) - .optional(), - /** Custom text that should be displayed in place of the default terms of service agreement text. */ + PaymentPagesCheckoutSessionCustomTextPositionSchema.describe( + 'Custom text that should be displayed alongside shipping address collection.' + ).optional(), + /**Custom text that should be displayed alongside the payment confirmation button.*/ + submit: PaymentPagesCheckoutSessionCustomTextPositionSchema.describe( + 'Custom text that should be displayed alongside the payment confirmation button.' + ).optional(), + /**Custom text that should be displayed in place of the default terms of service agreement text.*/ terms_of_service_acceptance: - PaymentPagesCheckoutSessionCustomTextPositionSchema.nullable() - .describe( - 'Custom text that should be displayed in place of the default terms of service agreement text.' - ) - .optional() + PaymentPagesCheckoutSessionCustomTextPositionSchema.describe( + 'Custom text that should be displayed in place of the default terms of service agreement text.' + ).optional() }) export type PaymentPagesCheckoutSessionCustomText = z.infer< typeof PaymentPagesCheckoutSessionCustomTextSchema > export const PaymentLinksResourceConsentCollectionSchema = z.object({ - /** Settings related to the payment method reuse text shown in the Checkout UI. */ + /**Settings related to the payment method reuse text shown in the Checkout UI.*/ payment_method_reuse_agreement: - PaymentLinksResourcePaymentMethodReuseAgreementSchema.nullable() - .describe( - 'Settings related to the payment method reuse text shown in the Checkout UI.' - ) - .optional(), - /** If set to `auto`, enables the collection of customer consent for promotional communications. */ + PaymentLinksResourcePaymentMethodReuseAgreementSchema.describe( + 'Settings related to the payment method reuse text shown in the Checkout UI.' + ).optional(), + /**If set to `auto`, enables the collection of customer consent for promotional communications.*/ promotions: z .enum(['auto', 'none']) - .nullable() .describe( 'If set to `auto`, enables the collection of customer consent for promotional communications.' ) .optional(), - /** If set to `required`, it requires cutomers to accept the terms of service before being able to pay. If set to `none`, customers won't be shown a checkbox to accept the terms of service. */ + /**If set to `required`, it requires cutomers to accept the terms of service before being able to pay. If set to `none`, customers won't be shown a checkbox to accept the terms of service.*/ terms_of_service: z .enum(['none', 'required']) - .nullable() .describe( "If set to `required`, it requires cutomers to accept the terms of service before being able to pay. If set to `none`, customers won't be shown a checkbox to accept the terms of service." ) @@ -20520,7 +19561,7 @@ export namespace stripe { > export const PaymentLinksResourceCustomFieldsDropdownSchema = z.object({ - /** The options available for the customer to select. Up to 200 options allowed. */ + /**The options available for the customer to select. Up to 200 options allowed.*/ options: z .array(PaymentLinksResourceCustomFieldsDropdownOptionSchema) .describe( @@ -20532,31 +19573,23 @@ export namespace stripe { > export const PaymentLinksResourceCustomTextSchema = z.object({ - /** Custom text that should be displayed after the payment confirmation button. */ - after_submit: PaymentLinksResourceCustomTextPositionSchema.nullable() - .describe( - 'Custom text that should be displayed after the payment confirmation button.' - ) - .optional(), - /** Custom text that should be displayed alongside shipping address collection. */ - shipping_address: PaymentLinksResourceCustomTextPositionSchema.nullable() - .describe( - 'Custom text that should be displayed alongside shipping address collection.' - ) - .optional(), - /** Custom text that should be displayed alongside the payment confirmation button. */ - submit: PaymentLinksResourceCustomTextPositionSchema.nullable() - .describe( - 'Custom text that should be displayed alongside the payment confirmation button.' - ) - .optional(), - /** Custom text that should be displayed in place of the default terms of service agreement text. */ + /**Custom text that should be displayed after the payment confirmation button.*/ + after_submit: PaymentLinksResourceCustomTextPositionSchema.describe( + 'Custom text that should be displayed after the payment confirmation button.' + ).optional(), + /**Custom text that should be displayed alongside shipping address collection.*/ + shipping_address: PaymentLinksResourceCustomTextPositionSchema.describe( + 'Custom text that should be displayed alongside shipping address collection.' + ).optional(), + /**Custom text that should be displayed alongside the payment confirmation button.*/ + submit: PaymentLinksResourceCustomTextPositionSchema.describe( + 'Custom text that should be displayed alongside the payment confirmation button.' + ).optional(), + /**Custom text that should be displayed in place of the default terms of service agreement text.*/ terms_of_service_acceptance: - PaymentLinksResourceCustomTextPositionSchema.nullable() - .describe( - 'Custom text that should be displayed in place of the default terms of service agreement text.' - ) - .optional() + PaymentLinksResourceCustomTextPositionSchema.describe( + 'Custom text that should be displayed in place of the default terms of service agreement text.' + ).optional() }) export type PaymentLinksResourceCustomText = z.infer< typeof PaymentLinksResourceCustomTextSchema @@ -20570,7 +19603,7 @@ export namespace stripe { > export const CheckoutAcssDebitPaymentMethodOptionsSchema = z.object({ - /** Currency supported by the bank account. Returned when the Session is in `setup` mode. */ + /**Currency supported by the bank account. Returned when the Session is in `setup` mode.*/ currency: z .enum(['cad', 'usd']) .describe( @@ -20593,7 +19626,7 @@ export namespace stripe { "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)." ) .optional(), - /** Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now. */ + /**Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.*/ target_date: z .string() .max(5000) @@ -20601,7 +19634,7 @@ export namespace stripe { "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now." ) .optional(), - /** Bank account verification method. */ + /**Bank account verification method.*/ verification_method: z .enum(['automatic', 'instant', 'microdeposits']) .describe('Bank account verification method.') @@ -20629,7 +19662,7 @@ export namespace stripe { "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)." ) .optional(), - /** Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now. */ + /**Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.*/ target_date: z .string() .max(5000) @@ -20667,7 +19700,7 @@ export namespace stripe { 'List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`.' ) .optional(), - /** The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`. */ + /**The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.*/ type: z .enum([ 'eu_bank_transfer', @@ -20676,7 +19709,6 @@ export namespace stripe { 'mx_bank_transfer', 'us_bank_transfer' ]) - .nullable() .describe( 'The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.' ) @@ -20704,7 +19736,7 @@ export namespace stripe { "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)." ) .optional(), - /** Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now. */ + /**Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.*/ target_date: z .string() .max(5000) @@ -20717,38 +19749,38 @@ export namespace stripe { typeof CheckoutSepaDebitPaymentMethodOptionsSchema > - /** A supplier of carbon removal. */ + /**A supplier of carbon removal.*/ export const ClimateSupplierSchema = z .object({ - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Link to a webpage to learn more about the supplier. */ + /**Link to a webpage to learn more about the supplier.*/ info_url: z .string() .max(5000) .describe('Link to a webpage to learn more about the supplier.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** The locations in which this supplier operates. */ + /**The locations in which this supplier operates.*/ locations: z .array(ClimateRemovalsLocationSchema) .describe('The locations in which this supplier operates.'), - /** Name of this carbon removal supplier. */ + /**Name of this carbon removal supplier.*/ name: z .string() .max(5000) .describe('Name of this carbon removal supplier.'), - /** String representing the object’s type. Objects of the same type share the same value. */ + /**String representing the object’s type. Objects of the same type share the same value.*/ object: z .literal('climate.supplier') .describe( 'String representing the object’s type. Objects of the same type share the same value.' ), - /** The scientific pathway used for carbon removal. */ + /**The scientific pathway used for carbon removal.*/ removal_pathway: z .enum([ 'biomass_carbon_removal_and_storage', @@ -20760,18 +19792,16 @@ export namespace stripe { .describe('A supplier of carbon removal.') export type ClimateSupplier = z.infer - /** This hash contains details about the customer acceptance of the Mandate. */ + /**This hash contains details about the customer acceptance of the Mandate.*/ export const ConfirmationTokensResourceMandateDataResourceCustomerAcceptanceSchema = z .object({ - /** If this is a Mandate accepted online, this hash contains details about the online acceptance. */ + /**If this is a Mandate accepted online, this hash contains details about the online acceptance.*/ online: - ConfirmationTokensResourceMandateDataResourceCustomerAcceptanceResourceOnlineSchema.nullable() - .describe( - 'If this is a Mandate accepted online, this hash contains details about the online acceptance.' - ) - .optional(), - /** The type of customer acceptance information included with the Mandate. */ + ConfirmationTokensResourceMandateDataResourceCustomerAcceptanceResourceOnlineSchema.describe( + 'If this is a Mandate accepted online, this hash contains details about the online acceptance.' + ).optional(), + /**The type of customer acceptance information included with the Mandate.*/ type: z .string() .max(5000) @@ -20787,13 +19817,13 @@ export namespace stripe { typeof ConfirmationTokensResourceMandateDataResourceCustomerAcceptanceSchema > - /** Payment-method-specific configuration */ + /**Payment-method-specific configuration*/ export const ConfirmationTokensResourcePaymentMethodOptionsSchema = z .object({ - /** This hash contains the card payment method options. */ - card: ConfirmationTokensResourcePaymentMethodOptionsResourceCardSchema.nullable() - .describe('This hash contains the card payment method options.') - .optional() + /**This hash contains the card payment method options.*/ + card: ConfirmationTokensResourcePaymentMethodOptionsResourceCardSchema.describe( + 'This hash contains the card payment method options.' + ).optional() }) .describe('Payment-method-specific configuration') export type ConfirmationTokensResourcePaymentMethodOptions = z.infer< @@ -20802,13 +19832,12 @@ export namespace stripe { export const ConfirmationTokensResourceShippingSchema = z.object({ address: AddressSchema, - /** Recipient name. */ + /**Recipient name.*/ name: z.string().max(5000).describe('Recipient name.'), - /** Recipient phone (including extension). */ + /**Recipient phone (including extension).*/ phone: z .string() .max(5000) - .nullable() .describe('Recipient phone (including extension).') .optional() }) @@ -20824,18 +19853,16 @@ export namespace stripe { typeof CountrySpecVerificationFieldsSchema > - /** This hash contains whether the Payment Element is enabled and the features it supports. */ + /**This hash contains whether the Payment Element is enabled and the features it supports.*/ export const CustomerSessionResourceComponentsResourcePaymentElementSchema = z .object({ - /** Whether the Payment Element is enabled. */ + /**Whether the Payment Element is enabled.*/ enabled: z.boolean().describe('Whether the Payment Element is enabled.'), - /** This hash defines whether the Payment Element supports certain features. */ + /**This hash defines whether the Payment Element supports certain features.*/ features: - CustomerSessionResourceComponentsResourcePaymentElementResourceFeaturesSchema.nullable() - .describe( - 'This hash defines whether the Payment Element supports certain features.' - ) - .optional() + CustomerSessionResourceComponentsResourcePaymentElementResourceFeaturesSchema.describe( + 'This hash defines whether the Payment Element supports certain features.' + ).optional() }) .describe( 'This hash contains whether the Payment Element is enabled and the features it supports.' @@ -20844,31 +19871,31 @@ export namespace stripe { typeof CustomerSessionResourceComponentsResourcePaymentElementSchema > - /** An active entitlement describes access to a feature for a customer. */ + /**An active entitlement describes access to a feature for a customer.*/ export const EntitlementsActiveEntitlementSchema = z .object({ - /** The [Feature](https://stripe.com/docs/api/entitlements/feature) that the customer is entitled to. */ + /**The [Feature](https://stripe.com/docs/api/entitlements/feature) that the customer is entitled to.*/ feature: z .union([z.string().max(5000), EntitlementsFeatureSchema]) .describe( 'The [Feature](https://stripe.com/docs/api/entitlements/feature) that the customer is entitled to.' ), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** A unique key you provide as your own system identifier. This may be up to 80 characters. */ + /**A unique key you provide as your own system identifier. This may be up to 80 characters.*/ lookup_key: z .string() .max(5000) .describe( 'A unique key you provide as your own system identifier. This may be up to 80 characters.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('entitlements.active_entitlement') .describe( @@ -20882,44 +19909,44 @@ export namespace stripe { typeof EntitlementsActiveEntitlementSchema > - /** Describes a snapshot of the owners of an account at a particular point in time. */ + /**Describes a snapshot of the owners of an account at a particular point in time.*/ export const FinancialConnectionsAccountOwnershipSchema = z .object({ - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('financial_connections.account_ownership') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** A paginated list of owners for this account. */ + /**A paginated list of owners for this account.*/ owners: z .object({ - /** Details about each object. */ + /**Details about each object.*/ data: z .array(FinancialConnectionsAccountOwnerSchema) .describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -20934,70 +19961,70 @@ export namespace stripe { typeof FinancialConnectionsAccountOwnershipSchema > - /** A Transaction represents a real transaction that affects a Financial Connections Account balance. */ + /**A Transaction represents a real transaction that affects a Financial Connections Account balance.*/ export const FinancialConnectionsTransactionSchema = z .object({ - /** The ID of the Financial Connections Account this transaction belongs to. */ + /**The ID of the Financial Connections Account this transaction belongs to.*/ account: z .string() .max(5000) .describe( 'The ID of the Financial Connections Account this transaction belongs to.' ), - /** The amount of this transaction, in cents (or local equivalent). */ + /**The amount of this transaction, in cents (or local equivalent).*/ amount: z .number() .int() .describe( 'The amount of this transaction, in cents (or local equivalent).' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .max(5000) .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** The description of this transaction. */ + /**The description of this transaction.*/ description: z .string() .max(5000) .describe('The description of this transaction.'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('financial_connections.transaction') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The status of the transaction. */ + /**The status of the transaction.*/ status: z .enum(['pending', 'posted', 'void']) .describe('The status of the transaction.'), status_transitions: BankConnectionsResourceTransactionResourceStatusTransitionsSchema, - /** Time at which the transaction was transacted. Measured in seconds since the Unix epoch. */ + /**Time at which the transaction was transacted. Measured in seconds since the Unix epoch.*/ transacted_at: z .number() .int() .describe( 'Time at which the transaction was transacted. Measured in seconds since the Unix epoch.' ), - /** The token of the transaction refresh that last updated or created this transaction. */ + /**The token of the transaction refresh that last updated or created this transaction.*/ transaction_refresh: z .string() .max(5000) .describe( 'The token of the transaction refresh that last updated or created this transaction.' ), - /** Time at which the object was last updated. Measured in seconds since the Unix epoch. */ + /**Time at which the object was last updated. Measured in seconds since the Unix epoch.*/ updated: z .number() .int() @@ -21012,21 +20039,21 @@ export namespace stripe { typeof FinancialConnectionsTransactionSchema > - /** Details about the request forwarded to the destination endpoint. */ + /**Details about the request forwarded to the destination endpoint.*/ export const ForwardedRequestDetailsSchema = z .object({ - /** The body payload to send to the destination endpoint. */ + /**The body payload to send to the destination endpoint.*/ body: z .string() .max(5000) .describe('The body payload to send to the destination endpoint.'), - /** The headers to include in the forwarded request. Can be omitted if no additional headers (excluding Stripe-generated ones such as the Content-Type header) should be included. */ + /**The headers to include in the forwarded request. Can be omitted if no additional headers (excluding Stripe-generated ones such as the Content-Type header) should be included.*/ headers: z .array(ForwardedRequestHeaderSchema) .describe( 'The headers to include in the forwarded request. Can be omitted if no additional headers (excluding Stripe-generated ones such as the Content-Type header) should be included.' ), - /** The HTTP method used to call the destination endpoint. */ + /**The HTTP method used to call the destination endpoint.*/ http_method: z .literal('POST') .describe('The HTTP method used to call the destination endpoint.') @@ -21038,19 +20065,19 @@ export namespace stripe { typeof ForwardedRequestDetailsSchema > - /** Details about the response from the destination endpoint. */ + /**Details about the response from the destination endpoint.*/ export const ForwardedResponseDetailsSchema = z .object({ - /** The response body from the destination endpoint to Stripe. */ + /**The response body from the destination endpoint to Stripe.*/ body: z .string() .max(5000) .describe('The response body from the destination endpoint to Stripe.'), - /** HTTP headers that the destination endpoint returned. */ + /**HTTP headers that the destination endpoint returned.*/ headers: z .array(ForwardedRequestHeaderSchema) .describe('HTTP headers that the destination endpoint returned.'), - /** The HTTP status code that the destination endpoint returned. */ + /**The HTTP status code that the destination endpoint returned.*/ status: z .number() .int() @@ -21063,23 +20090,16 @@ export namespace stripe { typeof ForwardedResponseDetailsSchema > - /** Result from a email check */ + /**Result from a email check*/ export const GelatoEmailReportSchema = z .object({ - /** Email to be verified. */ - email: z - .string() - .max(5000) - .nullable() - .describe('Email to be verified.') - .optional(), - /** Details on the verification error. Present when status is `unverified`. */ - error: GelatoEmailReportErrorSchema.nullable() - .describe( - 'Details on the verification error. Present when status is `unverified`.' - ) - .optional(), - /** Status of this `email` check. */ + /**Email to be verified.*/ + email: z.string().max(5000).describe('Email to be verified.').optional(), + /**Details on the verification error. Present when status is `unverified`.*/ + error: GelatoEmailReportErrorSchema.describe( + 'Details on the verification error. Present when status is `unverified`.' + ).optional(), + /**Status of this `email` check.*/ status: z .enum(['unverified', 'verified']) .describe('Status of this `email` check.') @@ -21087,23 +20107,16 @@ export namespace stripe { .describe('Result from a email check') export type GelatoEmailReport = z.infer - /** Result from a phone check */ + /**Result from a phone check*/ export const GelatoPhoneReportSchema = z .object({ - /** Details on the verification error. Present when status is `unverified`. */ - error: GelatoPhoneReportErrorSchema.nullable() - .describe( - 'Details on the verification error. Present when status is `unverified`.' - ) - .optional(), - /** Phone to be verified. */ - phone: z - .string() - .max(5000) - .nullable() - .describe('Phone to be verified.') - .optional(), - /** Status of this `phone` check. */ + /**Details on the verification error. Present when status is `unverified`.*/ + error: GelatoPhoneReportErrorSchema.describe( + 'Details on the verification error. Present when status is `unverified`.' + ).optional(), + /**Phone to be verified.*/ + phone: z.string().max(5000).describe('Phone to be verified.').optional(), + /**Status of this `phone` check.*/ status: z .enum(['unverified', 'verified']) .describe('Status of this `phone` check.') @@ -21111,34 +20124,30 @@ export namespace stripe { .describe('Result from a phone check') export type GelatoPhoneReport = z.infer - /** Result from a selfie check */ + /**Result from a selfie check*/ export const GelatoSelfieReportSchema = z .object({ - /** ID of the [File](https://stripe.com/docs/api/files) holding the image of the identity document used in this check. */ + /**ID of the [File](https://stripe.com/docs/api/files) holding the image of the identity document used in this check.*/ document: z .string() .max(5000) - .nullable() .describe( 'ID of the [File](https://stripe.com/docs/api/files) holding the image of the identity document used in this check.' ) .optional(), - /** Details on the verification error. Present when status is `unverified`. */ - error: GelatoSelfieReportErrorSchema.nullable() - .describe( - 'Details on the verification error. Present when status is `unverified`.' - ) - .optional(), - /** ID of the [File](https://stripe.com/docs/api/files) holding the image of the selfie used in this check. */ + /**Details on the verification error. Present when status is `unverified`.*/ + error: GelatoSelfieReportErrorSchema.describe( + 'Details on the verification error. Present when status is `unverified`.' + ).optional(), + /**ID of the [File](https://stripe.com/docs/api/files) holding the image of the selfie used in this check.*/ selfie: z .string() .max(5000) - .nullable() .describe( 'ID of the [File](https://stripe.com/docs/api/files) holding the image of the selfie used in this check.' ) .optional(), - /** Status of this `selfie` check. */ + /**Status of this `selfie` check.*/ status: z .enum(['unverified', 'verified']) .describe('Status of this `selfie` check.') @@ -21148,7 +20157,7 @@ export namespace stripe { export const PaymentMethodConfigResourcePaymentMethodPropertiesSchema = z.object({ - /** Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active. */ + /**Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.*/ available: z .boolean() .describe( @@ -21160,10 +20169,10 @@ export namespace stripe { typeof PaymentMethodConfigResourcePaymentMethodPropertiesSchema > - /** Indicates the status of a specific payment method on a payment method domain. */ + /**Indicates the status of a specific payment method on a payment method domain.*/ export const PaymentMethodDomainResourcePaymentMethodStatusSchema = z .object({ - /** The status of the payment method on the domain. */ + /**The status of the payment method on the domain.*/ status: z .enum(['active', 'inactive']) .describe('The status of the payment method on the domain.'), @@ -21184,15 +20193,15 @@ export namespace stripe { export const ProductFeatureSchema = z .object({ entitlement_feature: EntitlementsFeatureSchema, - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('product_feature') .describe( @@ -21211,28 +20220,28 @@ export namespace stripe { */ export const RadarValueListSchema = z .object({ - /** The name of the value list for use in rules. */ + /**The name of the value list for use in rules.*/ alias: z .string() .max(5000) .describe('The name of the value list for use in rules.'), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** The name or email address of the user who created this value list. */ + /**The name or email address of the user who created this value list.*/ created_by: z .string() .max(5000) .describe( 'The name or email address of the user who created this value list.' ), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** The type of items in the value list. One of `card_fingerprint`, `us_bank_account_fingerprint`, `sepa_debit_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, or `customer_id`. */ + /**The type of items in the value list. One of `card_fingerprint`, `us_bank_account_fingerprint`, `sepa_debit_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, or `customer_id`.*/ item_type: z .enum([ 'card_bin', @@ -21249,47 +20258,47 @@ export namespace stripe { .describe( 'The type of items in the value list. One of `card_fingerprint`, `us_bank_account_fingerprint`, `sepa_debit_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, or `customer_id`.' ), - /** List of items contained within this value list. */ + /**List of items contained within this value list.*/ list_items: z .object({ - /** Details about each object. */ + /**Details about each object.*/ data: z .array(RadarValueListItemSchema) .describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) .describe('The URL where this list can be accessed.') }) .describe('List of items contained within this value list.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ), - /** The name of the value list. */ + /**The name of the value list.*/ name: z.string().max(5000).describe('The name of the value list.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('radar.value_list') .describe( @@ -21301,39 +20310,38 @@ export namespace stripe { ) export type RadarValueList = z.infer - /** A usage record summary represents an aggregated view of how much usage was accrued for a subscription item within a subscription billing period. */ + /**A usage record summary represents an aggregated view of how much usage was accrued for a subscription item within a subscription billing period.*/ export const UsageRecordSummarySchema = z .object({ - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** The invoice in which this usage period has been billed for. */ + /**The invoice in which this usage period has been billed for.*/ invoice: z .string() .max(5000) - .nullable() .describe('The invoice in which this usage period has been billed for.') .optional(), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('usage_record_summary') .describe( "String representing the object's type. Objects of the same type share the same value." ), period: PeriodSchema, - /** The ID of the subscription item this summary is describing. */ + /**The ID of the subscription item this summary is describing.*/ subscription_item: z .string() .max(5000) .describe( 'The ID of the subscription item this summary is describing.' ), - /** The total usage within this usage period. */ + /**The total usage within this usage period.*/ total_usage: z .number() .int() @@ -21352,44 +20360,39 @@ export namespace stripe { > export const TaxProductResourceTaxRateDetailsSchema = z.object({ - /** Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ + /**Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).*/ country: z .string() .max(5000) - .nullable() .describe( 'Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).' ) .optional(), - /** The amount of the tax rate when the `rate_type` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate. */ - flat_amount: TaxRateFlatAmountSchema.nullable() - .describe( - 'The amount of the tax rate when the `rate_type` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate.' - ) - .optional(), - /** The tax rate percentage as a string. For example, 8.5% is represented as `"8.5"`. */ + /**The amount of the tax rate when the `rate_type` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate.*/ + flat_amount: TaxRateFlatAmountSchema.describe( + 'The amount of the tax rate when the `rate_type` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate.' + ).optional(), + /**The tax rate percentage as a string. For example, 8.5% is represented as `"8.5"`.*/ percentage_decimal: z .string() .max(5000) .describe( 'The tax rate percentage as a string. For example, 8.5% is represented as `"8.5"`.' ), - /** Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location. */ + /**Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location.*/ rate_type: z .enum(['flat_amount', 'percentage']) - .nullable() .describe( 'Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location.' ) .optional(), - /** State, county, province, or region. */ + /**State, county, province, or region.*/ state: z .string() .max(5000) - .nullable() .describe('State, county, province, or region.') .optional(), - /** The tax type, such as `vat` or `sales_tax`. */ + /**The tax type, such as `vat` or `sales_tax`.*/ tax_type: z .enum([ 'amusement_tax', @@ -21407,7 +20410,6 @@ export namespace stripe { 'service_tax', 'vat' ]) - .nullable() .describe('The tax type, such as `vat` or `sales_tax`.') .optional() }) @@ -21419,7 +20421,7 @@ export namespace stripe { z.object({ standard: TaxProductRegistrationsResourceCountryOptionsEuStandardSchema.optional(), - /** Type of registration in an EU country. */ + /**Type of registration in an EU country.*/ type: z .enum(['ioss', 'oss_non_union', 'oss_union', 'standard']) .describe('Type of registration in an EU country.') @@ -21432,7 +20434,7 @@ export namespace stripe { z.object({ province_standard: TaxProductRegistrationsResourceCountryOptionsCaProvinceStandardSchema.optional(), - /** Type of registration in Canada. */ + /**Type of registration in Canada.*/ type: z .enum(['province_standard', 'simplified', 'standard']) .describe('Type of registration in Canada.') @@ -21443,7 +20445,7 @@ export namespace stripe { export const TaxProductRegistrationsResourceCountryOptionsUsStateSalesTaxSchema = z.object({ - /** Elections for the state sales tax registration. */ + /**Elections for the state sales tax registration.*/ elections: z .array( TaxProductRegistrationsResourceCountryOptionsUsStateSalesTaxElectionSchema @@ -21464,84 +20466,80 @@ export namespace stripe { > export const TaxTransactionLineItemSchema = z.object({ - /** The line item amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. */ + /**The line item amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.*/ amount: z .number() .int() .describe( 'The line item amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.' ), - /** The amount of tax calculated for this line item, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /**The amount of tax calculated for this line item, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).*/ amount_tax: z .number() .int() .describe( 'The amount of tax calculated for this line item, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).' ), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) - .nullable() .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ) .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('tax.transaction_line_item') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The ID of an existing [Product](https://stripe.com/docs/api/products/object). */ + /**The ID of an existing [Product](https://stripe.com/docs/api/products/object).*/ product: z .string() .max(5000) - .nullable() .describe( 'The ID of an existing [Product](https://stripe.com/docs/api/products/object).' ) .optional(), - /** The number of units of the item being purchased. For reversals, this is the quantity reversed. */ + /**The number of units of the item being purchased. For reversals, this is the quantity reversed.*/ quantity: z .number() .int() .describe( 'The number of units of the item being purchased. For reversals, this is the quantity reversed.' ), - /** A custom identifier for this line item in the transaction. */ + /**A custom identifier for this line item in the transaction.*/ reference: z .string() .max(5000) .describe('A custom identifier for this line item in the transaction.'), - /** If `type=reversal`, contains information about what was reversed. */ + /**If `type=reversal`, contains information about what was reversed.*/ reversal: - TaxProductResourceTaxTransactionLineItemResourceReversalSchema.nullable() - .describe( - 'If `type=reversal`, contains information about what was reversed.' - ) - .optional(), - /** Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes. */ + TaxProductResourceTaxTransactionLineItemResourceReversalSchema.describe( + 'If `type=reversal`, contains information about what was reversed.' + ).optional(), + /**Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.*/ tax_behavior: z .enum(['exclusive', 'inclusive']) .describe( 'Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.' ), - /** The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for this resource. */ + /**The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for this resource.*/ tax_code: z .string() .max(5000) .describe( 'The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for this resource.' ), - /** If `reversal`, this line item reverses an earlier transaction. */ + /**If `reversal`, this line item reverses an earlier transaction.*/ type: z .enum(['reversal', 'transaction']) .describe( @@ -21583,7 +20581,7 @@ export namespace stripe { export const TerminalLocationSchema = z .object({ address: AddressSchema, - /** The ID of a configuration that will be used to customize all readers in this location. */ + /**The ID of a configuration that will be used to customize all readers in this location.*/ configuration_overrides: z .string() .max(5000) @@ -21591,26 +20589,26 @@ export namespace stripe { 'The ID of a configuration that will be used to customize all readers in this location.' ) .optional(), - /** The display name of the location. */ + /**The display name of the location.*/ display_name: z .string() .max(5000) .describe('The display name of the location.'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('terminal.location') .describe( @@ -21622,17 +20620,17 @@ export namespace stripe { ) export type TerminalLocation = z.infer - /** Represents a per-transaction override of a reader configuration */ + /**Represents a per-transaction override of a reader configuration*/ export const TerminalReaderReaderResourceProcessConfigSchema = z .object({ - /** Enable customer initiated cancellation when processing this payment. */ + /**Enable customer initiated cancellation when processing this payment.*/ enable_customer_cancellation: z .boolean() .describe( 'Enable customer initiated cancellation when processing this payment.' ) .optional(), - /** Override showing a tipping selection screen on this transaction. */ + /**Override showing a tipping selection screen on this transaction.*/ skip_tipping: z .boolean() .describe( @@ -21646,29 +20644,28 @@ export namespace stripe { typeof TerminalReaderReaderResourceProcessConfigSchema > - /** Represents a cart to be displayed on the reader */ + /**Represents a cart to be displayed on the reader*/ export const TerminalReaderReaderResourceCartSchema = z .object({ - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** List of line items in the cart. */ + /**List of line items in the cart.*/ line_items: z .array(TerminalReaderReaderResourceLineItemSchema) .describe('List of line items in the cart.'), - /** Tax amount for the entire cart. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /**Tax amount for the entire cart. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).*/ tax: z .number() .int() - .nullable() .describe( 'Tax amount for the entire cart. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).' ) .optional(), - /** Total amount for the entire cart, including tax. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /**Total amount for the entire cart, including tax. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).*/ total: z .number() .int() @@ -21683,32 +20680,27 @@ export namespace stripe { export const TreasurySharedResourceBillingDetailsSchema = z.object({ address: AddressSchema, - /** Email address. */ - email: z - .string() - .max(5000) - .nullable() - .describe('Email address.') - .optional(), - /** Full name. */ - name: z.string().max(5000).nullable().describe('Full name.').optional() + /**Email address.*/ + email: z.string().max(5000).describe('Email address.').optional(), + /**Full name.*/ + name: z.string().max(5000).describe('Full name.').optional() }) export type TreasurySharedResourceBillingDetails = z.infer< typeof TreasurySharedResourceBillingDetailsSchema > - /** Toggle settings for enabling/disabling a feature */ + /**Toggle settings for enabling/disabling a feature*/ export const TreasuryFinancialAccountsResourceToggleSettingsSchema = z .object({ - /** Whether the FinancialAccount should have the Feature. */ + /**Whether the FinancialAccount should have the Feature.*/ requested: z .boolean() .describe('Whether the FinancialAccount should have the Feature.'), - /** Whether the Feature is operational. */ + /**Whether the Feature is operational.*/ status: z .enum(['active', 'pending', 'restricted']) .describe('Whether the Feature is operational.'), - /** Additional details; includes at least one entry when the status is not `active`. */ + /**Additional details; includes at least one entry when the status is not `active`.*/ status_details: z .array( TreasuryFinancialAccountsResourceTogglesSettingStatusDetailsSchema @@ -21722,18 +20714,18 @@ export namespace stripe { typeof TreasuryFinancialAccountsResourceToggleSettingsSchema > - /** Toggle settings for enabling/disabling the ABA address feature */ + /**Toggle settings for enabling/disabling the ABA address feature*/ export const TreasuryFinancialAccountsResourceAbaToggleSettingsSchema = z .object({ - /** Whether the FinancialAccount should have the Feature. */ + /**Whether the FinancialAccount should have the Feature.*/ requested: z .boolean() .describe('Whether the FinancialAccount should have the Feature.'), - /** Whether the Feature is operational. */ + /**Whether the Feature is operational.*/ status: z .enum(['active', 'pending', 'restricted']) .describe('Whether the Feature is operational.'), - /** Additional details; includes at least one entry when the status is not `active`. */ + /**Additional details; includes at least one entry when the status is not `active`.*/ status_details: z .array( TreasuryFinancialAccountsResourceTogglesSettingStatusDetailsSchema @@ -21747,19 +20739,19 @@ export namespace stripe { typeof TreasuryFinancialAccountsResourceAbaToggleSettingsSchema > - /** Toggle settings for enabling/disabling an inbound ACH specific feature */ + /**Toggle settings for enabling/disabling an inbound ACH specific feature*/ export const TreasuryFinancialAccountsResourceInboundAchToggleSettingsSchema = z .object({ - /** Whether the FinancialAccount should have the Feature. */ + /**Whether the FinancialAccount should have the Feature.*/ requested: z .boolean() .describe('Whether the FinancialAccount should have the Feature.'), - /** Whether the Feature is operational. */ + /**Whether the Feature is operational.*/ status: z .enum(['active', 'pending', 'restricted']) .describe('Whether the Feature is operational.'), - /** Additional details; includes at least one entry when the status is not `active`. */ + /**Additional details; includes at least one entry when the status is not `active`.*/ status_details: z .array( TreasuryFinancialAccountsResourceTogglesSettingStatusDetailsSchema @@ -21776,19 +20768,19 @@ export namespace stripe { typeof TreasuryFinancialAccountsResourceInboundAchToggleSettingsSchema > - /** Toggle settings for enabling/disabling an outbound ACH specific feature */ + /**Toggle settings for enabling/disabling an outbound ACH specific feature*/ export const TreasuryFinancialAccountsResourceOutboundAchToggleSettingsSchema = z .object({ - /** Whether the FinancialAccount should have the Feature. */ + /**Whether the FinancialAccount should have the Feature.*/ requested: z .boolean() .describe('Whether the FinancialAccount should have the Feature.'), - /** Whether the Feature is operational. */ + /**Whether the Feature is operational.*/ status: z .enum(['active', 'pending', 'restricted']) .describe('Whether the Feature is operational.'), - /** Additional details; includes at least one entry when the status is not `active`. */ + /**Additional details; includes at least one entry when the status is not `active`.*/ status_details: z .array( TreasuryFinancialAccountsResourceTogglesSettingStatusDetailsSchema @@ -21805,16 +20797,16 @@ export namespace stripe { typeof TreasuryFinancialAccountsResourceOutboundAchToggleSettingsSchema > - /** FinancialAddresses contain identifying information that resolves to a FinancialAccount. */ + /**FinancialAddresses contain identifying information that resolves to a FinancialAccount.*/ export const TreasuryFinancialAccountsResourceFinancialAddressSchema = z .object({ aba: TreasuryFinancialAccountsResourceAbaRecordSchema.optional(), - /** The list of networks that the address supports */ + /**The list of networks that the address supports*/ supported_networks: z .array(z.enum(['ach', 'us_domestic_wire'])) .describe('The list of networks that the address supports') .optional(), - /** The type of financial address */ + /**The type of financial address*/ type: z.literal('aba').describe('The type of financial address') }) .describe( @@ -21825,47 +20817,42 @@ export namespace stripe { > export const TreasuryFinancialAccountsResourceStatusDetailsSchema = z.object({ - /** Details related to the closure of this FinancialAccount */ - closed: - TreasuryFinancialAccountsResourceClosedStatusDetailsSchema.nullable() - .describe('Details related to the closure of this FinancialAccount') - .optional() + /**Details related to the closure of this FinancialAccount*/ + closed: TreasuryFinancialAccountsResourceClosedStatusDetailsSchema.describe( + 'Details related to the closure of this FinancialAccount' + ).optional() }) export type TreasuryFinancialAccountsResourceStatusDetails = z.infer< typeof TreasuryFinancialAccountsResourceStatusDetailsSchema > export const LegalEntityCompanyVerificationDocumentSchema = z.object({ - /** The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. */ + /**The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`.*/ back: z .union([z.string().max(5000), FileSchema]) - .nullable() .describe( 'The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`.' ) .optional(), - /** A user-displayable string describing the verification state of this document. */ + /**A user-displayable string describing the verification state of this document.*/ details: z .string() .max(5000) - .nullable() .describe( 'A user-displayable string describing the verification state of this document.' ) .optional(), - /** One of `document_corrupt`, `document_expired`, `document_failed_copy`, `document_failed_greyscale`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_not_readable`, `document_not_uploaded`, `document_type_not_supported`, or `document_too_large`. A machine-readable code specifying the verification state for this document. */ + /**One of `document_corrupt`, `document_expired`, `document_failed_copy`, `document_failed_greyscale`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_not_readable`, `document_not_uploaded`, `document_type_not_supported`, or `document_too_large`. A machine-readable code specifying the verification state for this document.*/ details_code: z .string() .max(5000) - .nullable() .describe( 'One of `document_corrupt`, `document_expired`, `document_failed_copy`, `document_failed_greyscale`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_not_readable`, `document_not_uploaded`, `document_type_not_supported`, or `document_too_large`. A machine-readable code specifying the verification state for this document.' ) .optional(), - /** The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. */ + /**The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`.*/ front: z .union([z.string().max(5000), FileSchema]) - .nullable() .describe( 'The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`.' ) @@ -21882,116 +20869,108 @@ export namespace stripe { */ export const CouponSchema = z .object({ - /** Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer. */ + /**Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer.*/ amount_off: z .number() .int() - .nullable() .describe( 'Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer.' ) .optional(), applies_to: CouponAppliesToSchema.optional(), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** If `amount_off` has been set, the three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the amount to take off. */ + /**If `amount_off` has been set, the three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the amount to take off.*/ currency: z .string() - .nullable() .describe( 'If `amount_off` has been set, the three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the amount to take off.' ) .optional(), - /** Coupons defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). */ + /**Coupons defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).*/ currency_options: z .record(CouponCurrencyOptionSchema) .describe( 'Coupons defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).' ) .optional(), - /** One of `forever`, `once`, and `repeating`. Describes how long a customer who applies this coupon will get the discount. */ + /**One of `forever`, `once`, and `repeating`. Describes how long a customer who applies this coupon will get the discount.*/ duration: z .enum(['forever', 'once', 'repeating']) .describe( 'One of `forever`, `once`, and `repeating`. Describes how long a customer who applies this coupon will get the discount.' ), - /** If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`. */ + /**If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`.*/ duration_in_months: z .number() .int() - .nullable() .describe( 'If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`.' ) .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid. */ + /**Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.*/ max_redemptions: z .number() .int() - .nullable() .describe( 'Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.' ) .optional(), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) - .nullable() .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ) .optional(), - /** Name of the coupon displayed to customers on for instance invoices or receipts. */ + /**Name of the coupon displayed to customers on for instance invoices or receipts.*/ name: z .string() .max(5000) - .nullable() .describe( 'Name of the coupon displayed to customers on for instance invoices or receipts.' ) .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('coupon') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a $ (or local equivalent)100 invoice $ (or local equivalent)50 instead. */ + /**Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a $ (or local equivalent)100 invoice $ (or local equivalent)50 instead.*/ percent_off: z .number() - .nullable() .describe( 'Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a $ (or local equivalent)100 invoice $ (or local equivalent)50 instead.' ) .optional(), - /** Date after which the coupon can no longer be redeemed. */ + /**Date after which the coupon can no longer be redeemed.*/ redeem_by: z .number() .int() - .nullable() .describe('Date after which the coupon can no longer be redeemed.') .optional(), - /** Number of times this coupon has been applied to a customer. */ + /**Number of times this coupon has been applied to a customer.*/ times_redeemed: z .number() .int() .describe( 'Number of times this coupon has been applied to a customer.' ), - /** Taking account of the above properties, whether this coupon can still be applied to a customer. */ + /**Taking account of the above properties, whether this coupon can still be applied to a customer.*/ valid: z .boolean() .describe( @@ -22004,16 +20983,15 @@ export namespace stripe { export type Coupon = z.infer export const CustomerAcceptanceSchema = z.object({ - /** The time that the customer accepts the mandate. */ + /**The time that the customer accepts the mandate.*/ accepted_at: z .number() .int() - .nullable() .describe('The time that the customer accepts the mandate.') .optional(), offline: OfflineAcceptanceSchema.optional(), online: OnlineAcceptanceSchema.optional(), - /** The mandate includes the type of customer acceptance information, such as: `online` or `offline`. */ + /**The mandate includes the type of customer acceptance information, such as: `online` or `offline`.*/ type: z .enum(['offline', 'online']) .describe( @@ -22025,7 +21003,7 @@ export namespace stripe { export const SetupAttemptPaymentMethodDetailsCardWalletSchema = z.object({ apple_pay: PaymentMethodDetailsCardWalletApplePaySchema.optional(), google_pay: PaymentMethodDetailsCardWalletGooglePaySchema.optional(), - /** The type of the card wallet, one of `apple_pay`, `google_pay`, or `link`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type. */ + /**The type of the card wallet, one of `apple_pay`, `google_pay`, or `link`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.*/ type: z .enum(['apple_pay', 'google_pay', 'link']) .describe( @@ -22038,7 +21016,7 @@ export namespace stripe { export const RefundNextActionSchema = z.object({ display_details: RefundNextActionDisplayDetailsSchema.optional(), - /** Type of the next action to perform. */ + /**Type of the next action to perform.*/ type: z.string().max(5000).describe('Type of the next action to perform.') }) export type RefundNextAction = z.infer @@ -22053,18 +21031,16 @@ export namespace stripe { > export const IssuingCardholderIdDocumentSchema = z.object({ - /** The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. */ + /**The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.*/ back: z .union([z.string().max(5000), FileSchema]) - .nullable() .describe( 'The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.' ) .optional(), - /** The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. */ + /**The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.*/ front: z .union([z.string().max(5000), FileSchema]) - .nullable() .describe( 'The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.' ) @@ -22077,87 +21053,76 @@ export namespace stripe { export const IssuingCardWalletsSchema = z.object({ apple_pay: IssuingCardApplePaySchema, google_pay: IssuingCardGooglePaySchema, - /** Unique identifier for a card used with digital wallets */ + /**Unique identifier for a card used with digital wallets*/ primary_account_identifier: z .string() .max(5000) - .nullable() .describe('Unique identifier for a card used with digital wallets') .optional() }) export type IssuingCardWallets = z.infer export const IssuingDisputeCanceledEvidenceSchema = z.object({ - /** (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ + /**(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.*/ additional_documentation: z .union([z.string().max(5000), FileSchema]) - .nullable() .describe( '(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.' ) .optional(), - /** Date when order was canceled. */ + /**Date when order was canceled.*/ canceled_at: z .number() .int() - .nullable() .describe('Date when order was canceled.') .optional(), - /** Whether the cardholder was provided with a cancellation policy. */ + /**Whether the cardholder was provided with a cancellation policy.*/ cancellation_policy_provided: z .boolean() - .nullable() .describe( 'Whether the cardholder was provided with a cancellation policy.' ) .optional(), - /** Reason for canceling the order. */ + /**Reason for canceling the order.*/ cancellation_reason: z .string() .max(5000) - .nullable() .describe('Reason for canceling the order.') .optional(), - /** Date when the cardholder expected to receive the product. */ + /**Date when the cardholder expected to receive the product.*/ expected_at: z .number() .int() - .nullable() .describe('Date when the cardholder expected to receive the product.') .optional(), - /** Explanation of why the cardholder is disputing this transaction. */ + /**Explanation of why the cardholder is disputing this transaction.*/ explanation: z .string() .max(5000) - .nullable() .describe( 'Explanation of why the cardholder is disputing this transaction.' ) .optional(), - /** Description of the merchandise or service that was purchased. */ + /**Description of the merchandise or service that was purchased.*/ product_description: z .string() .max(5000) - .nullable() .describe('Description of the merchandise or service that was purchased.') .optional(), - /** Whether the product was a merchandise or service. */ + /**Whether the product was a merchandise or service.*/ product_type: z .enum(['merchandise', 'service']) - .nullable() .describe('Whether the product was a merchandise or service.') .optional(), - /** Result of cardholder's attempt to return the product. */ + /**Result of cardholder's attempt to return the product.*/ return_status: z .enum(['merchant_rejected', 'successful']) - .nullable() .describe("Result of cardholder's attempt to return the product.") .optional(), - /** Date when the product was returned or attempted to be returned. */ + /**Date when the product was returned or attempted to be returned.*/ returned_at: z .number() .int() - .nullable() .describe( 'Date when the product was returned or attempted to be returned.' ) @@ -22168,52 +21133,46 @@ export namespace stripe { > export const IssuingDisputeDuplicateEvidenceSchema = z.object({ - /** (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ + /**(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.*/ additional_documentation: z .union([z.string().max(5000), FileSchema]) - .nullable() .describe( '(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.' ) .optional(), - /** (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the card statement showing that the product had already been paid for. */ + /**(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the card statement showing that the product had already been paid for.*/ card_statement: z .union([z.string().max(5000), FileSchema]) - .nullable() .describe( '(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the card statement showing that the product had already been paid for.' ) .optional(), - /** (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the receipt showing that the product had been paid for in cash. */ + /**(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the receipt showing that the product had been paid for in cash.*/ cash_receipt: z .union([z.string().max(5000), FileSchema]) - .nullable() .describe( '(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the receipt showing that the product had been paid for in cash.' ) .optional(), - /** (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Image of the front and back of the check that was used to pay for the product. */ + /**(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Image of the front and back of the check that was used to pay for the product.*/ check_image: z .union([z.string().max(5000), FileSchema]) - .nullable() .describe( '(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Image of the front and back of the check that was used to pay for the product.' ) .optional(), - /** Explanation of why the cardholder is disputing this transaction. */ + /**Explanation of why the cardholder is disputing this transaction.*/ explanation: z .string() .max(5000) - .nullable() .describe( 'Explanation of why the cardholder is disputing this transaction.' ) .optional(), - /** Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one. */ + /**Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one.*/ original_transaction: z .string() .max(5000) - .nullable() .describe( 'Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one.' ) @@ -22224,19 +21183,17 @@ export namespace stripe { > export const IssuingDisputeFraudulentEvidenceSchema = z.object({ - /** (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ + /**(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.*/ additional_documentation: z .union([z.string().max(5000), FileSchema]) - .nullable() .describe( '(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.' ) .optional(), - /** Explanation of why the cardholder is disputing this transaction. */ + /**Explanation of why the cardholder is disputing this transaction.*/ explanation: z .string() .max(5000) - .nullable() .describe( 'Explanation of why the cardholder is disputing this transaction.' ) @@ -22248,50 +21205,44 @@ export namespace stripe { export const IssuingDisputeMerchandiseNotAsDescribedEvidenceSchema = z.object( { - /** (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ + /**(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.*/ additional_documentation: z .union([z.string().max(5000), FileSchema]) - .nullable() .describe( '(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.' ) .optional(), - /** Explanation of why the cardholder is disputing this transaction. */ + /**Explanation of why the cardholder is disputing this transaction.*/ explanation: z .string() .max(5000) - .nullable() .describe( 'Explanation of why the cardholder is disputing this transaction.' ) .optional(), - /** Date when the product was received. */ + /**Date when the product was received.*/ received_at: z .number() .int() - .nullable() .describe('Date when the product was received.') .optional(), - /** Description of the cardholder's attempt to return the product. */ + /**Description of the cardholder's attempt to return the product.*/ return_description: z .string() .max(5000) - .nullable() .describe( "Description of the cardholder's attempt to return the product." ) .optional(), - /** Result of cardholder's attempt to return the product. */ + /**Result of cardholder's attempt to return the product.*/ return_status: z .enum(['merchant_rejected', 'successful']) - .nullable() .describe("Result of cardholder's attempt to return the product.") .optional(), - /** Date when the product was returned or attempted to be returned. */ + /**Date when the product was returned or attempted to be returned.*/ returned_at: z .number() .int() - .nullable() .describe( 'Date when the product was returned or attempted to be returned.' ) @@ -22303,19 +21254,17 @@ export namespace stripe { > export const IssuingDisputeNoValidAuthorizationEvidenceSchema = z.object({ - /** (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ + /**(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.*/ additional_documentation: z .union([z.string().max(5000), FileSchema]) - .nullable() .describe( '(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.' ) .optional(), - /** Explanation of why the cardholder is disputing this transaction. */ + /**Explanation of why the cardholder is disputing this transaction.*/ explanation: z .string() .max(5000) - .nullable() .describe( 'Explanation of why the cardholder is disputing this transaction.' ) @@ -22326,41 +21275,36 @@ export namespace stripe { > export const IssuingDisputeNotReceivedEvidenceSchema = z.object({ - /** (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ + /**(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.*/ additional_documentation: z .union([z.string().max(5000), FileSchema]) - .nullable() .describe( '(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.' ) .optional(), - /** Date when the cardholder expected to receive the product. */ + /**Date when the cardholder expected to receive the product.*/ expected_at: z .number() .int() - .nullable() .describe('Date when the cardholder expected to receive the product.') .optional(), - /** Explanation of why the cardholder is disputing this transaction. */ + /**Explanation of why the cardholder is disputing this transaction.*/ explanation: z .string() .max(5000) - .nullable() .describe( 'Explanation of why the cardholder is disputing this transaction.' ) .optional(), - /** Description of the merchandise or service that was purchased. */ + /**Description of the merchandise or service that was purchased.*/ product_description: z .string() .max(5000) - .nullable() .describe('Description of the merchandise or service that was purchased.') .optional(), - /** Whether the product was a merchandise or service. */ + /**Whether the product was a merchandise or service.*/ product_type: z .enum(['merchandise', 'service']) - .nullable() .describe('Whether the product was a merchandise or service.') .optional() }) @@ -22369,34 +21313,30 @@ export namespace stripe { > export const IssuingDisputeOtherEvidenceSchema = z.object({ - /** (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ + /**(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.*/ additional_documentation: z .union([z.string().max(5000), FileSchema]) - .nullable() .describe( '(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.' ) .optional(), - /** Explanation of why the cardholder is disputing this transaction. */ + /**Explanation of why the cardholder is disputing this transaction.*/ explanation: z .string() .max(5000) - .nullable() .describe( 'Explanation of why the cardholder is disputing this transaction.' ) .optional(), - /** Description of the merchandise or service that was purchased. */ + /**Description of the merchandise or service that was purchased.*/ product_description: z .string() .max(5000) - .nullable() .describe('Description of the merchandise or service that was purchased.') .optional(), - /** Whether the product was a merchandise or service. */ + /**Whether the product was a merchandise or service.*/ product_type: z .enum(['merchandise', 'service']) - .nullable() .describe('Whether the product was a merchandise or service.') .optional() }) @@ -22405,42 +21345,37 @@ export namespace stripe { > export const IssuingDisputeServiceNotAsDescribedEvidenceSchema = z.object({ - /** (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute. */ + /**(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.*/ additional_documentation: z .union([z.string().max(5000), FileSchema]) - .nullable() .describe( '(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.' ) .optional(), - /** Date when order was canceled. */ + /**Date when order was canceled.*/ canceled_at: z .number() .int() - .nullable() .describe('Date when order was canceled.') .optional(), - /** Reason for canceling the order. */ + /**Reason for canceling the order.*/ cancellation_reason: z .string() .max(5000) - .nullable() .describe('Reason for canceling the order.') .optional(), - /** Explanation of why the cardholder is disputing this transaction. */ + /**Explanation of why the cardholder is disputing this transaction.*/ explanation: z .string() .max(5000) - .nullable() .describe( 'Explanation of why the cardholder is disputing this transaction.' ) .optional(), - /** Date when the product was received. */ + /**Date when the product was received.*/ received_at: z .number() .int() - .nullable() .describe('Date when the product was received.') .optional() }) @@ -22449,48 +21384,48 @@ export namespace stripe { > export const IssuingAuthorizationVerificationDataSchema = z.object({ - /** Whether the cardholder provided an address first line and if it matched the cardholder’s `billing.address.line1`. */ + /**Whether the cardholder provided an address first line and if it matched the cardholder’s `billing.address.line1`.*/ address_line1_check: z .enum(['match', 'mismatch', 'not_provided']) .describe( 'Whether the cardholder provided an address first line and if it matched the cardholder’s `billing.address.line1`.' ), - /** Whether the cardholder provided a postal code and if it matched the cardholder’s `billing.address.postal_code`. */ + /**Whether the cardholder provided a postal code and if it matched the cardholder’s `billing.address.postal_code`.*/ address_postal_code_check: z .enum(['match', 'mismatch', 'not_provided']) .describe( 'Whether the cardholder provided a postal code and if it matched the cardholder’s `billing.address.postal_code`.' ), - /** The exemption applied to this authorization. */ + /**The exemption applied to this authorization.*/ authentication_exemption: - IssuingAuthorizationAuthenticationExemptionSchema.nullable() - .describe('The exemption applied to this authorization.') - .optional(), - /** Whether the cardholder provided a CVC and if it matched Stripe’s record. */ + IssuingAuthorizationAuthenticationExemptionSchema.describe( + 'The exemption applied to this authorization.' + ).optional(), + /**Whether the cardholder provided a CVC and if it matched Stripe’s record.*/ cvc_check: z .enum(['match', 'mismatch', 'not_provided']) .describe( 'Whether the cardholder provided a CVC and if it matched Stripe’s record.' ), - /** Whether the cardholder provided an expiry date and if it matched Stripe’s record. */ + /**Whether the cardholder provided an expiry date and if it matched Stripe’s record.*/ expiry_check: z .enum(['match', 'mismatch', 'not_provided']) .describe( 'Whether the cardholder provided an expiry date and if it matched Stripe’s record.' ), - /** The postal code submitted as part of the authorization used for postal code verification. */ + /**The postal code submitted as part of the authorization used for postal code verification.*/ postal_code: z .string() .max(5000) - .nullable() .describe( 'The postal code submitted as part of the authorization used for postal code verification.' ) .optional(), - /** 3D Secure details. */ - three_d_secure: IssuingAuthorizationThreeDSecureSchema.nullable() - .describe('3D Secure details.') - .optional() + /**3D Secure details.*/ + three_d_secure: + IssuingAuthorizationThreeDSecureSchema.describe( + '3D Secure details.' + ).optional() }) export type IssuingAuthorizationVerificationData = z.infer< typeof IssuingAuthorizationVerificationDataSchema @@ -22504,10 +21439,10 @@ export namespace stripe { > export const PaymentMethodDetailsKlarnaSchema = z.object({ - /** The payer details for this transaction. */ - payer_details: KlarnaPayerDetailsSchema.nullable() - .describe('The payer details for this transaction.') - .optional(), + /**The payer details for this transaction.*/ + payer_details: KlarnaPayerDetailsSchema.describe( + 'The payer details for this transaction.' + ).optional(), /** * The Klarna payment method used for this transaction. * Can be one of `pay_later`, `pay_now`, `pay_with_financing`, or `pay_in_installments` @@ -22515,7 +21450,6 @@ export namespace stripe { payment_method_category: z .string() .max(5000) - .nullable() .describe( 'The Klarna payment method used for this transaction.\nCan be one of `pay_later`, `pay_now`, `pay_with_financing`, or `pay_in_installments`' ) @@ -22527,7 +21461,6 @@ export namespace stripe { preferred_locale: z .string() .max(5000) - .nullable() .describe( 'Preferred language of the Klarna authorization page that the customer is redirected to.\nCan be one of `de-AT`, `en-AT`, `nl-BE`, `fr-BE`, `en-BE`, `de-DE`, `en-DE`, `da-DK`, `en-DK`, `es-ES`, `en-ES`, `fi-FI`, `sv-FI`, `en-FI`, `en-GB`, `en-IE`, `it-IT`, `en-IT`, `nl-NL`, `en-NL`, `nb-NO`, `en-NO`, `sv-SE`, `en-SE`, `en-US`, `es-US`, `fr-FR`, `en-FR`, `cs-CZ`, `en-CZ`, `ro-RO`, `en-RO`, `el-GR`, `en-GR`, `en-AU`, `en-NZ`, `en-CA`, `fr-CA`, `pl-PL`, `en-PL`, `pt-PT`, `en-PT`, `de-CH`, `fr-CH`, `it-CH`, or `en-CH`' ) @@ -22545,40 +21478,35 @@ export namespace stripe { > export const CurrencyOptionSchema = z.object({ - /** When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links. */ - custom_unit_amount: CustomUnitAmountSchema.nullable() - .describe( - 'When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.' - ) - .optional(), - /** Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. */ + /**When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.*/ + custom_unit_amount: CustomUnitAmountSchema.describe( + 'When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.' + ).optional(), + /**Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.*/ tax_behavior: z .enum(['exclusive', 'inclusive', 'unspecified']) - .nullable() .describe( 'Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.' ) .optional(), - /** Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ + /**Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.*/ tiers: z .array(PriceTierSchema) .describe( 'Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.' ) .optional(), - /** The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. */ + /**The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.*/ unit_amount: z .number() .int() - .nullable() .describe( 'The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.' ) .optional(), - /** The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. */ + /**The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.*/ unit_amount_decimal: z .string() - .nullable() .describe( 'The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.' ) @@ -22589,10 +21517,9 @@ export namespace stripe { export const InvoicePaymentMethodOptionsCustomerBalanceSchema = z.object({ bank_transfer: InvoicePaymentMethodOptionsCustomerBalanceBankTransferSchema.optional(), - /** The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`. */ + /**The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.*/ funding_type: z .literal('bank_transfer') - .nullable() .describe( 'The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.' ) @@ -22605,7 +21532,7 @@ export namespace stripe { export const InvoicePaymentMethodOptionsUsBankAccountSchema = z.object({ financial_connections: InvoicePaymentMethodOptionsUsBankAccountLinkedAccountOptionsSchema.optional(), - /** Bank account verification method. */ + /**Bank account verification method.*/ verification_method: z .enum(['automatic', 'instant', 'microdeposits']) .describe('Bank account verification method.') @@ -22622,47 +21549,46 @@ export namespace stripe { */ export const TestHelpersTestClockSchema = z .object({ - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Time at which this clock is scheduled to auto delete. */ + /**Time at which this clock is scheduled to auto delete.*/ deletes_after: z .number() .int() .describe('Time at which this clock is scheduled to auto delete.'), - /** Time at which all objects belonging to this clock are frozen. */ + /**Time at which all objects belonging to this clock are frozen.*/ frozen_time: z .number() .int() .describe( 'Time at which all objects belonging to this clock are frozen.' ), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** The custom name supplied at creation. */ + /**The custom name supplied at creation.*/ name: z .string() .max(5000) - .nullable() .describe('The custom name supplied at creation.') .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('test_helpers.test_clock') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The status of the Test Clock. */ + /**The status of the Test Clock.*/ status: z .enum(['advancing', 'internal_failure', 'ready']) .describe('The status of the Test Clock.'), @@ -22681,20 +21607,20 @@ export namespace stripe { > export const InvoiceTaxAmountSchema = z.object({ - /** The amount, in cents (or local equivalent), of the tax. */ + /**The amount, in cents (or local equivalent), of the tax.*/ amount: z .number() .int() .describe('The amount, in cents (or local equivalent), of the tax.'), - /** Whether this tax amount is inclusive or exclusive. */ + /**Whether this tax amount is inclusive or exclusive.*/ inclusive: z .boolean() .describe('Whether this tax amount is inclusive or exclusive.'), - /** The tax rate that was applied to get this tax amount. */ + /**The tax rate that was applied to get this tax amount.*/ tax_rate: z .union([z.string().max(5000), TaxRateSchema]) .describe('The tax rate that was applied to get this tax amount.'), - /** The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. */ + /**The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.*/ taxability_reason: z .enum([ 'customer_exempt', @@ -22713,16 +21639,14 @@ export namespace stripe { 'taxable_basis_reduced', 'zero_rated' ]) - .nullable() .describe( 'The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.' ) .optional(), - /** The amount on which tax is calculated, in cents (or local equivalent). */ + /**The amount on which tax is calculated, in cents (or local equivalent).*/ taxable_amount: z .number() .int() - .nullable() .describe( 'The amount on which tax is calculated, in cents (or local equivalent).' ) @@ -22731,10 +21655,10 @@ export namespace stripe { export type InvoiceTaxAmount = z.infer export const LineItemsTaxAmountSchema = z.object({ - /** Amount of tax applied for this rate. */ + /**Amount of tax applied for this rate.*/ amount: z.number().int().describe('Amount of tax applied for this rate.'), rate: TaxRateSchema, - /** The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. */ + /**The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.*/ taxability_reason: z .enum([ 'customer_exempt', @@ -22753,16 +21677,14 @@ export namespace stripe { 'taxable_basis_reduced', 'zero_rated' ]) - .nullable() .describe( 'The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.' ) .optional(), - /** The amount on which tax is calculated, in cents (or local equivalent). */ + /**The amount on which tax is calculated, in cents (or local equivalent).*/ taxable_amount: z .number() .int() - .nullable() .describe( 'The amount on which tax is calculated, in cents (or local equivalent).' ) @@ -22773,10 +21695,9 @@ export namespace stripe { export const PaymentMethodOptionsCustomerBalanceSchema = z.object({ bank_transfer: PaymentMethodOptionsCustomerBalanceBankTransferSchema.optional(), - /** The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`. */ + /**The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.*/ funding_type: z .literal('bank_transfer') - .nullable() .describe( 'The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.' ) @@ -22803,7 +21724,7 @@ export namespace stripe { export const PaymentIntentProcessingSchema = z.object({ card: PaymentIntentCardProcessingSchema.optional(), - /** Type of the payment method for which payment is in `processing` state, one of `card`. */ + /**Type of the payment method for which payment is in `processing` state, one of `card`.*/ type: z .literal('card') .describe( @@ -22815,32 +21736,29 @@ export namespace stripe { > export const AccountFutureRequirementsSchema = z.object({ - /** Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ + /**Fields that are due and can be satisfied by providing the corresponding alternative fields instead.*/ alternatives: z .array(AccountRequirementsAlternativeSchema) - .nullable() .describe( 'Fields that are due and can be satisfied by providing the corresponding alternative fields instead.' ) .optional(), - /** Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on its enablement state prior to transitioning. */ + /**Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on its enablement state prior to transitioning.*/ current_deadline: z .number() .int() - .nullable() .describe( 'Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on its enablement state prior to transitioning.' ) .optional(), - /** Fields that need to be collected to keep the account enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash. */ + /**Fields that need to be collected to keep the account enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash.*/ currently_due: z .array(z.string().max(5000)) - .nullable() .describe( 'Fields that need to be collected to keep the account enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash.' ) .optional(), - /** This is typed as an enum for consistency with `requirements.disabled_reason`. */ + /**This is typed as an enum for consistency with `requirements.disabled_reason`.*/ disabled_reason: z .enum([ 'action_required.requested_capabilities', @@ -22859,39 +21777,34 @@ export namespace stripe { 'requirements.pending_verification', 'under_review' ]) - .nullable() .describe( 'This is typed as an enum for consistency with `requirements.disabled_reason`.' ) .optional(), - /** Fields that are `currently_due` and need to be collected again because validation or verification failed. */ + /**Fields that are `currently_due` and need to be collected again because validation or verification failed.*/ errors: z .array(AccountRequirementsErrorSchema) - .nullable() .describe( 'Fields that are `currently_due` and need to be collected again because validation or verification failed.' ) .optional(), - /** Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well. */ + /**Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well.*/ eventually_due: z .array(z.string().max(5000)) - .nullable() .describe( 'Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well.' ) .optional(), - /** Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`. */ + /**Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`.*/ past_due: z .array(z.string().max(5000)) - .nullable() .describe( "Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`." ) .optional(), - /** Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending. */ + /**Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending.*/ pending_verification: z .array(z.string().max(5000)) - .nullable() .describe( "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending." ) @@ -22902,39 +21815,38 @@ export namespace stripe { > export const PersonFutureRequirementsSchema = z.object({ - /** Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ + /**Fields that are due and can be satisfied by providing the corresponding alternative fields instead.*/ alternatives: z .array(AccountRequirementsAlternativeSchema) - .nullable() .describe( 'Fields that are due and can be satisfied by providing the corresponding alternative fields instead.' ) .optional(), - /** Fields that need to be collected to keep the person's account enabled. If not collected by the account's `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash, and may immediately become `past_due`, but the account may also be given a grace period depending on the account's enablement state prior to transition. */ + /**Fields that need to be collected to keep the person's account enabled. If not collected by the account's `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash, and may immediately become `past_due`, but the account may also be given a grace period depending on the account's enablement state prior to transition.*/ currently_due: z .array(z.string().max(5000)) .describe( "Fields that need to be collected to keep the person's account enabled. If not collected by the account's `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash, and may immediately become `past_due`, but the account may also be given a grace period depending on the account's enablement state prior to transition." ), - /** Fields that are `currently_due` and need to be collected again because validation or verification failed. */ + /**Fields that are `currently_due` and need to be collected again because validation or verification failed.*/ errors: z .array(AccountRequirementsErrorSchema) .describe( 'Fields that are `currently_due` and need to be collected again because validation or verification failed.' ), - /** Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `future_requirements[current_deadline]` becomes set. */ + /**Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `future_requirements[current_deadline]` becomes set.*/ eventually_due: z .array(z.string().max(5000)) .describe( "Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `future_requirements[current_deadline]` becomes set." ), - /** Fields that weren't collected by the account's `requirements.current_deadline`. These fields need to be collected to enable the person's account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`. */ + /**Fields that weren't collected by the account's `requirements.current_deadline`. These fields need to be collected to enable the person's account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`.*/ past_due: z .array(z.string().max(5000)) .describe( "Fields that weren't collected by the account's `requirements.current_deadline`. These fields need to be collected to enable the person's account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`." ), - /** Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending. */ + /**Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending.*/ pending_verification: z .array(z.string().max(5000)) .describe( @@ -22946,39 +21858,38 @@ export namespace stripe { > export const PersonRequirementsSchema = z.object({ - /** Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ + /**Fields that are due and can be satisfied by providing the corresponding alternative fields instead.*/ alternatives: z .array(AccountRequirementsAlternativeSchema) - .nullable() .describe( 'Fields that are due and can be satisfied by providing the corresponding alternative fields instead.' ) .optional(), - /** Fields that need to be collected to keep the person's account enabled. If not collected by the account's `current_deadline`, these fields appear in `past_due` as well, and the account is disabled. */ + /**Fields that need to be collected to keep the person's account enabled. If not collected by the account's `current_deadline`, these fields appear in `past_due` as well, and the account is disabled.*/ currently_due: z .array(z.string().max(5000)) .describe( "Fields that need to be collected to keep the person's account enabled. If not collected by the account's `current_deadline`, these fields appear in `past_due` as well, and the account is disabled." ), - /** Fields that are `currently_due` and need to be collected again because validation or verification failed. */ + /**Fields that are `currently_due` and need to be collected again because validation or verification failed.*/ errors: z .array(AccountRequirementsErrorSchema) .describe( 'Fields that are `currently_due` and need to be collected again because validation or verification failed.' ), - /** Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `current_deadline` becomes set. */ + /**Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `current_deadline` becomes set.*/ eventually_due: z .array(z.string().max(5000)) .describe( "Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `current_deadline` becomes set." ), - /** Fields that weren't collected by the account's `current_deadline`. These fields need to be collected to enable the person's account. */ + /**Fields that weren't collected by the account's `current_deadline`. These fields need to be collected to enable the person's account.*/ past_due: z .array(z.string().max(5000)) .describe( "Fields that weren't collected by the account's `current_deadline`. These fields need to be collected to enable the person's account." ), - /** Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending. */ + /**Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.*/ pending_verification: z .array(z.string().max(5000)) .describe( @@ -22988,36 +21899,32 @@ export namespace stripe { export type PersonRequirements = z.infer export const LegalEntityPersonVerificationDocumentSchema = z.object({ - /** The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. */ + /**The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.*/ back: z .union([z.string().max(5000), FileSchema]) - .nullable() .describe( 'The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.' ) .optional(), - /** A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read". */ + /**A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read".*/ details: z .string() .max(5000) - .nullable() .describe( 'A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read".' ) .optional(), - /** One of `document_corrupt`, `document_country_not_supported`, `document_expired`, `document_failed_copy`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_failed_greyscale`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_missing_back`, `document_missing_front`, `document_not_readable`, `document_not_uploaded`, `document_photo_mismatch`, `document_too_large`, or `document_type_not_supported`. A machine-readable code specifying the verification state for this document. */ + /**One of `document_corrupt`, `document_country_not_supported`, `document_expired`, `document_failed_copy`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_failed_greyscale`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_missing_back`, `document_missing_front`, `document_not_readable`, `document_not_uploaded`, `document_photo_mismatch`, `document_too_large`, or `document_type_not_supported`. A machine-readable code specifying the verification state for this document.*/ details_code: z .string() .max(5000) - .nullable() .describe( 'One of `document_corrupt`, `document_country_not_supported`, `document_expired`, `document_failed_copy`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_failed_greyscale`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_missing_back`, `document_missing_front`, `document_not_readable`, `document_not_uploaded`, `document_photo_mismatch`, `document_too_large`, or `document_type_not_supported`. A machine-readable code specifying the verification state for this document.' ) .optional(), - /** The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. */ + /**The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.*/ front: z .union([z.string().max(5000), FileSchema]) - .nullable() .describe( 'The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`.' ) @@ -23028,32 +21935,29 @@ export namespace stripe { > export const AccountRequirementsSchema = z.object({ - /** Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ + /**Fields that are due and can be satisfied by providing the corresponding alternative fields instead.*/ alternatives: z .array(AccountRequirementsAlternativeSchema) - .nullable() .describe( 'Fields that are due and can be satisfied by providing the corresponding alternative fields instead.' ) .optional(), - /** Date by which the fields in `currently_due` must be collected to keep the account enabled. These fields may disable the account sooner if the next threshold is reached before they are collected. */ + /**Date by which the fields in `currently_due` must be collected to keep the account enabled. These fields may disable the account sooner if the next threshold is reached before they are collected.*/ current_deadline: z .number() .int() - .nullable() .describe( 'Date by which the fields in `currently_due` must be collected to keep the account enabled. These fields may disable the account sooner if the next threshold is reached before they are collected.' ) .optional(), - /** Fields that need to be collected to keep the account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled. */ + /**Fields that need to be collected to keep the account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled.*/ currently_due: z .array(z.string().max(5000)) - .nullable() .describe( 'Fields that need to be collected to keep the account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled.' ) .optional(), - /** If the account is disabled, this enum describes why. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification). */ + /**If the account is disabled, this enum describes why. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification).*/ disabled_reason: z .enum([ 'action_required.requested_capabilities', @@ -23072,39 +21976,34 @@ export namespace stripe { 'requirements.pending_verification', 'under_review' ]) - .nullable() .describe( 'If the account is disabled, this enum describes why. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification).' ) .optional(), - /** Fields that are `currently_due` and need to be collected again because validation or verification failed. */ + /**Fields that are `currently_due` and need to be collected again because validation or verification failed.*/ errors: z .array(AccountRequirementsErrorSchema) - .nullable() .describe( 'Fields that are `currently_due` and need to be collected again because validation or verification failed.' ) .optional(), - /** Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set. */ + /**Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set.*/ eventually_due: z .array(z.string().max(5000)) - .nullable() .describe( 'Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set.' ) .optional(), - /** Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the account. */ + /**Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the account.*/ past_due: z .array(z.string().max(5000)) - .nullable() .describe( "Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the account." ) .optional(), - /** Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending. */ + /**Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.*/ pending_verification: z .array(z.string().max(5000)) - .nullable() .describe( "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending." ) @@ -23113,36 +22012,32 @@ export namespace stripe { export type AccountRequirements = z.infer export const AccountBrandingSettingsSchema = z.object({ - /** (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) An icon for the account. Must be square and at least 128px x 128px. */ + /**(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) An icon for the account. Must be square and at least 128px x 128px.*/ icon: z .union([z.string().max(5000), FileSchema]) - .nullable() .describe( '(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) An icon for the account. Must be square and at least 128px x 128px.' ) .optional(), - /** (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for the account that will be used in Checkout instead of the icon and without the account's name next to it if provided. Must be at least 128px x 128px. */ + /**(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for the account that will be used in Checkout instead of the icon and without the account's name next to it if provided. Must be at least 128px x 128px.*/ logo: z .union([z.string().max(5000), FileSchema]) - .nullable() .describe( "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for the account that will be used in Checkout instead of the icon and without the account's name next to it if provided. Must be at least 128px x 128px." ) .optional(), - /** A CSS hex color value representing the primary branding color for this account */ + /**A CSS hex color value representing the primary branding color for this account*/ primary_color: z .string() .max(5000) - .nullable() .describe( 'A CSS hex color value representing the primary branding color for this account' ) .optional(), - /** A CSS hex color value representing the secondary branding color for this account */ + /**A CSS hex color value representing the secondary branding color for this account*/ secondary_color: z .string() .max(5000) - .nullable() .describe( 'A CSS hex color value representing the secondary branding color for this account' ) @@ -23161,30 +22056,28 @@ export namespace stripe { > export const AccountCapabilityFutureRequirementsSchema = z.object({ - /** Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ + /**Fields that are due and can be satisfied by providing the corresponding alternative fields instead.*/ alternatives: z .array(AccountRequirementsAlternativeSchema) - .nullable() .describe( 'Fields that are due and can be satisfied by providing the corresponding alternative fields instead.' ) .optional(), - /** Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on the capability's enablement state prior to transitioning. */ + /**Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on the capability's enablement state prior to transitioning.*/ current_deadline: z .number() .int() - .nullable() .describe( "Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on the capability's enablement state prior to transitioning." ) .optional(), - /** Fields that need to be collected to keep the capability enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash. */ + /**Fields that need to be collected to keep the capability enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash.*/ currently_due: z .array(z.string().max(5000)) .describe( 'Fields that need to be collected to keep the capability enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash.' ), - /** This is typed as an enum for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is null because fields in `future_requirements` will never disable the account. */ + /**This is typed as an enum for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is null because fields in `future_requirements` will never disable the account.*/ disabled_reason: z .enum([ 'other', @@ -23198,30 +22091,29 @@ export namespace stripe { 'rejected.unsupported_business', 'requirements.fields_needed' ]) - .nullable() .describe( 'This is typed as an enum for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is null because fields in `future_requirements` will never disable the account.' ) .optional(), - /** Fields that are `currently_due` and need to be collected again because validation or verification failed. */ + /**Fields that are `currently_due` and need to be collected again because validation or verification failed.*/ errors: z .array(AccountRequirementsErrorSchema) .describe( 'Fields that are `currently_due` and need to be collected again because validation or verification failed.' ), - /** Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well. */ + /**Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well.*/ eventually_due: z .array(z.string().max(5000)) .describe( 'Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well.' ), - /** Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`. */ + /**Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`.*/ past_due: z .array(z.string().max(5000)) .describe( "Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`." ), - /** Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending. */ + /**Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending.*/ pending_verification: z .array(z.string().max(5000)) .describe( @@ -23233,30 +22125,28 @@ export namespace stripe { > export const AccountCapabilityRequirementsSchema = z.object({ - /** Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ + /**Fields that are due and can be satisfied by providing the corresponding alternative fields instead.*/ alternatives: z .array(AccountRequirementsAlternativeSchema) - .nullable() .describe( 'Fields that are due and can be satisfied by providing the corresponding alternative fields instead.' ) .optional(), - /** Date by which the fields in `currently_due` must be collected to keep the capability enabled for the account. These fields may disable the capability sooner if the next threshold is reached before they are collected. */ + /**Date by which the fields in `currently_due` must be collected to keep the capability enabled for the account. These fields may disable the capability sooner if the next threshold is reached before they are collected.*/ current_deadline: z .number() .int() - .nullable() .describe( 'Date by which the fields in `currently_due` must be collected to keep the capability enabled for the account. These fields may disable the capability sooner if the next threshold is reached before they are collected.' ) .optional(), - /** Fields that need to be collected to keep the capability enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the capability is disabled. */ + /**Fields that need to be collected to keep the capability enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the capability is disabled.*/ currently_due: z .array(z.string().max(5000)) .describe( 'Fields that need to be collected to keep the capability enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the capability is disabled.' ), - /** Description of why the capability is disabled. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification). */ + /**Description of why the capability is disabled. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification).*/ disabled_reason: z .enum([ 'other', @@ -23270,30 +22160,29 @@ export namespace stripe { 'rejected.unsupported_business', 'requirements.fields_needed' ]) - .nullable() .describe( 'Description of why the capability is disabled. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification).' ) .optional(), - /** Fields that are `currently_due` and need to be collected again because validation or verification failed. */ + /**Fields that are `currently_due` and need to be collected again because validation or verification failed.*/ errors: z .array(AccountRequirementsErrorSchema) .describe( 'Fields that are `currently_due` and need to be collected again because validation or verification failed.' ), - /** Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set. */ + /**Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set.*/ eventually_due: z .array(z.string().max(5000)) .describe( 'Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set.' ), - /** Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the capability on the account. */ + /**Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the capability on the account.*/ past_due: z .array(z.string().max(5000)) .describe( "Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the capability on the account." ), - /** Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending. */ + /**Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.*/ pending_verification: z .array(z.string().max(5000)) .describe( @@ -23305,15 +22194,15 @@ export namespace stripe { > export const BalanceAmountNetSchema = z.object({ - /** Balance amount. */ + /**Balance amount.*/ amount: z.number().int().describe('Balance amount.'), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** Breakdown of balance by destination. */ + /**Breakdown of balance by destination.*/ net_available: z .array(BalanceNetAvailableSchema) .describe('Breakdown of balance by destination.') @@ -23323,7 +22212,7 @@ export namespace stripe { export type BalanceAmountNet = z.infer export const BalanceDetailSchema = z.object({ - /** Funds that are available for use. */ + /**Funds that are available for use.*/ available: z .array(BalanceAmountSchema) .describe('Funds that are available for use.') @@ -23337,18 +22226,16 @@ export namespace stripe { export type CreditBalance = z.infer export const PortalFlowsFlowAfterCompletionSchema = z.object({ - /** Configuration when `after_completion.type=hosted_confirmation`. */ + /**Configuration when `after_completion.type=hosted_confirmation`.*/ hosted_confirmation: - PortalFlowsAfterCompletionHostedConfirmationSchema.nullable() - .describe( - 'Configuration when `after_completion.type=hosted_confirmation`.' - ) - .optional(), - /** Configuration when `after_completion.type=redirect`. */ - redirect: PortalFlowsAfterCompletionRedirectSchema.nullable() - .describe('Configuration when `after_completion.type=redirect`.') - .optional(), - /** The specified type of behavior after the flow is completed. */ + PortalFlowsAfterCompletionHostedConfirmationSchema.describe( + 'Configuration when `after_completion.type=hosted_confirmation`.' + ).optional(), + /**Configuration when `after_completion.type=redirect`.*/ + redirect: PortalFlowsAfterCompletionRedirectSchema.describe( + 'Configuration when `after_completion.type=redirect`.' + ).optional(), + /**The specified type of behavior after the flow is completed.*/ type: z .enum(['hosted_confirmation', 'portal_homepage', 'redirect']) .describe('The specified type of behavior after the flow is completed.') @@ -23358,13 +22245,11 @@ export namespace stripe { > export const PortalFlowsFlowSubscriptionCancelSchema = z.object({ - /** Specify a retention strategy to be used in the cancellation flow. */ - retention: PortalFlowsRetentionSchema.nullable() - .describe( - 'Specify a retention strategy to be used in the cancellation flow.' - ) - .optional(), - /** The ID of the subscription to be canceled. */ + /**Specify a retention strategy to be used in the cancellation flow.*/ + retention: PortalFlowsRetentionSchema.describe( + 'Specify a retention strategy to be used in the cancellation flow.' + ).optional(), + /**The ID of the subscription to be canceled.*/ subscription: z .string() .max(5000) @@ -23375,21 +22260,20 @@ export namespace stripe { > export const PortalFlowsFlowSubscriptionUpdateConfirmSchema = z.object({ - /** The coupon or promotion code to apply to this subscription update. Currently, only up to one may be specified. */ + /**The coupon or promotion code to apply to this subscription update. Currently, only up to one may be specified.*/ discounts: z .array(PortalFlowsSubscriptionUpdateConfirmDiscountSchema) - .nullable() .describe( 'The coupon or promotion code to apply to this subscription update. Currently, only up to one may be specified.' ) .optional(), - /** The [subscription item](https://stripe.com/docs/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable. */ + /**The [subscription item](https://stripe.com/docs/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable.*/ items: z .array(PortalFlowsSubscriptionUpdateConfirmItemSchema) .describe( 'The [subscription item](https://stripe.com/docs/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable.' ), - /** The ID of the subscription to be updated. */ + /**The ID of the subscription to be updated.*/ subscription: z .string() .max(5000) @@ -23401,10 +22285,10 @@ export namespace stripe { export const PaymentPagesCheckoutSessionCollectedInformationSchema = z.object( { - /** Shipping information for this Checkout Session. */ - shipping_details: ShippingSchema.nullable() - .describe('Shipping information for this Checkout Session.') - .optional() + /**Shipping information for this Checkout Session.*/ + shipping_details: ShippingSchema.describe( + 'Shipping information for this Checkout Session.' + ).optional() } ) export type PaymentPagesCheckoutSessionCollectedInformation = z.infer< @@ -23412,12 +22296,10 @@ export namespace stripe { > export const PaymentPagesCheckoutSessionCustomerDetailsSchema = z.object({ - /** The customer's address after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022. */ - address: AddressSchema.nullable() - .describe( - "The customer's address after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022." - ) - .optional(), + /**The customer's address after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022.*/ + address: AddressSchema.describe( + "The customer's address after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022." + ).optional(), /** * The email associated with the Customer, if one exists, on the Checkout Session after a completed Checkout Session or at time of session expiry. * Otherwise, if the customer has consented to promotional content, this value is the most recent valid email provided by the customer on the Checkout form. @@ -23425,41 +22307,36 @@ export namespace stripe { email: z .string() .max(5000) - .nullable() .describe( 'The email associated with the Customer, if one exists, on the Checkout Session after a completed Checkout Session or at time of session expiry.\nOtherwise, if the customer has consented to promotional content, this value is the most recent valid email provided by the customer on the Checkout form.' ) .optional(), - /** The customer's name after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022. */ + /**The customer's name after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022.*/ name: z .string() .max(5000) - .nullable() .describe( "The customer's name after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022." ) .optional(), - /** The customer's phone number after a completed Checkout Session. */ + /**The customer's phone number after a completed Checkout Session.*/ phone: z .string() .max(5000) - .nullable() .describe( "The customer's phone number after a completed Checkout Session." ) .optional(), - /** The customer’s tax exempt status after a completed Checkout Session. */ + /**The customer’s tax exempt status after a completed Checkout Session.*/ tax_exempt: z .enum(['exempt', 'none', 'reverse']) - .nullable() .describe( 'The customer’s tax exempt status after a completed Checkout Session.' ) .optional(), - /** The customer’s tax IDs after a completed Checkout Session. */ + /**The customer’s tax IDs after a completed Checkout Session.*/ tax_ids: z .array(PaymentPagesCheckoutSessionTaxIdSchema) - .nullable() .describe('The customer’s tax IDs after a completed Checkout Session.') .optional() }) @@ -23471,7 +22348,7 @@ export namespace stripe { hosted_confirmation: PaymentLinksResourceCompletionBehaviorConfirmationPageSchema.optional(), redirect: PaymentLinksResourceCompletionBehaviorRedirectSchema.optional(), - /** The specified behavior after the purchase is complete. */ + /**The specified behavior after the purchase is complete.*/ type: z .enum(['hosted_confirmation', 'redirect']) .describe('The specified behavior after the purchase is complete.') @@ -23482,35 +22359,35 @@ export namespace stripe { export const CheckoutCardPaymentMethodOptionsSchema = z.object({ installments: CheckoutCardInstallmentsOptionsSchema.optional(), - /** Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession. */ + /**Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.*/ request_extended_authorization: z .enum(['if_available', 'never']) .describe( 'Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession.' ) .optional(), - /** Request ability to [increment the authorization](/payments/incremental-authorization) for this CheckoutSession. */ + /**Request ability to [increment the authorization](/payments/incremental-authorization) for this CheckoutSession.*/ request_incremental_authorization: z .enum(['if_available', 'never']) .describe( 'Request ability to [increment the authorization](/payments/incremental-authorization) for this CheckoutSession.' ) .optional(), - /** Request ability to make [multiple captures](/payments/multicapture) for this CheckoutSession. */ + /**Request ability to make [multiple captures](/payments/multicapture) for this CheckoutSession.*/ request_multicapture: z .enum(['if_available', 'never']) .describe( 'Request ability to make [multiple captures](/payments/multicapture) for this CheckoutSession.' ) .optional(), - /** Request ability to [overcapture](/payments/overcapture) for this CheckoutSession. */ + /**Request ability to [overcapture](/payments/overcapture) for this CheckoutSession.*/ request_overcapture: z .enum(['if_available', 'never']) .describe( 'Request ability to [overcapture](/payments/overcapture) for this CheckoutSession.' ) .optional(), - /** We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. */ + /**We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.*/ request_three_d_secure: z .enum(['any', 'automatic', 'challenge']) .describe( @@ -23533,7 +22410,7 @@ export namespace stripe { "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)." ) .optional(), - /** Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters. */ + /**Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.*/ statement_descriptor_suffix_kana: z .string() .max(5000) @@ -23541,7 +22418,7 @@ export namespace stripe { 'Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.' ) .optional(), - /** Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters. */ + /**Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.*/ statement_descriptor_suffix_kanji: z .string() .max(5000) @@ -23557,10 +22434,9 @@ export namespace stripe { export const CheckoutCustomerBalancePaymentMethodOptionsSchema = z.object({ bank_transfer: CheckoutCustomerBalanceBankTransferPaymentMethodOptionsSchema.optional(), - /** The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`. */ + /**The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.*/ funding_type: z .literal('bank_transfer') - .nullable() .describe( 'The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.' ) @@ -23602,7 +22478,7 @@ export namespace stripe { "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)." ) .optional(), - /** Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now. */ + /**Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.*/ target_date: z .string() .max(5000) @@ -23610,7 +22486,7 @@ export namespace stripe { "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now." ) .optional(), - /** Bank account verification method. */ + /**Bank account verification method.*/ verification_method: z .enum(['automatic', 'instant']) .describe('Bank account verification method.') @@ -23620,30 +22496,29 @@ export namespace stripe { typeof CheckoutUsBankAccountPaymentMethodOptionsSchema > - /** The delivery of a specified quantity of carbon for an order. */ + /**The delivery of a specified quantity of carbon for an order.*/ export const ClimateRemovalsOrderDeliveriesSchema = z .object({ - /** Time at which the delivery occurred. Measured in seconds since the Unix epoch. */ + /**Time at which the delivery occurred. Measured in seconds since the Unix epoch.*/ delivered_at: z .number() .int() .describe( 'Time at which the delivery occurred. Measured in seconds since the Unix epoch.' ), - /** Specific location of this delivery. */ - location: ClimateRemovalsLocationSchema.nullable() - .describe('Specific location of this delivery.') - .optional(), - /** Quantity of carbon removal supplied by this delivery. */ + /**Specific location of this delivery.*/ + location: ClimateRemovalsLocationSchema.describe( + 'Specific location of this delivery.' + ).optional(), + /**Quantity of carbon removal supplied by this delivery.*/ metric_tons: z .string() .max(5000) .describe('Quantity of carbon removal supplied by this delivery.'), - /** Once retired, a URL to the registry entry for the tons from this delivery. */ + /**Once retired, a URL to the registry entry for the tons from this delivery.*/ registry_url: z .string() .max(5000) - .nullable() .describe( 'Once retired, a URL to the registry entry for the tons from this delivery.' ) @@ -23655,7 +22530,7 @@ export namespace stripe { typeof ClimateRemovalsOrderDeliveriesSchema > - /** Data used for generating a Mandate. */ + /**Data used for generating a Mandate.*/ export const ConfirmationTokensResourceMandateDataSchema = z .object({ customer_acceptance: @@ -23676,45 +22551,45 @@ export namespace stripe { */ export const CountrySpecSchema = z .object({ - /** The default currency for this country. This applies to both payment methods and bank accounts. */ + /**The default currency for this country. This applies to both payment methods and bank accounts.*/ default_currency: z .string() .max(5000) .describe( 'The default currency for this country. This applies to both payment methods and bank accounts.' ), - /** Unique identifier for the object. Represented as the ISO country code for this country. */ + /**Unique identifier for the object. Represented as the ISO country code for this country.*/ id: z .string() .max(5000) .describe( 'Unique identifier for the object. Represented as the ISO country code for this country.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('country_spec') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** Currencies that can be accepted in the specific country (for transfers). */ + /**Currencies that can be accepted in the specific country (for transfers).*/ supported_bank_account_currencies: z .record(z.array(z.string().max(5000))) .describe( 'Currencies that can be accepted in the specific country (for transfers).' ), - /** Currencies that can be accepted in the specified country (for payments). */ + /**Currencies that can be accepted in the specified country (for payments).*/ supported_payment_currencies: z .array(z.string().max(5000)) .describe( 'Currencies that can be accepted in the specified country (for payments).' ), - /** Payment methods available in the specified country. You may need to enable some payment methods (e.g., [ACH](https://stripe.com/docs/ach)) on your account before they appear in this list. The `stripe` payment method refers to [charging through your platform](https://stripe.com/docs/connect/destination-charges). */ + /**Payment methods available in the specified country. You may need to enable some payment methods (e.g., [ACH](https://stripe.com/docs/ach)) on your account before they appear in this list. The `stripe` payment method refers to [charging through your platform](https://stripe.com/docs/connect/destination-charges).*/ supported_payment_methods: z .array(z.string().max(5000)) .describe( 'Payment methods available in the specified country. You may need to enable some payment methods (e.g., [ACH](https://stripe.com/docs/ach)) on your account before they appear in this list. The `stripe` payment method refers to [charging through your platform](https://stripe.com/docs/connect/destination-charges).' ), - /** Countries that can accept transfers from the specified country. */ + /**Countries that can accept transfers from the specified country.*/ supported_transfer_countries: z .array(z.string().max(5000)) .describe( @@ -23728,20 +22603,20 @@ export namespace stripe { export type CountrySpec = z.infer export const CreditNoteTaxAmountSchema = z.object({ - /** The amount, in cents (or local equivalent), of the tax. */ + /**The amount, in cents (or local equivalent), of the tax.*/ amount: z .number() .int() .describe('The amount, in cents (or local equivalent), of the tax.'), - /** Whether this tax amount is inclusive or exclusive. */ + /**Whether this tax amount is inclusive or exclusive.*/ inclusive: z .boolean() .describe('Whether this tax amount is inclusive or exclusive.'), - /** The tax rate that was applied to get this tax amount. */ + /**The tax rate that was applied to get this tax amount.*/ tax_rate: z .union([z.string().max(5000), TaxRateSchema]) .describe('The tax rate that was applied to get this tax amount.'), - /** The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. */ + /**The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.*/ taxability_reason: z .enum([ 'customer_exempt', @@ -23760,16 +22635,14 @@ export namespace stripe { 'taxable_basis_reduced', 'zero_rated' ]) - .nullable() .describe( 'The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.' ) .optional(), - /** The amount on which tax is calculated, in cents (or local equivalent). */ + /**The amount on which tax is calculated, in cents (or local equivalent).*/ taxable_amount: z .number() .int() - .nullable() .describe( 'The amount on which tax is calculated, in cents (or local equivalent).' ) @@ -23817,22 +22690,21 @@ export namespace stripe { */ export const EventSchema = z .object({ - /** The connected account that originates the event. */ + /**The connected account that originates the event.*/ account: z .string() .max(5000) .describe('The connected account that originates the event.') .optional(), - /** The Stripe API version used to render `data`. This property is populated only for events on or after October 31, 2014. */ + /**The Stripe API version used to render `data`. This property is populated only for events on or after October 31, 2014.*/ api_version: z .string() .max(5000) - .nullable() .describe( 'The Stripe API version used to render `data`. This property is populated only for events on or after October 31, 2014.' ) .optional(), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() @@ -23840,32 +22712,32 @@ export namespace stripe { 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), data: NotificationEventDataSchema, - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('event') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** Number of webhooks that haven't been successfully delivered (for example, to return a 20x response) to the URLs you specify. */ + /**Number of webhooks that haven't been successfully delivered (for example, to return a 20x response) to the URLs you specify.*/ pending_webhooks: z .number() .int() .describe( "Number of webhooks that haven't been successfully delivered (for example, to return a 20x response) to the URLs you specify." ), - /** Information on the API request that triggers the event. */ - request: NotificationEventRequestSchema.nullable() - .describe('Information on the API request that triggers the event.') - .optional(), - /** Description of the event (for example, `invoice.created` or `charge.refunded`). */ + /**Information on the API request that triggers the event.*/ + request: NotificationEventRequestSchema.describe( + 'Information on the API request that triggers the event.' + ).optional(), + /**Description of the event (for example, `invoice.created` or `charge.refunded`).*/ type: z .string() .max(5000) @@ -23879,7 +22751,7 @@ export namespace stripe { export type Event = z.infer export const BankConnectionsResourceBalanceSchema = z.object({ - /** The time that the external institution calculated this balance. Measured in seconds since the Unix epoch. */ + /**The time that the external institution calculated this balance. Measured in seconds since the Unix epoch.*/ as_of: z .number() .int() @@ -23901,7 +22773,7 @@ export namespace stripe { .describe( 'The balances owed to (or by) the account holder, before subtracting any outbound pending transactions or adding any inbound pending transactions.\n\nEach key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.\n\nEach value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.' ), - /** The `type` of the balance. An additional hash is included on the balance with a name matching this value. */ + /**The `type` of the balance. An additional hash is included on the balance with a name matching this value.*/ type: z .enum(['cash', 'credit']) .describe( @@ -23912,49 +22784,35 @@ export namespace stripe { typeof BankConnectionsResourceBalanceSchema > - /** Result from an id_number check */ + /**Result from an id_number check*/ export const GelatoIdNumberReportSchema = z .object({ - /** Date of birth. */ - dob: GelatoDataIdNumberReportDateSchema.nullable() - .describe('Date of birth.') - .optional(), - /** Details on the verification error. Present when status is `unverified`. */ - error: GelatoIdNumberReportErrorSchema.nullable() - .describe( - 'Details on the verification error. Present when status is `unverified`.' - ) - .optional(), - /** First name. */ - first_name: z - .string() - .max(5000) - .nullable() - .describe('First name.') - .optional(), - /** ID number. When `id_number_type` is `us_ssn`, only the last 4 digits are present. */ + /**Date of birth.*/ + dob: GelatoDataIdNumberReportDateSchema.describe( + 'Date of birth.' + ).optional(), + /**Details on the verification error. Present when status is `unverified`.*/ + error: GelatoIdNumberReportErrorSchema.describe( + 'Details on the verification error. Present when status is `unverified`.' + ).optional(), + /**First name.*/ + first_name: z.string().max(5000).describe('First name.').optional(), + /**ID number. When `id_number_type` is `us_ssn`, only the last 4 digits are present.*/ id_number: z .string() .max(5000) - .nullable() .describe( 'ID number. When `id_number_type` is `us_ssn`, only the last 4 digits are present.' ) .optional(), - /** Type of ID number. */ + /**Type of ID number.*/ id_number_type: z .enum(['br_cpf', 'sg_nric', 'us_ssn']) - .nullable() .describe('Type of ID number.') .optional(), - /** Last name. */ - last_name: z - .string() - .max(5000) - .nullable() - .describe('Last name.') - .optional(), - /** Status of this `id_number` check. */ + /**Last name.*/ + last_name: z.string().max(5000).describe('Last name.').optional(), + /**Status of this `id_number` check.*/ status: z .enum(['unverified', 'verified']) .describe('Status of this `id_number` check.') @@ -23971,53 +22829,45 @@ export namespace stripe { > export const GelatoVerifiedOutputsSchema = z.object({ - /** The user's verified address. */ - address: AddressSchema.nullable() - .describe("The user's verified address.") - .optional(), - /** The user’s verified date of birth. */ - dob: GelatoDataVerifiedOutputsDateSchema.nullable() - .describe('The user’s verified date of birth.') - .optional(), - /** The user's verified email address */ + /**The user's verified address.*/ + address: AddressSchema.describe("The user's verified address.").optional(), + /**The user’s verified date of birth.*/ + dob: GelatoDataVerifiedOutputsDateSchema.describe( + 'The user’s verified date of birth.' + ).optional(), + /**The user's verified email address*/ email: z .string() .max(5000) - .nullable() .describe("The user's verified email address") .optional(), - /** The user's verified first name. */ + /**The user's verified first name.*/ first_name: z .string() .max(5000) - .nullable() .describe("The user's verified first name.") .optional(), - /** The user's verified id number. */ + /**The user's verified id number.*/ id_number: z .string() .max(5000) - .nullable() .describe("The user's verified id number.") .optional(), - /** The user's verified id number type. */ + /**The user's verified id number type.*/ id_number_type: z .enum(['br_cpf', 'sg_nric', 'us_ssn']) - .nullable() .describe("The user's verified id number type.") .optional(), - /** The user's verified last name. */ + /**The user's verified last name.*/ last_name: z .string() .max(5000) - .nullable() .describe("The user's verified last name.") .optional(), - /** The user's verified phone number */ + /**The user's verified phone number*/ phone: z .string() .max(5000) - .nullable() .describe("The user's verified phone number") .optional() }) @@ -24045,7 +22895,7 @@ export namespace stripe { .object({ acss_debit: PaymentMethodConfigResourcePaymentMethodPropertiesSchema.optional(), - /** Whether the configuration can be used for new payments. */ + /**Whether the configuration can be used for new payments.*/ active: z .boolean() .describe('Whether the configuration can be used for new payments.'), @@ -24060,11 +22910,10 @@ export namespace stripe { PaymentMethodConfigResourcePaymentMethodPropertiesSchema.optional(), apple_pay: PaymentMethodConfigResourcePaymentMethodPropertiesSchema.optional(), - /** For child configs, the Connect application associated with the configuration. */ + /**For child configs, the Connect application associated with the configuration.*/ application: z .string() .max(5000) - .nullable() .describe( 'For child configs, the Connect application associated with the configuration.' ) @@ -24093,11 +22942,11 @@ export namespace stripe { PaymentMethodConfigResourcePaymentMethodPropertiesSchema.optional(), grabpay: PaymentMethodConfigResourcePaymentMethodPropertiesSchema.optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), ideal: PaymentMethodConfigResourcePaymentMethodPropertiesSchema.optional(), - /** The default configuration is used whenever a payment method configuration is not specified. */ + /**The default configuration is used whenever a payment method configuration is not specified.*/ is_default: z .boolean() .describe( @@ -24109,7 +22958,7 @@ export namespace stripe { konbini: PaymentMethodConfigResourcePaymentMethodPropertiesSchema.optional(), link: PaymentMethodConfigResourcePaymentMethodPropertiesSchema.optional(), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( @@ -24119,9 +22968,9 @@ export namespace stripe { PaymentMethodConfigResourcePaymentMethodPropertiesSchema.optional(), multibanco: PaymentMethodConfigResourcePaymentMethodPropertiesSchema.optional(), - /** The configuration's name. */ + /**The configuration's name.*/ name: z.string().max(5000).describe("The configuration's name."), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('payment_method_configuration') .describe( @@ -24129,11 +22978,10 @@ export namespace stripe { ), oxxo: PaymentMethodConfigResourcePaymentMethodPropertiesSchema.optional(), p24: PaymentMethodConfigResourcePaymentMethodPropertiesSchema.optional(), - /** For child configs, the configuration's parent configuration. */ + /**For child configs, the configuration's parent configuration.*/ parent: z .string() .max(5000) - .nullable() .describe( "For child configs, the configuration's parent configuration." ) @@ -24179,37 +23027,37 @@ export namespace stripe { .object({ amazon_pay: PaymentMethodDomainResourcePaymentMethodStatusSchema, apple_pay: PaymentMethodDomainResourcePaymentMethodStatusSchema, - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** The domain name that this payment method domain object represents. */ + /**The domain name that this payment method domain object represents.*/ domain_name: z .string() .max(5000) .describe( 'The domain name that this payment method domain object represents.' ), - /** Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements. */ + /**Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements.*/ enabled: z .boolean() .describe( 'Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements.' ), google_pay: PaymentMethodDomainResourcePaymentMethodStatusSchema, - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), link: PaymentMethodDomainResourcePaymentMethodStatusSchema, - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('payment_method_domain') .describe( @@ -24223,30 +23071,26 @@ export namespace stripe { export type PaymentMethodDomain = z.infer export const TaxProductResourceCustomerDetailsSchema = z.object({ - /** The customer's postal address (for example, home or business location). */ - address: TaxProductResourcePostalAddressSchema.nullable() - .describe( - "The customer's postal address (for example, home or business location)." - ) - .optional(), - /** The type of customer address provided. */ + /**The customer's postal address (for example, home or business location).*/ + address: TaxProductResourcePostalAddressSchema.describe( + "The customer's postal address (for example, home or business location)." + ).optional(), + /**The type of customer address provided.*/ address_source: z .enum(['billing', 'shipping']) - .nullable() .describe('The type of customer address provided.') .optional(), - /** The customer's IP address (IPv4 or IPv6). */ + /**The customer's IP address (IPv4 or IPv6).*/ ip_address: z .string() .max(5000) - .nullable() .describe("The customer's IP address (IPv4 or IPv6).") .optional(), - /** The customer's tax IDs (for example, EU VAT numbers). */ + /**The customer's tax IDs (for example, EU VAT numbers).*/ tax_ids: z .array(TaxProductResourceCustomerDetailsResourceTaxIdSchema) .describe("The customer's tax IDs (for example, EU VAT numbers)."), - /** The taxability override used for taxation. */ + /**The taxability override used for taxation.*/ taxability_override: z .enum(['customer_exempt', 'none', 'reverse_charge']) .describe('The taxability override used for taxation.') @@ -24256,7 +23100,7 @@ export namespace stripe { > export const TaxProductResourceLineItemTaxBreakdownSchema = z.object({ - /** The amount of tax, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /**The amount of tax, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).*/ amount: z .number() .int() @@ -24264,19 +23108,17 @@ export namespace stripe { 'The amount of tax, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).' ), jurisdiction: TaxProductResourceJurisdictionSchema, - /** Indicates whether the jurisdiction was determined by the origin (merchant's address) or destination (customer's address). */ + /**Indicates whether the jurisdiction was determined by the origin (merchant's address) or destination (customer's address).*/ sourcing: z .enum(['destination', 'origin']) .describe( "Indicates whether the jurisdiction was determined by the origin (merchant's address) or destination (customer's address)." ), - /** Details regarding the rate for this tax. This field will be `null` when the tax is not imposed, for example if the product is exempt from tax. */ - tax_rate_details: TaxProductResourceLineItemTaxRateDetailsSchema.nullable() - .describe( - 'Details regarding the rate for this tax. This field will be `null` when the tax is not imposed, for example if the product is exempt from tax.' - ) - .optional(), - /** The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. */ + /**Details regarding the rate for this tax. This field will be `null` when the tax is not imposed, for example if the product is exempt from tax.*/ + tax_rate_details: TaxProductResourceLineItemTaxRateDetailsSchema.describe( + 'Details regarding the rate for this tax. This field will be `null` when the tax is not imposed, for example if the product is exempt from tax.' + ).optional(), + /**The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.*/ taxability_reason: z .enum([ 'customer_exempt', @@ -24298,7 +23140,7 @@ export namespace stripe { .describe( 'The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.' ), - /** The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /**The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).*/ taxable_amount: z .number() .int() @@ -24311,21 +23153,21 @@ export namespace stripe { > export const TaxProductResourceTaxBreakdownSchema = z.object({ - /** The amount of tax, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /**The amount of tax, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).*/ amount: z .number() .int() .describe( 'The amount of tax, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).' ), - /** Specifies whether the tax amount is included in the line item amount. */ + /**Specifies whether the tax amount is included in the line item amount.*/ inclusive: z .boolean() .describe( 'Specifies whether the tax amount is included in the line item amount.' ), tax_rate_details: TaxProductResourceTaxRateDetailsSchema, - /** The reasoning behind this tax, for example, if the product is tax exempt. We might extend the possible values for this field to support new tax rules. */ + /**The reasoning behind this tax, for example, if the product is tax exempt. We might extend the possible values for this field to support new tax rules.*/ taxability_reason: z .enum([ 'customer_exempt', @@ -24347,7 +23189,7 @@ export namespace stripe { .describe( 'The reasoning behind this tax, for example, if the product is tax exempt. We might extend the possible values for this field to support new tax rules.' ), - /** The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /**The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).*/ taxable_amount: z .number() .int() @@ -24371,7 +23213,7 @@ export namespace stripe { export const TerminalConfigurationConfigurationResourceDeviceTypeSpecificConfigSchema = z.object({ - /** A File ID representing an image you would like displayed on the reader. */ + /**A File ID representing an image you would like displayed on the reader.*/ splashscreen: z .union([z.string().max(5000), FileSchema]) .describe( @@ -24384,14 +23226,14 @@ export namespace stripe { typeof TerminalConfigurationConfigurationResourceDeviceTypeSpecificConfigSchema > - /** Represents a reader action to set the reader display */ + /**Represents a reader action to set the reader display*/ export const TerminalReaderReaderResourceSetReaderDisplayActionSchema = z .object({ - /** Cart object to be displayed by the reader. */ - cart: TerminalReaderReaderResourceCartSchema.nullable() - .describe('Cart object to be displayed by the reader.') - .optional(), - /** Type of information to be displayed by the reader. */ + /**Cart object to be displayed by the reader.*/ + cart: TerminalReaderReaderResourceCartSchema.describe( + 'Cart object to be displayed by the reader.' + ).optional(), + /**Type of information to be displayed by the reader.*/ type: z .literal('cart') .describe('Type of information to be displayed by the reader.') @@ -24404,7 +23246,7 @@ export namespace stripe { export const TreasuryOutboundPaymentsResourceOutboundPaymentResourceTrackingDetailsSchema = z.object({ ach: TreasuryOutboundPaymentsResourceAchTrackingDetailsSchema.optional(), - /** The US bank account network used to send funds. */ + /**The US bank account network used to send funds.*/ type: z .enum(['ach', 'us_domestic_wire']) .describe('The US bank account network used to send funds.'), @@ -24419,7 +23261,7 @@ export namespace stripe { export const TreasuryOutboundTransfersResourceOutboundTransferResourceTrackingDetailsSchema = z.object({ ach: TreasuryOutboundTransfersResourceAchTrackingDetailsSchema.optional(), - /** The US bank account network used to send funds. */ + /**The US bank account network used to send funds.*/ type: z .enum(['ach', 'us_domestic_wire']) .describe('The US bank account network used to send funds.'), @@ -24431,7 +23273,7 @@ export namespace stripe { typeof TreasuryOutboundTransfersResourceOutboundTransferResourceTrackingDetailsSchema > - /** Settings related to Financial Addresses features on a Financial Account */ + /**Settings related to Financial Addresses features on a Financial Account*/ export const TreasuryFinancialAccountsResourceFinancialAddressesFeaturesSchema = z .object({ @@ -24445,7 +23287,7 @@ export namespace stripe { typeof TreasuryFinancialAccountsResourceFinancialAddressesFeaturesSchema > - /** InboundTransfers contains inbound transfers features for a FinancialAccount. */ + /**InboundTransfers contains inbound transfers features for a FinancialAccount.*/ export const TreasuryFinancialAccountsResourceInboundTransfersSchema = z .object({ ach: TreasuryFinancialAccountsResourceInboundAchToggleSettingsSchema.optional() @@ -24458,83 +23300,71 @@ export namespace stripe { > export const AccountBusinessProfileSchema = z.object({ - /** The applicant's gross annual revenue for its preceding fiscal year. */ - annual_revenue: AccountAnnualRevenueSchema.nullable() - .describe( - "The applicant's gross annual revenue for its preceding fiscal year." - ) - .optional(), - /** An estimated upper bound of employees, contractors, vendors, etc. currently working for the business. */ + /**The applicant's gross annual revenue for its preceding fiscal year.*/ + annual_revenue: AccountAnnualRevenueSchema.describe( + "The applicant's gross annual revenue for its preceding fiscal year." + ).optional(), + /**An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.*/ estimated_worker_count: z .number() .int() - .nullable() .describe( 'An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.' ) .optional(), - /** [The merchant category code for the account](/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide. */ + /**[The merchant category code for the account](/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.*/ mcc: z .string() .max(5000) - .nullable() .describe( '[The merchant category code for the account](/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.' ) .optional(), monthly_estimated_revenue: AccountMonthlyEstimatedRevenueSchema.optional(), - /** The customer-facing business name. */ + /**The customer-facing business name.*/ name: z .string() .max(5000) - .nullable() .describe('The customer-facing business name.') .optional(), - /** Internal-only description of the product sold or service provided by the business. It's used by Stripe for risk and underwriting purposes. */ + /**Internal-only description of the product sold or service provided by the business. It's used by Stripe for risk and underwriting purposes.*/ product_description: z .string() .max(40_000) - .nullable() .describe( "Internal-only description of the product sold or service provided by the business. It's used by Stripe for risk and underwriting purposes." ) .optional(), - /** A publicly available mailing address for sending support issues to. */ - support_address: AddressSchema.nullable() - .describe( - 'A publicly available mailing address for sending support issues to.' - ) - .optional(), - /** A publicly available email address for sending support issues to. */ + /**A publicly available mailing address for sending support issues to.*/ + support_address: AddressSchema.describe( + 'A publicly available mailing address for sending support issues to.' + ).optional(), + /**A publicly available email address for sending support issues to.*/ support_email: z .string() .max(5000) - .nullable() .describe( 'A publicly available email address for sending support issues to.' ) .optional(), - /** A publicly available phone number to call with support issues. */ + /**A publicly available phone number to call with support issues.*/ support_phone: z .string() .max(5000) - .nullable() .describe( 'A publicly available phone number to call with support issues.' ) .optional(), - /** A publicly available website for handling support issues. */ + /**A publicly available website for handling support issues.*/ support_url: z .string() .max(5000) - .nullable() .describe('A publicly available website for handling support issues.') .optional(), - /** The business's publicly available website. */ + /**The business's publicly available website.*/ url: z .string() .max(5000) - .nullable() .describe("The business's publicly available website.") .optional() }) @@ -24551,7 +23381,7 @@ export namespace stripe { export const AccountUnificationAccountControllerSchema = z.object({ fees: AccountUnificationAccountControllerFeesSchema.optional(), - /** `true` if the Connect application retrieving the resource controls the account and can therefore exercise [platform controls](https://stripe.com/docs/connect/platform-controls-for-standard-accounts). Otherwise, this field is null. */ + /**`true` if the Connect application retrieving the resource controls the account and can therefore exercise [platform controls](https://stripe.com/docs/connect/platform-controls-for-standard-accounts). Otherwise, this field is null.*/ is_controller: z .boolean() .describe( @@ -24559,7 +23389,7 @@ export namespace stripe { ) .optional(), losses: AccountUnificationAccountControllerLossesSchema.optional(), - /** A value indicating responsibility for collecting requirements on this account. Only returned when the Connect application retrieving the resource controls the account. */ + /**A value indicating responsibility for collecting requirements on this account. Only returned when the Connect application retrieving the resource controls the account.*/ requirement_collection: z .enum(['application', 'stripe']) .describe( @@ -24568,7 +23398,7 @@ export namespace stripe { .optional(), stripe_dashboard: AccountUnificationAccountControllerStripeDashboardSchema.optional(), - /** The controller type. Can be `application`, if a Connect application controls the account, or `account`, if the account controls itself. */ + /**The controller type. Can be `application`, if a Connect application controls the account, or `account`, if the account controls itself.*/ type: z .enum(['account', 'application']) .describe( @@ -24580,29 +23410,28 @@ export namespace stripe { > export const SourceOrderSchema = z.object({ - /** A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order. */ + /**A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order.*/ amount: z .number() .int() .describe( 'A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** The email address of the customer placing the order. */ + /**The email address of the customer placing the order.*/ email: z .string() .max(5000) .describe('The email address of the customer placing the order.') .optional(), - /** List of items constituting the order. */ + /**List of items constituting the order.*/ items: z .array(SourceOrderItemSchema) - .nullable() .describe('List of items constituting the order.') .optional(), shipping: ShippingSchema.optional() @@ -24610,32 +23439,29 @@ export namespace stripe { export type SourceOrder = z.infer export const PaymentMethodDetailsCardPresentSchema = z.object({ - /** The authorized amount */ + /**The authorized amount*/ amount_authorized: z .number() .int() - .nullable() .describe('The authorized amount') .optional(), - /** Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /**Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.*/ brand: z .string() .max(5000) - .nullable() .describe( 'Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.' ) .optional(), - /** The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. */ + /**The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card.*/ brand_product: z .string() .max(5000) - .nullable() .describe( 'The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card.' ) .optional(), - /** When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured. */ + /**When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured.*/ capture_before: z .number() .int() @@ -24643,46 +23469,42 @@ export namespace stripe { 'When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured.' ) .optional(), - /** The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay. */ + /**The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.*/ cardholder_name: z .string() .max(5000) - .nullable() .describe( 'The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.' ) .optional(), - /** Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. */ + /**Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.*/ country: z .string() .max(5000) - .nullable() .describe( "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected." ) .optional(), - /** A high-level description of the type of cards issued in this range. */ + /**A high-level description of the type of cards issued in this range.*/ description: z .string() .max(5000) - .nullable() .describe( 'A high-level description of the type of cards issued in this range.' ) .optional(), - /** Authorization response cryptogram. */ + /**Authorization response cryptogram.*/ emv_auth_data: z .string() .max(5000) - .nullable() .describe('Authorization response cryptogram.') .optional(), - /** Two-digit number representing the card's expiration month. */ + /**Two-digit number representing the card's expiration month.*/ exp_month: z .number() .int() .describe("Two-digit number representing the card's expiration month."), - /** Four-digit number representing the card's expiration year. */ + /**Four-digit number representing the card's expiration year.*/ exp_year: z .number() .int() @@ -24695,86 +23517,78 @@ export namespace stripe { fingerprint: z .string() .max(5000) - .nullable() .describe( 'Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*' ) .optional(), - /** Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ + /**Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.*/ funding: z .string() .max(5000) - .nullable() .describe( 'Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.' ) .optional(), - /** ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod. */ + /**ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.*/ generated_card: z .string() .max(5000) - .nullable() .describe( 'ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.' ) .optional(), - /** Whether this [PaymentIntent](https://stripe.com/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support). */ + /**Whether this [PaymentIntent](https://stripe.com/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support).*/ incremental_authorization_supported: z .boolean() .describe( 'Whether this [PaymentIntent](https://stripe.com/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support).' ), - /** The name of the card's issuing bank. */ + /**The name of the card's issuing bank.*/ issuer: z .string() .max(5000) - .nullable() .describe("The name of the card's issuing bank.") .optional(), - /** The last four digits of the card. */ + /**The last four digits of the card.*/ last4: z .string() .max(5000) - .nullable() .describe('The last four digits of the card.') .optional(), - /** Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /**Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.*/ network: z .string() .max(5000) - .nullable() .describe( 'Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.' ) .optional(), - /** This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise. */ + /**This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.*/ network_transaction_id: z .string() .max(5000) - .nullable() .describe( 'This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.' ) .optional(), - /** Details about payments collected offline. */ - offline: PaymentMethodDetailsCardPresentOfflineSchema.nullable() - .describe('Details about payments collected offline.') - .optional(), - /** Defines whether the authorized amount can be over-captured or not */ + /**Details about payments collected offline.*/ + offline: PaymentMethodDetailsCardPresentOfflineSchema.describe( + 'Details about payments collected offline.' + ).optional(), + /**Defines whether the authorized amount can be over-captured or not*/ overcapture_supported: z .boolean() .describe( 'Defines whether the authorized amount can be over-captured or not' ), - /** EMV tag 5F2D. Preferred languages specified by the integrated circuit chip. */ + /**EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.*/ preferred_locales: z .array(z.string().max(5000)) - .nullable() .describe( 'EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.' ) .optional(), - /** How card details were read in this transaction. */ + /**How card details were read in this transaction.*/ read_method: z .enum([ 'contact_emv', @@ -24783,15 +23597,12 @@ export namespace stripe { 'magnetic_stripe_fallback', 'magnetic_stripe_track2' ]) - .nullable() .describe('How card details were read in this transaction.') .optional(), - /** A collection of fields required to be displayed on receipts. Only required for EMV transactions. */ - receipt: PaymentMethodDetailsCardPresentReceiptSchema.nullable() - .describe( - 'A collection of fields required to be displayed on receipts. Only required for EMV transactions.' - ) - .optional(), + /**A collection of fields required to be displayed on receipts. Only required for EMV transactions.*/ + receipt: PaymentMethodDetailsCardPresentReceiptSchema.describe( + 'A collection of fields required to be displayed on receipts. Only required for EMV transactions.' + ).optional(), wallet: PaymentFlowsPrivatePaymentMethodsCardPresentCommonWalletSchema.optional() }) @@ -24800,14 +23611,12 @@ export namespace stripe { > export const DisputeEnhancedEvidenceVisaCompellingEvidence3Schema = z.object({ - /** Disputed transaction details for Visa Compelling Evidence 3.0 evidence submission. */ + /**Disputed transaction details for Visa Compelling Evidence 3.0 evidence submission.*/ disputed_transaction: - DisputeVisaCompellingEvidence3DisputedTransactionSchema.nullable() - .describe( - 'Disputed transaction details for Visa Compelling Evidence 3.0 evidence submission.' - ) - .optional(), - /** List of exactly two prior undisputed transaction objects for Visa Compelling Evidence 3.0 evidence submission. */ + DisputeVisaCompellingEvidence3DisputedTransactionSchema.describe( + 'Disputed transaction details for Visa Compelling Evidence 3.0 evidence submission.' + ).optional(), + /**List of exactly two prior undisputed transaction objects for Visa Compelling Evidence 3.0 evidence submission.*/ prior_undisputed_transactions: z .array(DisputeVisaCompellingEvidence3PriorUndisputedTransactionSchema) .describe( @@ -24819,27 +23628,26 @@ export namespace stripe { > export const DisputeEvidenceDetailsSchema = z.object({ - /** Date by which evidence must be submitted in order to successfully challenge dispute. Will be 0 if the customer's bank or credit card company doesn't allow a response for this particular dispute. */ + /**Date by which evidence must be submitted in order to successfully challenge dispute. Will be 0 if the customer's bank or credit card company doesn't allow a response for this particular dispute.*/ due_by: z .number() .int() - .nullable() .describe( "Date by which evidence must be submitted in order to successfully challenge dispute. Will be 0 if the customer's bank or credit card company doesn't allow a response for this particular dispute." ) .optional(), enhanced_eligibility: DisputeEnhancedEligibilitySchema, - /** Whether evidence has been staged for this dispute. */ + /**Whether evidence has been staged for this dispute.*/ has_evidence: z .boolean() .describe('Whether evidence has been staged for this dispute.'), - /** Whether the last evidence submission was submitted past the due date. Defaults to `false` if no evidence submissions have occurred. If `true`, then delivery of the latest evidence is *not* guaranteed. */ + /**Whether the last evidence submission was submitted past the due date. Defaults to `false` if no evidence submissions have occurred. If `true`, then delivery of the latest evidence is *not* guaranteed.*/ past_due: z .boolean() .describe( 'Whether the last evidence submission was submitted past the due date. Defaults to `false` if no evidence submissions have occurred. If `true`, then delivery of the latest evidence is *not* guaranteed.' ), - /** The number of times evidence has been submitted. Typically, you may only submit evidence once. */ + /**The number of times evidence has been submitted. Typically, you may only submit evidence once.*/ submission_count: z .number() .int() @@ -24852,10 +23660,10 @@ export namespace stripe { > export const IssuingCardholderVerificationSchema = z.object({ - /** An identifying document, either a passport or local ID card. */ - document: IssuingCardholderIdDocumentSchema.nullable() - .describe('An identifying document, either a passport or local ID card.') - .optional() + /**An identifying document, either a passport or local ID card.*/ + document: IssuingCardholderIdDocumentSchema.describe( + 'An identifying document, either a passport or local ID card.' + ).optional() }) export type IssuingCardholderVerification = z.infer< typeof IssuingCardholderVerificationSchema @@ -24863,55 +23671,49 @@ export namespace stripe { export const IssuingCardShippingSchema = z.object({ address: AddressSchema, - /** Address validation details for the shipment. */ - address_validation: IssuingCardShippingAddressValidationSchema.nullable() - .describe('Address validation details for the shipment.') - .optional(), - /** The delivery company that shipped a card. */ + /**Address validation details for the shipment.*/ + address_validation: IssuingCardShippingAddressValidationSchema.describe( + 'Address validation details for the shipment.' + ).optional(), + /**The delivery company that shipped a card.*/ carrier: z .enum(['dhl', 'fedex', 'royal_mail', 'usps']) - .nullable() .describe('The delivery company that shipped a card.') .optional(), - /** Additional information that may be required for clearing customs. */ - customs: IssuingCardShippingCustomsSchema.nullable() - .describe( - 'Additional information that may be required for clearing customs.' - ) - .optional(), - /** A unix timestamp representing a best estimate of when the card will be delivered. */ + /**Additional information that may be required for clearing customs.*/ + customs: IssuingCardShippingCustomsSchema.describe( + 'Additional information that may be required for clearing customs.' + ).optional(), + /**A unix timestamp representing a best estimate of when the card will be delivered.*/ eta: z .number() .int() - .nullable() .describe( 'A unix timestamp representing a best estimate of when the card will be delivered.' ) .optional(), - /** Recipient name. */ + /**Recipient name.*/ name: z.string().max(5000).describe('Recipient name.'), - /** The phone number of the receiver of the shipment. Our courier partners will use this number to contact you in the event of card delivery issues. For individual shipments to the EU/UK, if this field is empty, we will provide them with the phone number provided when the cardholder was initially created. */ + /**The phone number of the receiver of the shipment. Our courier partners will use this number to contact you in the event of card delivery issues. For individual shipments to the EU/UK, if this field is empty, we will provide them with the phone number provided when the cardholder was initially created.*/ phone_number: z .string() .max(5000) - .nullable() .describe( 'The phone number of the receiver of the shipment. Our courier partners will use this number to contact you in the event of card delivery issues. For individual shipments to the EU/UK, if this field is empty, we will provide them with the phone number provided when the cardholder was initially created.' ) .optional(), - /** Whether a signature is required for card delivery. This feature is only supported for US users. Standard shipping service does not support signature on delivery. The default value for standard shipping service is false and for express and priority services is true. */ + /**Whether a signature is required for card delivery. This feature is only supported for US users. Standard shipping service does not support signature on delivery. The default value for standard shipping service is false and for express and priority services is true.*/ require_signature: z .boolean() - .nullable() .describe( 'Whether a signature is required for card delivery. This feature is only supported for US users. Standard shipping service does not support signature on delivery. The default value for standard shipping service is false and for express and priority services is true.' ) .optional(), - /** Shipment service, such as `standard` or `express`. */ + /**Shipment service, such as `standard` or `express`.*/ service: z .enum(['express', 'priority', 'standard']) .describe('Shipment service, such as `standard` or `express`.'), - /** The delivery status of the card. */ + /**The delivery status of the card.*/ status: z .enum([ 'canceled', @@ -24922,61 +23724,58 @@ export namespace stripe { 'shipped', 'submitted' ]) - .nullable() .describe('The delivery status of the card.') .optional(), - /** A tracking number for a card shipment. */ + /**A tracking number for a card shipment.*/ tracking_number: z .string() .max(5000) - .nullable() .describe('A tracking number for a card shipment.') .optional(), - /** A link to the shipping carrier's site where you can view detailed information about a card shipment. */ + /**A link to the shipping carrier's site where you can view detailed information about a card shipment.*/ tracking_url: z .string() .max(5000) - .nullable() .describe( "A link to the shipping carrier's site where you can view detailed information about a card shipment." ) .optional(), - /** Packaging options. */ + /**Packaging options.*/ type: z.enum(['bulk', 'individual']).describe('Packaging options.') }) export type IssuingCardShipping = z.infer export const IssuingAuthorizationFleetReportedBreakdownSchema = z.object({ - /** Breakdown of fuel portion of the purchase. */ - fuel: IssuingAuthorizationFleetFuelPriceDataSchema.nullable() - .describe('Breakdown of fuel portion of the purchase.') - .optional(), - /** Breakdown of non-fuel portion of the purchase. */ - non_fuel: IssuingAuthorizationFleetNonFuelPriceDataSchema.nullable() - .describe('Breakdown of non-fuel portion of the purchase.') - .optional(), - /** Information about tax included in this transaction. */ - tax: IssuingAuthorizationFleetTaxDataSchema.nullable() - .describe('Information about tax included in this transaction.') - .optional() + /**Breakdown of fuel portion of the purchase.*/ + fuel: IssuingAuthorizationFleetFuelPriceDataSchema.describe( + 'Breakdown of fuel portion of the purchase.' + ).optional(), + /**Breakdown of non-fuel portion of the purchase.*/ + non_fuel: IssuingAuthorizationFleetNonFuelPriceDataSchema.describe( + 'Breakdown of non-fuel portion of the purchase.' + ).optional(), + /**Information about tax included in this transaction.*/ + tax: IssuingAuthorizationFleetTaxDataSchema.describe( + 'Information about tax included in this transaction.' + ).optional() }) export type IssuingAuthorizationFleetReportedBreakdown = z.infer< typeof IssuingAuthorizationFleetReportedBreakdownSchema > export const IssuingTransactionFleetReportedBreakdownSchema = z.object({ - /** Breakdown of fuel portion of the purchase. */ - fuel: IssuingTransactionFleetFuelPriceDataSchema.nullable() - .describe('Breakdown of fuel portion of the purchase.') - .optional(), - /** Breakdown of non-fuel portion of the purchase. */ - non_fuel: IssuingTransactionFleetNonFuelPriceDataSchema.nullable() - .describe('Breakdown of non-fuel portion of the purchase.') - .optional(), - /** Information about tax included in this transaction. */ - tax: IssuingTransactionFleetTaxDataSchema.nullable() - .describe('Information about tax included in this transaction.') - .optional() + /**Breakdown of fuel portion of the purchase.*/ + fuel: IssuingTransactionFleetFuelPriceDataSchema.describe( + 'Breakdown of fuel portion of the purchase.' + ).optional(), + /**Breakdown of non-fuel portion of the purchase.*/ + non_fuel: IssuingTransactionFleetNonFuelPriceDataSchema.describe( + 'Breakdown of non-fuel portion of the purchase.' + ).optional(), + /**Information about tax included in this transaction.*/ + tax: IssuingTransactionFleetTaxDataSchema.describe( + 'Information about tax included in this transaction.' + ).optional() }) export type IssuingTransactionFleetReportedBreakdown = z.infer< typeof IssuingTransactionFleetReportedBreakdownSchema @@ -24986,7 +23785,7 @@ export namespace stripe { financial_connections: LinkedAccountOptionsUsBankAccountSchema.optional(), mandate_options: PaymentMethodOptionsUsBankAccountMandateOptionsSchema.optional(), - /** Bank account verification method. */ + /**Bank account verification method.*/ verification_method: z .enum(['automatic', 'instant', 'microdeposits']) .describe('Bank account verification method.') @@ -24998,7 +23797,7 @@ export namespace stripe { export const PaymentIntentTypeSpecificPaymentMethodOptionsClientSchema = z.object({ - /** Controls when the funds will be captured from the customer's account. */ + /**Controls when the funds will be captured from the customer's account.*/ capture_method: z .enum(['manual', 'manual_preferred']) .describe( @@ -25006,14 +23805,14 @@ export namespace stripe { ) .optional(), installments: PaymentFlowsInstallmentOptionsSchema.optional(), - /** Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support. */ + /**Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.*/ request_incremental_authorization_support: z .boolean() .describe( 'Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support.' ) .optional(), - /** When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter). */ + /**When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter).*/ require_cvc_recollection: z .boolean() .describe( @@ -25036,7 +23835,7 @@ export namespace stripe { "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)." ) .optional(), - /** Bank account verification method. */ + /**Bank account verification method.*/ verification_method: z .enum(['automatic', 'instant', 'microdeposits']) .describe('Bank account verification method.') @@ -25047,7 +23846,7 @@ export namespace stripe { > export const PaymentIntentPaymentMethodOptionsCardSchema = z.object({ - /** Controls when the funds will be captured from the customer's account. */ + /**Controls when the funds will be captured from the customer's account.*/ capture_method: z .literal('manual') .describe( @@ -25059,18 +23858,14 @@ export namespace stripe { * * For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments). */ - installments: PaymentMethodOptionsCardInstallmentsSchema.nullable() - .describe( - 'Installment details for this payment (Mexico only).\n\nFor more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).' - ) - .optional(), - /** Configuration options for setting up an eMandate for cards issued in India. */ - mandate_options: PaymentMethodOptionsCardMandateOptionsSchema.nullable() - .describe( - 'Configuration options for setting up an eMandate for cards issued in India.' - ) - .optional(), - /** Selected network to process this payment intent on. Depends on the available networks of the card attached to the payment intent. Can be only set confirm-time. */ + installments: PaymentMethodOptionsCardInstallmentsSchema.describe( + 'Installment details for this payment (Mexico only).\n\nFor more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).' + ).optional(), + /**Configuration options for setting up an eMandate for cards issued in India.*/ + mandate_options: PaymentMethodOptionsCardMandateOptionsSchema.describe( + 'Configuration options for setting up an eMandate for cards issued in India.' + ).optional(), + /**Selected network to process this payment intent on. Depends on the available networks of the card attached to the payment intent. Can be only set confirm-time.*/ network: z .enum([ 'amex', @@ -25087,48 +23882,46 @@ export namespace stripe { 'unknown', 'visa' ]) - .nullable() .describe( 'Selected network to process this payment intent on. Depends on the available networks of the card attached to the payment intent. Can be only set confirm-time.' ) .optional(), - /** Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent. */ + /**Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent.*/ request_extended_authorization: z .enum(['if_available', 'never']) .describe( 'Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent.' ) .optional(), - /** Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent. */ + /**Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.*/ request_incremental_authorization: z .enum(['if_available', 'never']) .describe( 'Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.' ) .optional(), - /** Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent. */ + /**Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent.*/ request_multicapture: z .enum(['if_available', 'never']) .describe( 'Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent.' ) .optional(), - /** Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent. */ + /**Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent.*/ request_overcapture: z .enum(['if_available', 'never']) .describe( 'Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent.' ) .optional(), - /** We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. */ + /**We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.*/ request_three_d_secure: z .enum(['any', 'automatic', 'challenge']) - .nullable() .describe( 'We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.' ) .optional(), - /** When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter). */ + /**When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter).*/ require_cvc_recollection: z .boolean() .describe( @@ -25150,7 +23943,7 @@ export namespace stripe { "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)." ) .optional(), - /** Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters. */ + /**Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.*/ statement_descriptor_suffix_kana: z .string() .max(5000) @@ -25158,7 +23951,7 @@ export namespace stripe { 'Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.' ) .optional(), - /** Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters. */ + /**Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.*/ statement_descriptor_suffix_kanji: z .string() .max(5000) @@ -25175,7 +23968,7 @@ export namespace stripe { financial_connections: LinkedAccountOptionsUsBankAccountSchema.optional(), mandate_options: PaymentMethodOptionsUsBankAccountMandateOptionsSchema.optional(), - /** Preferred transaction settlement speed */ + /**Preferred transaction settlement speed*/ preferred_settlement_speed: z .enum(['fastest', 'standard']) .describe('Preferred transaction settlement speed') @@ -25195,7 +23988,7 @@ export namespace stripe { "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)." ) .optional(), - /** Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now. */ + /**Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.*/ target_date: z .string() .max(5000) @@ -25203,7 +23996,7 @@ export namespace stripe { "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now." ) .optional(), - /** Bank account verification method. */ + /**Bank account verification method.*/ verification_method: z .enum(['automatic', 'instant', 'microdeposits']) .describe('Bank account verification method.') @@ -25214,57 +24007,52 @@ export namespace stripe { > export const PaymentMethodCardPresentSchema = z.object({ - /** Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /**Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.*/ brand: z .string() .max(5000) - .nullable() .describe( 'Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.' ) .optional(), - /** The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. */ + /**The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card.*/ brand_product: z .string() .max(5000) - .nullable() .describe( 'The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card.' ) .optional(), - /** The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay. */ + /**The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.*/ cardholder_name: z .string() .max(5000) - .nullable() .describe( 'The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.' ) .optional(), - /** Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. */ + /**Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.*/ country: z .string() .max(5000) - .nullable() .describe( "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected." ) .optional(), - /** A high-level description of the type of cards issued in this range. */ + /**A high-level description of the type of cards issued in this range.*/ description: z .string() .max(5000) - .nullable() .describe( 'A high-level description of the type of cards issued in this range.' ) .optional(), - /** Two-digit number representing the card's expiration month. */ + /**Two-digit number representing the card's expiration month.*/ exp_month: z .number() .int() .describe("Two-digit number representing the card's expiration month."), - /** Four-digit number representing the card's expiration year. */ + /**Four-digit number representing the card's expiration year.*/ exp_year: z .number() .int() @@ -25277,53 +24065,46 @@ export namespace stripe { fingerprint: z .string() .max(5000) - .nullable() .describe( 'Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*' ) .optional(), - /** Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ + /**Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.*/ funding: z .string() .max(5000) - .nullable() .describe( 'Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.' ) .optional(), - /** The name of the card's issuing bank. */ + /**The name of the card's issuing bank.*/ issuer: z .string() .max(5000) - .nullable() .describe("The name of the card's issuing bank.") .optional(), - /** The last four digits of the card. */ + /**The last four digits of the card.*/ last4: z .string() .max(5000) - .nullable() .describe('The last four digits of the card.') .optional(), - /** Contains information about card networks that can be used to process the payment. */ - networks: PaymentMethodCardPresentNetworksSchema.nullable() - .describe( - 'Contains information about card networks that can be used to process the payment.' - ) - .optional(), - /** Details about payment methods collected offline. */ - offline: PaymentMethodDetailsCardPresentOfflineSchema.nullable() - .describe('Details about payment methods collected offline.') - .optional(), - /** EMV tag 5F2D. Preferred languages specified by the integrated circuit chip. */ + /**Contains information about card networks that can be used to process the payment.*/ + networks: PaymentMethodCardPresentNetworksSchema.describe( + 'Contains information about card networks that can be used to process the payment.' + ).optional(), + /**Details about payment methods collected offline.*/ + offline: PaymentMethodDetailsCardPresentOfflineSchema.describe( + 'Details about payment methods collected offline.' + ).optional(), + /**EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.*/ preferred_locales: z .array(z.string().max(5000)) - .nullable() .describe( 'EMV tag 5F2D. Preferred languages specified by the integrated circuit chip.' ) .optional(), - /** How card details were read in this transaction. */ + /**How card details were read in this transaction.*/ read_method: z .enum([ 'contact_emv', @@ -25332,7 +24113,6 @@ export namespace stripe { 'magnetic_stripe_fallback', 'magnetic_stripe_track2' ]) - .nullable() .describe('How card details were read in this transaction.') .optional(), wallet: @@ -25343,103 +24123,88 @@ export namespace stripe { > export const PaymentMethodUsBankAccountSchema = z.object({ - /** Account holder type: individual or company. */ + /**Account holder type: individual or company.*/ account_holder_type: z .enum(['company', 'individual']) - .nullable() .describe('Account holder type: individual or company.') .optional(), - /** Account type: checkings or savings. Defaults to checking if omitted. */ + /**Account type: checkings or savings. Defaults to checking if omitted.*/ account_type: z .enum(['checking', 'savings']) - .nullable() .describe( 'Account type: checkings or savings. Defaults to checking if omitted.' ) .optional(), - /** The name of the bank. */ + /**The name of the bank.*/ bank_name: z .string() .max(5000) - .nullable() .describe('The name of the bank.') .optional(), - /** The ID of the Financial Connections Account used to create the payment method. */ + /**The ID of the Financial Connections Account used to create the payment method.*/ financial_connections_account: z .string() .max(5000) - .nullable() .describe( 'The ID of the Financial Connections Account used to create the payment method.' ) .optional(), - /** Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /**Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.*/ fingerprint: z .string() .max(5000) - .nullable() .describe( 'Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.' ) .optional(), - /** Last four digits of the bank account number. */ + /**Last four digits of the bank account number.*/ last4: z .string() .max(5000) - .nullable() .describe('Last four digits of the bank account number.') .optional(), - /** Contains information about US bank account networks that can be used. */ - networks: UsBankAccountNetworksSchema.nullable() - .describe( - 'Contains information about US bank account networks that can be used.' - ) - .optional(), - /** Routing number of the bank account. */ + /**Contains information about US bank account networks that can be used.*/ + networks: UsBankAccountNetworksSchema.describe( + 'Contains information about US bank account networks that can be used.' + ).optional(), + /**Routing number of the bank account.*/ routing_number: z .string() .max(5000) - .nullable() .describe('Routing number of the bank account.') .optional(), - /** Contains information about the future reusability of this PaymentMethod. */ - status_details: PaymentMethodUsBankAccountStatusDetailsSchema.nullable() - .describe( - 'Contains information about the future reusability of this PaymentMethod.' - ) - .optional() + /**Contains information about the future reusability of this PaymentMethod.*/ + status_details: PaymentMethodUsBankAccountStatusDetailsSchema.describe( + 'Contains information about the future reusability of this PaymentMethod.' + ).optional() }) export type PaymentMethodUsBankAccount = z.infer< typeof PaymentMethodUsBankAccountSchema > export const LegalEntityPersonVerificationSchema = z.object({ - /** A document showing address, either a passport, local ID card, or utility bill from a well-known utility company. */ - additional_document: LegalEntityPersonVerificationDocumentSchema.nullable() - .describe( - 'A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.' - ) - .optional(), - /** A user-displayable string describing the verification state for the person. For example, this may say "Provided identity information could not be verified". */ + /**A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.*/ + additional_document: LegalEntityPersonVerificationDocumentSchema.describe( + 'A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.' + ).optional(), + /**A user-displayable string describing the verification state for the person. For example, this may say "Provided identity information could not be verified".*/ details: z .string() .max(5000) - .nullable() .describe( 'A user-displayable string describing the verification state for the person. For example, this may say "Provided identity information could not be verified".' ) .optional(), - /** One of `document_address_mismatch`, `document_dob_mismatch`, `document_duplicate_type`, `document_id_number_mismatch`, `document_name_mismatch`, `document_nationality_mismatch`, `failed_keyed_identity`, or `failed_other`. A machine-readable code specifying the verification state for the person. */ + /**One of `document_address_mismatch`, `document_dob_mismatch`, `document_duplicate_type`, `document_id_number_mismatch`, `document_name_mismatch`, `document_nationality_mismatch`, `failed_keyed_identity`, or `failed_other`. A machine-readable code specifying the verification state for the person.*/ details_code: z .string() .max(5000) - .nullable() .describe( 'One of `document_address_mismatch`, `document_dob_mismatch`, `document_duplicate_type`, `document_id_number_mismatch`, `document_name_mismatch`, `document_nationality_mismatch`, `failed_keyed_identity`, or `failed_other`. A machine-readable code specifying the verification state for the person.' ) .optional(), document: LegalEntityPersonVerificationDocumentSchema.optional(), - /** The state of verification for the person. Possible values are `unverified`, `pending`, or `verified`. */ + /**The state of verification for the person. Possible values are `unverified`, `pending`, or `verified`.*/ status: z .string() .max(5000) @@ -25452,23 +24217,22 @@ export namespace stripe { > export const PortalSubscriptionUpdateSchema = z.object({ - /** The types of subscription updates that are supported for items listed in the `products` attribute. When empty, subscriptions are not updateable. */ + /**The types of subscription updates that are supported for items listed in the `products` attribute. When empty, subscriptions are not updateable.*/ default_allowed_updates: z .array(z.enum(['price', 'promotion_code', 'quantity'])) .describe( 'The types of subscription updates that are supported for items listed in the `products` attribute. When empty, subscriptions are not updateable.' ), - /** Whether the feature is enabled. */ + /**Whether the feature is enabled.*/ enabled: z.boolean().describe('Whether the feature is enabled.'), - /** The list of up to 10 products that support subscription updates. */ + /**The list of up to 10 products that support subscription updates.*/ products: z .array(PortalSubscriptionUpdateProductSchema) - .nullable() .describe( 'The list of up to 10 products that support subscription updates.' ) .optional(), - /** Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`. Defaults to a value of `none` if you don't set it during creation. */ + /**Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`. Defaults to a value of `none` if you don't set it during creation.*/ proration_behavior: z .enum(['always_invoice', 'create_prorations', 'none']) .describe( @@ -25486,24 +24250,23 @@ export namespace stripe { */ export const ClimateProductSchema = z .object({ - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Current prices for a metric ton of carbon removal in a currency's smallest unit. */ + /**Current prices for a metric ton of carbon removal in a currency's smallest unit.*/ current_prices_per_metric_ton: z .record(ClimateRemovalsProductsPriceSchema) .describe( "Current prices for a metric ton of carbon removal in a currency's smallest unit." ), - /** The year in which the carbon removal is expected to be delivered. */ + /**The year in which the carbon removal is expected to be delivered.*/ delivery_year: z .number() .int() - .nullable() .describe( 'The year in which the carbon removal is expected to be delivered.' ) @@ -25519,25 +24282,25 @@ export namespace stripe { .describe( 'Unique identifier for the object. For convenience, Climate product IDs are human-readable strings\nthat start with `climsku_`. See [carbon removal inventory](https://stripe.com/docs/climate/orders/carbon-removal-inventory)\nfor a list of available carbon removal products.' ), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** The quantity of metric tons available for reservation. */ + /**The quantity of metric tons available for reservation.*/ metric_tons_available: z .string() .describe('The quantity of metric tons available for reservation.'), - /** The Climate product's name. */ + /**The Climate product's name.*/ name: z.string().max(5000).describe("The Climate product's name."), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('climate.product') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The carbon removal suppliers that fulfill orders for this Climate product. */ + /**The carbon removal suppliers that fulfill orders for this Climate product.*/ suppliers: z .array(ClimateSupplierSchema) .describe( @@ -25561,7 +24324,7 @@ export namespace stripe { */ export const ReportingReportRunSchema = z .object({ - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() @@ -25575,27 +24338,26 @@ export namespace stripe { error: z .string() .max(5000) - .nullable() .describe( 'If something should go wrong during the run, a message about the failure (populated when\n `status=failed`).' ) .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** `true` if the report is run on live mode data and `false` if it is run on test mode data. */ + /**`true` if the report is run on live mode data and `false` if it is run on test mode data.*/ livemode: z .boolean() .describe( '`true` if the report is run on live mode data and `false` if it is run on test mode data.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('reporting.report_run') .describe( "String representing the object's type. Objects of the same type share the same value." ), parameters: FinancialReportingFinanceReportRunRunParametersSchema, - /** The ID of the [report type](https://stripe.com/docs/reports/report-types) to run, such as `"balance.summary.1"`. */ + /**The ID of the [report type](https://stripe.com/docs/reports/report-types) to run, such as `"balance.summary.1"`.*/ report_type: z .string() .max(5000) @@ -25606,11 +24368,9 @@ export namespace stripe { * The file object representing the result of the report run (populated when * `status=succeeded`). */ - result: FileSchema.nullable() - .describe( - 'The file object representing the result of the report run (populated when\n `status=succeeded`).' - ) - .optional(), + result: FileSchema.describe( + 'The file object representing the result of the report run (populated when\n `status=succeeded`).' + ).optional(), /** * Status of this report run. This will be `pending` when the run is initially created. * When the run finishes, this will be set to `succeeded` and the `result` field will be populated. @@ -25629,7 +24389,6 @@ export namespace stripe { succeeded_at: z .number() .int() - .nullable() .describe( 'Timestamp at which this run successfully finished (populated when\n `status=succeeded`). Measured in seconds since the Unix epoch.' ) @@ -25648,14 +24407,14 @@ export namespace stripe { */ export const ScheduledQueryRunSchema = z .object({ - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** When the query was run, Sigma contained a snapshot of your Stripe data at this time. */ + /**When the query was run, Sigma contained a snapshot of your Stripe data at this time.*/ data_load_time: z .number() .int() @@ -25663,41 +24422,41 @@ export namespace stripe { 'When the query was run, Sigma contained a snapshot of your Stripe data at this time.' ), error: SigmaScheduledQueryRunErrorSchema.optional(), - /** The file object representing the results of the query. */ - file: FileSchema.nullable() - .describe('The file object representing the results of the query.') - .optional(), - /** Unique identifier for the object. */ + /**The file object representing the results of the query.*/ + file: FileSchema.describe( + 'The file object representing the results of the query.' + ).optional(), + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('scheduled_query_run') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** Time at which the result expires and is no longer available for download. */ + /**Time at which the result expires and is no longer available for download.*/ result_available_until: z .number() .int() .describe( 'Time at which the result expires and is no longer available for download.' ), - /** SQL for the query. */ + /**SQL for the query.*/ sql: z.string().max(100_000).describe('SQL for the query.'), - /** The query's execution status, which will be `completed` for successful runs, and `canceled`, `failed`, or `timed_out` otherwise. */ + /**The query's execution status, which will be `completed` for successful runs, and `canceled`, `failed`, or `timed_out` otherwise.*/ status: z .string() .max(5000) .describe( "The query's execution status, which will be `completed` for successful runs, and `canceled`, `failed`, or `timed_out` otherwise." ), - /** Title of the query. */ + /**Title of the query.*/ title: z.string().max(5000).describe('Title of the query.') }) .describe( @@ -25706,70 +24465,67 @@ export namespace stripe { export type ScheduledQueryRun = z.infer export const TaxCalculationLineItemSchema = z.object({ - /** The line item amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. */ + /**The line item amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.*/ amount: z .number() .int() .describe( 'The line item amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.' ), - /** The amount of tax calculated for this line item, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /**The amount of tax calculated for this line item, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).*/ amount_tax: z .number() .int() .describe( 'The amount of tax calculated for this line item, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).' ), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('tax.calculation_line_item') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The ID of an existing [Product](https://stripe.com/docs/api/products/object). */ + /**The ID of an existing [Product](https://stripe.com/docs/api/products/object).*/ product: z .string() .max(5000) - .nullable() .describe( 'The ID of an existing [Product](https://stripe.com/docs/api/products/object).' ) .optional(), - /** The number of units of the item being purchased. For reversals, this is the quantity reversed. */ + /**The number of units of the item being purchased. For reversals, this is the quantity reversed.*/ quantity: z .number() .int() .describe( 'The number of units of the item being purchased. For reversals, this is the quantity reversed.' ), - /** A custom identifier for this line item. */ + /**A custom identifier for this line item.*/ reference: z .string() .max(5000) - .nullable() .describe('A custom identifier for this line item.') .optional(), - /** Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes. */ + /**Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.*/ tax_behavior: z .enum(['exclusive', 'inclusive']) .describe( 'Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.' ), - /** Detailed account of taxes relevant to this line item. */ + /**Detailed account of taxes relevant to this line item.*/ tax_breakdown: z .array(TaxProductResourceLineItemTaxBreakdownSchema) - .nullable() .describe('Detailed account of taxes relevant to this line item.') .optional(), - /** The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for this resource. */ + /**The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for this resource.*/ tax_code: z .string() .max(5000) @@ -25782,21 +24538,21 @@ export namespace stripe { > export const TaxProductResourceTaxCalculationShippingCostSchema = z.object({ - /** The shipping amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. */ + /**The shipping amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.*/ amount: z .number() .int() .describe( 'The shipping amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount.' ), - /** The amount of tax calculated for shipping, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /**The amount of tax calculated for shipping, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).*/ amount_tax: z .number() .int() .describe( 'The amount of tax calculated for shipping, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).' ), - /** The ID of an existing [ShippingRate](https://stripe.com/docs/api/shipping_rates/object). */ + /**The ID of an existing [ShippingRate](https://stripe.com/docs/api/shipping_rates/object).*/ shipping_rate: z .string() .max(5000) @@ -25804,18 +24560,18 @@ export namespace stripe { 'The ID of an existing [ShippingRate](https://stripe.com/docs/api/shipping_rates/object).' ) .optional(), - /** Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes. */ + /**Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.*/ tax_behavior: z .enum(['exclusive', 'inclusive']) .describe( 'Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes.' ), - /** Detailed account of taxes relevant to shipping cost. */ + /**Detailed account of taxes relevant to shipping cost.*/ tax_breakdown: z .array(TaxProductResourceLineItemTaxBreakdownSchema) .describe('Detailed account of taxes relevant to shipping cost.') .optional(), - /** The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for shipping. */ + /**The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for shipping.*/ tax_code: z .string() .max(5000) @@ -25827,7 +24583,7 @@ export namespace stripe { typeof TaxProductResourceTaxCalculationShippingCostSchema > - /** Settings related to Outbound Payments features on a Financial Account */ + /**Settings related to Outbound Payments features on a Financial Account*/ export const TreasuryFinancialAccountsResourceOutboundPaymentsSchema = z .object({ ach: TreasuryFinancialAccountsResourceOutboundAchToggleSettingsSchema.optional(), @@ -25841,7 +24597,7 @@ export namespace stripe { typeof TreasuryFinancialAccountsResourceOutboundPaymentsSchema > - /** OutboundTransfers contains outbound transfers features for a FinancialAccount. */ + /**OutboundTransfers contains outbound transfers features for a FinancialAccount.*/ export const TreasuryFinancialAccountsResourceOutboundTransfersSchema = z .object({ ach: TreasuryFinancialAccountsResourceOutboundAchToggleSettingsSchema.optional(), @@ -25857,7 +24613,7 @@ export namespace stripe { export const CardGeneratedFromPaymentMethodDetailsSchema = z.object({ card_present: PaymentMethodDetailsCardPresentSchema.optional(), - /** The type of payment method transaction-specific details from the transaction that generated this `card` payment method. Always `card_present`. */ + /**The type of payment method transaction-specific details from the transaction that generated this `card` payment method. Always `card_present`.*/ type: z .string() .max(5000) @@ -25877,14 +24633,13 @@ export namespace stripe { CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceGbBankTransferSchema.optional(), jp_bank_transfer: CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceJpBankTransferSchema.optional(), - /** The user-supplied reference field on the bank transfer. */ + /**The user-supplied reference field on the bank transfer.*/ reference: z .string() .max(5000) - .nullable() .describe('The user-supplied reference field on the bank transfer.') .optional(), - /** The funding method type used to fund the customer balance. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`. */ + /**The funding method type used to fund the customer balance. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.*/ type: z .enum([ 'eu_bank_transfer', @@ -25909,7 +24664,7 @@ export namespace stripe { card: DisputePaymentMethodDetailsCardSchema.optional(), klarna: DisputePaymentMethodDetailsKlarnaSchema.optional(), paypal: DisputePaymentMethodDetailsPaypalSchema.optional(), - /** Payment method type. */ + /**Payment method type.*/ type: z .enum(['amazon_pay', 'card', 'klarna', 'paypal']) .describe('Payment method type.') @@ -25922,14 +24677,14 @@ export namespace stripe { cashapp_handle_redirect_or_display_qr_code: PaymentIntentNextActionCashappHandleRedirectOrDisplayQrCodeSchema.optional(), redirect_to_url: SetupIntentNextActionRedirectToUrlSchema.optional(), - /** Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`. */ + /**Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`.*/ type: z .string() .max(5000) .describe( 'Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`.' ), - /** When confirming a SetupIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js. */ + /**When confirming a SetupIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js.*/ use_stripe_sdk: z .record(z.any()) .describe( @@ -25944,22 +24699,22 @@ export namespace stripe { > export const PaymentIntentNextActionKonbiniStoresSchema = z.object({ - /** FamilyMart instruction details. */ - familymart: PaymentIntentNextActionKonbiniFamilymartSchema.nullable() - .describe('FamilyMart instruction details.') - .optional(), - /** Lawson instruction details. */ - lawson: PaymentIntentNextActionKonbiniLawsonSchema.nullable() - .describe('Lawson instruction details.') - .optional(), - /** Ministop instruction details. */ - ministop: PaymentIntentNextActionKonbiniMinistopSchema.nullable() - .describe('Ministop instruction details.') - .optional(), - /** Seicomart instruction details. */ - seicomart: PaymentIntentNextActionKonbiniSeicomartSchema.nullable() - .describe('Seicomart instruction details.') - .optional() + /**FamilyMart instruction details.*/ + familymart: PaymentIntentNextActionKonbiniFamilymartSchema.describe( + 'FamilyMart instruction details.' + ).optional(), + /**Lawson instruction details.*/ + lawson: PaymentIntentNextActionKonbiniLawsonSchema.describe( + 'Lawson instruction details.' + ).optional(), + /**Ministop instruction details.*/ + ministop: PaymentIntentNextActionKonbiniMinistopSchema.describe( + 'Ministop instruction details.' + ).optional(), + /**Seicomart instruction details.*/ + seicomart: PaymentIntentNextActionKonbiniSeicomartSchema.describe( + 'Seicomart instruction details.' + ).optional() }) export type PaymentIntentNextActionKonbiniStores = z.infer< typeof PaymentIntentNextActionKonbiniStoresSchema @@ -25972,7 +24727,7 @@ export namespace stripe { */ export const BillingMeterSchema = z .object({ - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() @@ -25981,40 +24736,39 @@ export namespace stripe { ), customer_mapping: BillingMeterResourceCustomerMappingSettingsSchema, default_aggregation: BillingMeterResourceAggregationSettingsSchema, - /** The meter's name. */ + /**The meter's name.*/ display_name: z.string().max(5000).describe("The meter's name."), - /** The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events. */ + /**The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events.*/ event_name: z .string() .max(5000) .describe( 'The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events.' ), - /** The time window to pre-aggregate meter events for, if any. */ + /**The time window to pre-aggregate meter events for, if any.*/ event_time_window: z .enum(['day', 'hour']) - .nullable() .describe('The time window to pre-aggregate meter events for, if any.') .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('billing.meter') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The meter's status. */ + /**The meter's status.*/ status: z.enum(['active', 'inactive']).describe("The meter's status."), status_transitions: BillingMeterResourceBillingMeterStatusTransitionsSchema, - /** Time at which the object was last updated. Measured in seconds since the Unix epoch. */ + /**Time at which the object was last updated. Measured in seconds since the Unix epoch.*/ updated: z .number() .int() @@ -26028,7 +24782,7 @@ export namespace stripe { ) export type BillingMeter = z.infer - /** Configuration for the components supported by this Customer Session. */ + /**Configuration for the components supported by this Customer Session.*/ export const CustomerSessionResourceComponentsSchema = z .object({ buy_button: CustomerSessionResourceComponentsResourceBuyButtonSchema, @@ -26063,43 +24817,42 @@ export namespace stripe { */ export const ForwardingRequestSchema = z .object({ - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) - .nullable() .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ) .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('forwarding.request') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed. */ + /**The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.*/ payment_method: z .string() .max(5000) .describe( 'The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.' ), - /** The field kinds to be replaced in the forwarded request. */ + /**The field kinds to be replaced in the forwarded request.*/ replacements: z .array( z.enum([ @@ -26111,29 +24864,22 @@ export namespace stripe { ]) ) .describe('The field kinds to be replaced in the forwarded request.'), - /** Context about the request from Stripe's servers to the destination endpoint. */ - request_context: ForwardedRequestContextSchema.nullable() - .describe( - "Context about the request from Stripe's servers to the destination endpoint." - ) - .optional(), - /** The request that was sent to the destination endpoint. We redact any sensitive fields. */ - request_details: ForwardedRequestDetailsSchema.nullable() - .describe( - 'The request that was sent to the destination endpoint. We redact any sensitive fields.' - ) - .optional(), - /** The response that the destination endpoint returned to us. We redact any sensitive fields. */ - response_details: ForwardedResponseDetailsSchema.nullable() - .describe( - 'The response that the destination endpoint returned to us. We redact any sensitive fields.' - ) - .optional(), - /** The destination URL for the forwarded request. Must be supported by the config. */ + /**Context about the request from Stripe's servers to the destination endpoint.*/ + request_context: ForwardedRequestContextSchema.describe( + "Context about the request from Stripe's servers to the destination endpoint." + ).optional(), + /**The request that was sent to the destination endpoint. We redact any sensitive fields.*/ + request_details: ForwardedRequestDetailsSchema.describe( + 'The request that was sent to the destination endpoint. We redact any sensitive fields.' + ).optional(), + /**The response that the destination endpoint returned to us. We redact any sensitive fields.*/ + response_details: ForwardedResponseDetailsSchema.describe( + 'The response that the destination endpoint returned to us. We redact any sensitive fields.' + ).optional(), + /**The destination URL for the forwarded request. Must be supported by the config.*/ url: z .string() .max(5000) - .nullable() .describe( 'The destination URL for the forwarded request. Must be supported by the config.' ) @@ -26160,7 +24906,7 @@ export namespace stripe { TaxProductRegistrationsResourceCountryOptionsUsLocalAmusementTaxSchema.optional(), local_lease_tax: TaxProductRegistrationsResourceCountryOptionsUsLocalLeaseTaxSchema.optional(), - /** Two-letter US state code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). */ + /**Two-letter US state code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).*/ state: z .string() .max(5000) @@ -26169,7 +24915,7 @@ export namespace stripe { ), state_sales_tax: TaxProductRegistrationsResourceCountryOptionsUsStateSalesTaxSchema.optional(), - /** Type of registration in the US. */ + /**Type of registration in the US.*/ type: z .enum([ 'local_amusement_tax', @@ -26187,7 +24933,7 @@ export namespace stripe { export const TreasurySharedResourceInitiatingPaymentMethodDetailsInitiatingPaymentMethodDetailsSchema = z.object({ - /** Set when `type` is `balance`. */ + /**Set when `type` is `balance`.*/ balance: z .literal('payments') .describe('Set when `type` is `balance`.') @@ -26195,7 +24941,7 @@ export namespace stripe { billing_details: TreasurySharedResourceBillingDetailsSchema, financial_account: ReceivedPaymentMethodDetailsFinancialAccountSchema.optional(), - /** Set when `type` is `issuing_card`. This is an [Issuing Card](https://stripe.com/docs/api#issuing_cards) ID. */ + /**Set when `type` is `issuing_card`. This is an [Issuing Card](https://stripe.com/docs/api#issuing_cards) ID.*/ issuing_card: z .string() .max(5000) @@ -26203,7 +24949,7 @@ export namespace stripe { 'Set when `type` is `issuing_card`. This is an [Issuing Card](https://stripe.com/docs/api#issuing_cards) ID.' ) .optional(), - /** Polymorphic type matching the originating money movement's source. This can be an external account, a Stripe balance, or a FinancialAccount. */ + /**Polymorphic type matching the originating money movement's source. This can be an external account, a Stripe balance, or a FinancialAccount.*/ type: z .enum([ 'balance', @@ -26224,42 +24970,36 @@ export namespace stripe { > export const SetupAttemptPaymentMethodDetailsCardSchema = z.object({ - /** Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /**Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.*/ brand: z .string() .max(5000) - .nullable() .describe( 'Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.' ) .optional(), - /** Check results by Card networks on Card address and CVC at the time of authorization */ - checks: SetupAttemptPaymentMethodDetailsCardChecksSchema.nullable() - .describe( - 'Check results by Card networks on Card address and CVC at the time of authorization' - ) - .optional(), - /** Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. */ + /**Check results by Card networks on Card address and CVC at the time of authorization*/ + checks: SetupAttemptPaymentMethodDetailsCardChecksSchema.describe( + 'Check results by Card networks on Card address and CVC at the time of authorization' + ).optional(), + /**Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.*/ country: z .string() .max(5000) - .nullable() .describe( "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected." ) .optional(), - /** Two-digit number representing the card's expiration month. */ + /**Two-digit number representing the card's expiration month.*/ exp_month: z .number() .int() - .nullable() .describe("Two-digit number representing the card's expiration month.") .optional(), - /** Four-digit number representing the card's expiration year. */ + /**Four-digit number representing the card's expiration year.*/ exp_year: z .number() .int() - .nullable() .describe("Four-digit number representing the card's expiration year.") .optional(), /** @@ -26270,48 +25010,40 @@ export namespace stripe { fingerprint: z .string() .max(5000) - .nullable() .describe( 'Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*' ) .optional(), - /** Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ + /**Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.*/ funding: z .string() .max(5000) - .nullable() .describe( 'Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.' ) .optional(), - /** The last four digits of the card. */ + /**The last four digits of the card.*/ last4: z .string() .max(5000) - .nullable() .describe('The last four digits of the card.') .optional(), - /** Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /**Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.*/ network: z .string() .max(5000) - .nullable() .describe( 'Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.' ) .optional(), - /** Populated if this authorization used 3D Secure authentication. */ - three_d_secure: ThreeDSecureDetailsSchema.nullable() - .describe( - 'Populated if this authorization used 3D Secure authentication.' - ) - .optional(), - /** If this Card is part of a card wallet, this contains the details of the card wallet. */ - wallet: SetupAttemptPaymentMethodDetailsCardWalletSchema.nullable() - .describe( - 'If this Card is part of a card wallet, this contains the details of the card wallet.' - ) - .optional() + /**Populated if this authorization used 3D Secure authentication.*/ + three_d_secure: ThreeDSecureDetailsSchema.describe( + 'Populated if this authorization used 3D Secure authentication.' + ).optional(), + /**If this Card is part of a card wallet, this contains the details of the card wallet.*/ + wallet: SetupAttemptPaymentMethodDetailsCardWalletSchema.describe( + 'If this Card is part of a card wallet, this contains the details of the card wallet.' + ).optional() }) export type SetupAttemptPaymentMethodDetailsCard = z.infer< typeof SetupAttemptPaymentMethodDetailsCardSchema @@ -26337,34 +25069,28 @@ export namespace stripe { > export const IssuingAuthorizationFleetDataSchema = z.object({ - /** Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry. */ + /**Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.*/ cardholder_prompt_data: - IssuingAuthorizationFleetCardholderPromptDataSchema.nullable() - .describe( - 'Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.' - ) - .optional(), - /** The type of purchase. */ + IssuingAuthorizationFleetCardholderPromptDataSchema.describe( + 'Answers to prompts presented to the cardholder at the point of sale. Prompted fields vary depending on the configuration of your physical fleet cards. Typical points of sale support only numeric entry.' + ).optional(), + /**The type of purchase.*/ purchase_type: z .enum([ 'fuel_and_non_fuel_purchase', 'fuel_purchase', 'non_fuel_purchase' ]) - .nullable() .describe('The type of purchase.') .optional(), - /** More information about the total amount. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed. This information is not guaranteed to be accurate as some merchants may provide unreliable data. */ + /**More information about the total amount. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed. This information is not guaranteed to be accurate as some merchants may provide unreliable data.*/ reported_breakdown: - IssuingAuthorizationFleetReportedBreakdownSchema.nullable() - .describe( - 'More information about the total amount. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed. This information is not guaranteed to be accurate as some merchants may provide unreliable data.' - ) - .optional(), - /** The type of fuel service. */ + IssuingAuthorizationFleetReportedBreakdownSchema.describe( + 'More information about the total amount. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed. This information is not guaranteed to be accurate as some merchants may provide unreliable data.' + ).optional(), + /**The type of fuel service.*/ service_type: z .enum(['full_service', 'non_fuel_transaction', 'self_service']) - .nullable() .describe('The type of fuel service.') .optional() }) @@ -26375,7 +25101,7 @@ export namespace stripe { export const IssuingNetworkTokenNetworkDataSchema = z.object({ device: IssuingNetworkTokenDeviceSchema.optional(), mastercard: IssuingNetworkTokenMastercardSchema.optional(), - /** The network that the token is associated with. An additional hash is included with a name matching this value, containing tokenization data specific to the card network. */ + /**The network that the token is associated with. An additional hash is included with a name matching this value, containing tokenization data specific to the card network.*/ type: z .enum(['mastercard', 'visa']) .describe( @@ -26389,34 +25115,27 @@ export namespace stripe { > export const IssuingTransactionFleetDataSchema = z.object({ - /** Answers to prompts presented to cardholder at point of sale. */ + /**Answers to prompts presented to cardholder at point of sale.*/ cardholder_prompt_data: - IssuingTransactionFleetCardholderPromptDataSchema.nullable() - .describe( - 'Answers to prompts presented to cardholder at point of sale.' - ) - .optional(), - /** The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`. */ + IssuingTransactionFleetCardholderPromptDataSchema.describe( + 'Answers to prompts presented to cardholder at point of sale.' + ).optional(), + /**The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.*/ purchase_type: z .string() .max(5000) - .nullable() .describe( 'The type of purchase. One of `fuel_purchase`, `non_fuel_purchase`, or `fuel_and_non_fuel_purchase`.' ) .optional(), - /** More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data. */ - reported_breakdown: - IssuingTransactionFleetReportedBreakdownSchema.nullable() - .describe( - 'More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.' - ) - .optional(), - /** The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`. */ + /**More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.*/ + reported_breakdown: IssuingTransactionFleetReportedBreakdownSchema.describe( + 'More information about the total amount. This information is not guaranteed to be accurate as some merchants may provide unreliable data.' + ).optional(), + /**The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.*/ service_type: z .string() .max(5000) - .nullable() .describe( 'The type of fuel service. One of `non_fuel_transaction`, `full_service`, or `self_service`.' ) @@ -26432,72 +25151,67 @@ export namespace stripe { */ export const ShippingRateSchema = z .object({ - /** Whether the shipping rate can be used for new purchases. Defaults to `true`. */ + /**Whether the shipping rate can be used for new purchases. Defaults to `true`.*/ active: z .boolean() .describe( 'Whether the shipping rate can be used for new purchases. Defaults to `true`.' ), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions. */ - delivery_estimate: ShippingRateDeliveryEstimateSchema.nullable() - .describe( - 'The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.' - ) - .optional(), - /** The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions. */ + /**The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.*/ + delivery_estimate: ShippingRateDeliveryEstimateSchema.describe( + 'The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.' + ).optional(), + /**The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.*/ display_name: z .string() .max(5000) - .nullable() .describe( 'The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.' ) .optional(), fixed_amount: ShippingRateFixedAmountSchema.optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('shipping_rate') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. */ + /**Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.*/ tax_behavior: z .enum(['exclusive', 'inclusive', 'unspecified']) - .nullable() .describe( 'Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.' ) .optional(), - /** A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. */ + /**A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.*/ tax_code: z .union([z.string().max(5000), TaxCodeSchema]) - .nullable() .describe( 'A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.' ) .optional(), - /** The type of calculation to use on the shipping rate. */ + /**The type of calculation to use on the shipping rate.*/ type: z .literal('fixed_amount') .describe('The type of calculation to use on the shipping rate.') @@ -26508,16 +25222,15 @@ export namespace stripe { export type ShippingRate = z.infer export const PaymentIntentNextActionKonbiniSchema = z.object({ - /** The timestamp at which the pending Konbini payment expires. */ + /**The timestamp at which the pending Konbini payment expires.*/ expires_at: z .number() .int() .describe('The timestamp at which the pending Konbini payment expires.'), - /** The URL for the Konbini payment instructions page, which allows customers to view and print a Konbini voucher. */ + /**The URL for the Konbini payment instructions page, which allows customers to view and print a Konbini voucher.*/ hosted_voucher_url: z .string() .max(5000) - .nullable() .describe( 'The URL for the Konbini payment instructions page, which allows customers to view and print a Konbini voucher.' ) @@ -26543,38 +25256,38 @@ export namespace stripe { */ export const BalanceSchema = z .object({ - /** Available funds that you can transfer or pay out automatically by Stripe or explicitly through the [Transfers API](https://stripe.com/docs/api#transfers) or [Payouts API](https://stripe.com/docs/api#payouts). You can find the available balance for each currency and payment type in the `source_types` property. */ + /**Available funds that you can transfer or pay out automatically by Stripe or explicitly through the [Transfers API](https://stripe.com/docs/api#transfers) or [Payouts API](https://stripe.com/docs/api#payouts). You can find the available balance for each currency and payment type in the `source_types` property.*/ available: z .array(BalanceAmountSchema) .describe( 'Available funds that you can transfer or pay out automatically by Stripe or explicitly through the [Transfers API](https://stripe.com/docs/api#transfers) or [Payouts API](https://stripe.com/docs/api#payouts). You can find the available balance for each currency and payment type in the `source_types` property.' ), - /** Funds held due to negative balances on connected accounts where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. You can find the connect reserve balance for each currency and payment type in the `source_types` property. */ + /**Funds held due to negative balances on connected accounts where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. You can find the connect reserve balance for each currency and payment type in the `source_types` property.*/ connect_reserved: z .array(BalanceAmountSchema) .describe( 'Funds held due to negative balances on connected accounts where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. You can find the connect reserve balance for each currency and payment type in the `source_types` property.' ) .optional(), - /** Funds that you can pay out using Instant Payouts. */ + /**Funds that you can pay out using Instant Payouts.*/ instant_available: z .array(BalanceAmountNetSchema) .describe('Funds that you can pay out using Instant Payouts.') .optional(), issuing: BalanceDetailSchema.optional(), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('balance') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** Funds that aren't available in the balance yet. You can find the pending balance for each currency and each payment type in the `source_types` property. */ + /**Funds that aren't available in the balance yet. You can find the pending balance for each currency and each payment type in the `source_types` property.*/ pending: z .array(BalanceAmountSchema) .describe( @@ -26588,7 +25301,7 @@ export namespace stripe { export const PaymentPagesCheckoutSessionCustomFieldsSchema = z.object({ dropdown: PaymentPagesCheckoutSessionCustomFieldsDropdownSchema.optional(), - /** String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters. */ + /**String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.*/ key: z .string() .max(5000) @@ -26597,14 +25310,14 @@ export namespace stripe { ), label: PaymentPagesCheckoutSessionCustomFieldsLabelSchema, numeric: PaymentPagesCheckoutSessionCustomFieldsNumericSchema.optional(), - /** Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`. */ + /**Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.*/ optional: z .boolean() .describe( 'Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.' ), text: PaymentPagesCheckoutSessionCustomFieldsTextSchema.optional(), - /** The type of the field. */ + /**The type of the field.*/ type: z .enum(['dropdown', 'numeric', 'text']) .describe('The type of the field.') @@ -26615,7 +25328,7 @@ export namespace stripe { export const PaymentLinksResourceCustomFieldsSchema = z.object({ dropdown: PaymentLinksResourceCustomFieldsDropdownSchema.optional(), - /** String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters. */ + /**String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.*/ key: z .string() .max(5000) @@ -26624,14 +25337,14 @@ export namespace stripe { ), label: PaymentLinksResourceCustomFieldsLabelSchema, numeric: PaymentLinksResourceCustomFieldsNumericSchema.optional(), - /** Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`. */ + /**Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.*/ optional: z .boolean() .describe( 'Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.' ), text: PaymentLinksResourceCustomFieldsTextSchema.optional(), - /** The type of the field. */ + /**The type of the field.*/ type: z .enum(['dropdown', 'numeric', 'text']) .describe('The type of the field.') @@ -26640,75 +25353,63 @@ export namespace stripe { typeof PaymentLinksResourceCustomFieldsSchema > - /** Result from a document check */ + /**Result from a document check*/ export const GelatoDocumentReportSchema = z .object({ - /** Address as it appears in the document. */ - address: AddressSchema.nullable() - .describe('Address as it appears in the document.') - .optional(), - /** Date of birth as it appears in the document. */ - dob: GelatoDataDocumentReportDateOfBirthSchema.nullable() - .describe('Date of birth as it appears in the document.') - .optional(), - /** Details on the verification error. Present when status is `unverified`. */ - error: GelatoDocumentReportErrorSchema.nullable() - .describe( - 'Details on the verification error. Present when status is `unverified`.' - ) - .optional(), - /** Expiration date of the document. */ - expiration_date: GelatoDataDocumentReportExpirationDateSchema.nullable() - .describe('Expiration date of the document.') - .optional(), - /** Array of [File](https://stripe.com/docs/api/files) ids containing images for this document. */ + /**Address as it appears in the document.*/ + address: AddressSchema.describe( + 'Address as it appears in the document.' + ).optional(), + /**Date of birth as it appears in the document.*/ + dob: GelatoDataDocumentReportDateOfBirthSchema.describe( + 'Date of birth as it appears in the document.' + ).optional(), + /**Details on the verification error. Present when status is `unverified`.*/ + error: GelatoDocumentReportErrorSchema.describe( + 'Details on the verification error. Present when status is `unverified`.' + ).optional(), + /**Expiration date of the document.*/ + expiration_date: GelatoDataDocumentReportExpirationDateSchema.describe( + 'Expiration date of the document.' + ).optional(), + /**Array of [File](https://stripe.com/docs/api/files) ids containing images for this document.*/ files: z .array(z.string().max(5000)) - .nullable() .describe( 'Array of [File](https://stripe.com/docs/api/files) ids containing images for this document.' ) .optional(), - /** First name as it appears in the document. */ + /**First name as it appears in the document.*/ first_name: z .string() .max(5000) - .nullable() .describe('First name as it appears in the document.') .optional(), - /** Issued date of the document. */ - issued_date: GelatoDataDocumentReportIssuedDateSchema.nullable() - .describe('Issued date of the document.') - .optional(), - /** Issuing country of the document. */ + /**Issued date of the document.*/ + issued_date: GelatoDataDocumentReportIssuedDateSchema.describe( + 'Issued date of the document.' + ).optional(), + /**Issuing country of the document.*/ issuing_country: z .string() .max(5000) - .nullable() .describe('Issuing country of the document.') .optional(), - /** Last name as it appears in the document. */ + /**Last name as it appears in the document.*/ last_name: z .string() .max(5000) - .nullable() .describe('Last name as it appears in the document.') .optional(), - /** Document ID number. */ - number: z - .string() - .max(5000) - .nullable() - .describe('Document ID number.') - .optional(), - /** Status of this `document` check. */ + /**Document ID number.*/ + number: z.string().max(5000).describe('Document ID number.').optional(), + /**Status of this `document` check.*/ status: z .enum(['unverified', 'verified']) .describe('Status of this `document` check.'), - /** Type of the document. */ + /**Type of the document.*/ type: z .enum(['driving_license', 'id_card', 'passport']) - .nullable() .describe('Type of the document.') .optional() }) @@ -26725,7 +25426,7 @@ export namespace stripe { .object({ ach_credit_transfer: SourceTransactionAchCreditTransferDataSchema.optional(), - /** A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the amount your customer has pushed to the receiver. */ + /**A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the amount your customer has pushed to the receiver.*/ amount: z .number() .int() @@ -26734,14 +25435,14 @@ export namespace stripe { ), chf_credit_transfer: SourceTransactionChfCreditTransferDataSchema.optional(), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( @@ -26749,15 +25450,15 @@ export namespace stripe { ), gbp_credit_transfer: SourceTransactionGbpCreditTransferDataSchema.optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('source_transaction') .describe( @@ -26766,19 +25467,19 @@ export namespace stripe { paper_check: SourceTransactionPaperCheckDataSchema.optional(), sepa_credit_transfer: SourceTransactionSepaCreditTransferDataSchema.optional(), - /** The ID of the source this transaction is attached to. */ + /**The ID of the source this transaction is attached to.*/ source: z .string() .max(5000) .describe('The ID of the source this transaction is attached to.'), - /** The status of the transaction, one of `succeeded`, `pending`, or `failed`. */ + /**The status of the transaction, one of `succeeded`, `pending`, or `failed`.*/ status: z .string() .max(5000) .describe( 'The status of the transaction, one of `succeeded`, `pending`, or `failed`.' ), - /** The type of source this transaction is attached to. */ + /**The type of source this transaction is attached to.*/ type: z .enum([ 'ach_credit_transfer', @@ -26806,14 +25507,14 @@ export namespace stripe { export type SourceTransaction = z.infer export const PaymentLinksResourceShippingOptionSchema = z.object({ - /** A non-negative integer in cents representing how much to charge. */ + /**A non-negative integer in cents representing how much to charge.*/ shipping_amount: z .number() .int() .describe( 'A non-negative integer in cents representing how much to charge.' ), - /** The ID of the Shipping Rate to use for this shipping option. */ + /**The ID of the Shipping Rate to use for this shipping option.*/ shipping_rate: z .union([z.string().max(5000), ShippingRateSchema]) .describe('The ID of the Shipping Rate to use for this shipping option.') @@ -26823,14 +25524,14 @@ export namespace stripe { > export const PaymentPagesCheckoutSessionShippingOptionSchema = z.object({ - /** A non-negative integer in cents representing how much to charge. */ + /**A non-negative integer in cents representing how much to charge.*/ shipping_amount: z .number() .int() .describe( 'A non-negative integer in cents representing how much to charge.' ), - /** The shipping rate. */ + /**The shipping rate.*/ shipping_rate: z .union([z.string().max(5000), ShippingRateSchema]) .describe('The shipping rate.') @@ -26845,21 +25546,21 @@ export namespace stripe { */ export const ClimateOrderSchema = z .object({ - /** Total amount of [Frontier](https://frontierclimate.com/)'s service fees in the currency's smallest unit. */ + /**Total amount of [Frontier](https://frontierclimate.com/)'s service fees in the currency's smallest unit.*/ amount_fees: z .number() .int() .describe( "Total amount of [Frontier](https://frontierclimate.com/)'s service fees in the currency's smallest unit." ), - /** Total amount of the carbon removal in the currency's smallest unit. */ + /**Total amount of the carbon removal in the currency's smallest unit.*/ amount_subtotal: z .number() .int() .describe( "Total amount of the carbon removal in the currency's smallest unit." ), - /** Total amount of the order including fees in the currency's smallest unit. */ + /**Total amount of the order including fees in the currency's smallest unit.*/ amount_total: z .number() .int() @@ -26867,122 +25568,115 @@ export namespace stripe { "Total amount of the order including fees in the currency's smallest unit." ), beneficiary: ClimateRemovalsBeneficiarySchema.optional(), - /** Time at which the order was canceled. Measured in seconds since the Unix epoch. */ + /**Time at which the order was canceled. Measured in seconds since the Unix epoch.*/ canceled_at: z .number() .int() - .nullable() .describe( 'Time at which the order was canceled. Measured in seconds since the Unix epoch.' ) .optional(), - /** Reason for the cancellation of this order. */ + /**Reason for the cancellation of this order.*/ cancellation_reason: z .enum(['expired', 'product_unavailable', 'requested']) - .nullable() .describe('Reason for the cancellation of this order.') .optional(), - /** For delivered orders, a URL to a delivery certificate for the order. */ + /**For delivered orders, a URL to a delivery certificate for the order.*/ certificate: z .string() .max(5000) - .nullable() .describe( 'For delivered orders, a URL to a delivery certificate for the order.' ) .optional(), - /** Time at which the order was confirmed. Measured in seconds since the Unix epoch. */ + /**Time at which the order was confirmed. Measured in seconds since the Unix epoch.*/ confirmed_at: z .number() .int() - .nullable() .describe( 'Time at which the order was confirmed. Measured in seconds since the Unix epoch.' ) .optional(), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase, representing the currency for this order. */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase, representing the currency for this order.*/ currency: z .string() .max(5000) .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase, representing the currency for this order.' ), - /** Time at which the order's expected_delivery_year was delayed. Measured in seconds since the Unix epoch. */ + /**Time at which the order's expected_delivery_year was delayed. Measured in seconds since the Unix epoch.*/ delayed_at: z .number() .int() - .nullable() .describe( "Time at which the order's expected_delivery_year was delayed. Measured in seconds since the Unix epoch." ) .optional(), - /** Time at which the order was delivered. Measured in seconds since the Unix epoch. */ + /**Time at which the order was delivered. Measured in seconds since the Unix epoch.*/ delivered_at: z .number() .int() - .nullable() .describe( 'Time at which the order was delivered. Measured in seconds since the Unix epoch.' ) .optional(), - /** Details about the delivery of carbon removal for this order. */ + /**Details about the delivery of carbon removal for this order.*/ delivery_details: z .array(ClimateRemovalsOrderDeliveriesSchema) .describe( 'Details about the delivery of carbon removal for this order.' ), - /** The year this order is expected to be delivered. */ + /**The year this order is expected to be delivered.*/ expected_delivery_year: z .number() .int() .describe('The year this order is expected to be delivered.'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ), - /** Quantity of carbon removal that is included in this order. */ + /**Quantity of carbon removal that is included in this order.*/ metric_tons: z .string() .describe('Quantity of carbon removal that is included in this order.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('climate.order') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** Unique ID for the Climate `Product` this order is purchasing. */ + /**Unique ID for the Climate `Product` this order is purchasing.*/ product: z .union([z.string().max(5000), ClimateProductSchema]) .describe( 'Unique ID for the Climate `Product` this order is purchasing.' ), - /** Time at which the order's product was substituted for a different product. Measured in seconds since the Unix epoch. */ + /**Time at which the order's product was substituted for a different product. Measured in seconds since the Unix epoch.*/ product_substituted_at: z .number() .int() - .nullable() .describe( "Time at which the order's product was substituted for a different product. Measured in seconds since the Unix epoch." ) .optional(), - /** The current status of this order. */ + /**The current status of this order.*/ status: z .enum(['awaiting_funds', 'canceled', 'confirmed', 'delivered', 'open']) .describe('The current status of this order.') @@ -27000,23 +25694,23 @@ export namespace stripe { export const TaxSettingsSchema = z .object({ defaults: TaxProductResourceTaxSettingsDefaultsSchema, - /** The place where your business is located. */ - head_office: TaxProductResourceTaxSettingsHeadOfficeSchema.nullable() - .describe('The place where your business is located.') - .optional(), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**The place where your business is located.*/ + head_office: TaxProductResourceTaxSettingsHeadOfficeSchema.describe( + 'The place where your business is located.' + ).optional(), + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('tax.settings') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The status of the Tax `Settings`. */ + /**The status of the Tax `Settings`.*/ status: z .enum(['active', 'pending']) .describe('The status of the Tax `Settings`.'), @@ -27028,104 +25722,91 @@ export namespace stripe { export type TaxSettings = z.infer export const IssuingCardholderIndividualSchema = z.object({ - /** Information related to the card_issuing program for this cardholder. */ - card_issuing: IssuingCardholderCardIssuingSchema.nullable() - .describe( - 'Information related to the card_issuing program for this cardholder.' - ) - .optional(), - /** The date of birth of this cardholder. */ - dob: IssuingCardholderIndividualDobSchema.nullable() - .describe('The date of birth of this cardholder.') - .optional(), - /** The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters. */ + /**Information related to the card_issuing program for this cardholder.*/ + card_issuing: IssuingCardholderCardIssuingSchema.describe( + 'Information related to the card_issuing program for this cardholder.' + ).optional(), + /**The date of birth of this cardholder.*/ + dob: IssuingCardholderIndividualDobSchema.describe( + 'The date of birth of this cardholder.' + ).optional(), + /**The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.*/ first_name: z .string() .max(5000) - .nullable() .describe( 'The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.' ) .optional(), - /** The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters. */ + /**The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.*/ last_name: z .string() .max(5000) - .nullable() .describe( 'The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters.' ) .optional(), - /** Government-issued ID document for this cardholder. */ - verification: IssuingCardholderVerificationSchema.nullable() - .describe('Government-issued ID document for this cardholder.') - .optional() + /**Government-issued ID document for this cardholder.*/ + verification: IssuingCardholderVerificationSchema.describe( + 'Government-issued ID document for this cardholder.' + ).optional() }) export type IssuingCardholderIndividual = z.infer< typeof IssuingCardholderIndividualSchema > - /** A Personalization Design is a logical grouping of a Physical Bundle, card logo, and carrier text that represents a product line. */ + /**A Personalization Design is a logical grouping of a Physical Bundle, card logo, and carrier text that represents a product line.*/ export const IssuingPersonalizationDesignSchema = z .object({ - /** The file for the card logo to use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`. */ + /**The file for the card logo to use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.*/ card_logo: z .union([z.string().max(5000), FileSchema]) - .nullable() .describe( 'The file for the card logo to use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.' ) .optional(), - /** Hash containing carrier text, for use with physical bundles that support carrier text. */ - carrier_text: IssuingPersonalizationDesignCarrierTextSchema.nullable() - .describe( - 'Hash containing carrier text, for use with physical bundles that support carrier text.' - ) - .optional(), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Hash containing carrier text, for use with physical bundles that support carrier text.*/ + carrier_text: IssuingPersonalizationDesignCarrierTextSchema.describe( + 'Hash containing carrier text, for use with physical bundles that support carrier text.' + ).optional(), + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters. */ + /**A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.*/ lookup_key: z .string() .max(5000) - .nullable() .describe( 'A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.' ) .optional(), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ), - /** Friendly display name. */ - name: z - .string() - .max(5000) - .nullable() - .describe('Friendly display name.') - .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**Friendly display name.*/ + name: z.string().max(5000).describe('Friendly display name.').optional(), + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('issuing.personalization_design') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The physical bundle object belonging to this personalization design. */ + /**The physical bundle object belonging to this personalization design.*/ physical_bundle: z .union([z.string().max(5000), IssuingPhysicalBundleSchema]) .describe( @@ -27133,7 +25814,7 @@ export namespace stripe { ), preferences: IssuingPersonalizationDesignPreferencesSchema, rejection_reasons: IssuingPersonalizationDesignRejectionReasonsSchema, - /** Whether this personalization design can be used to create cards. */ + /**Whether this personalization design can be used to create cards.*/ status: z .enum(['active', 'inactive', 'rejected', 'review']) .describe( @@ -27147,14 +25828,14 @@ export namespace stripe { typeof IssuingPersonalizationDesignSchema > - /** FinancialAddresses contain identifying information that resolves to a FinancialAccount. */ + /**FinancialAddresses contain identifying information that resolves to a FinancialAccount.*/ export const FundingInstructionsBankTransferFinancialAddressSchema = z .object({ aba: FundingInstructionsBankTransferAbaRecordSchema.optional(), iban: FundingInstructionsBankTransferIbanRecordSchema.optional(), sort_code: FundingInstructionsBankTransferSortCodeRecordSchema.optional(), spei: FundingInstructionsBankTransferSpeiRecordSchema.optional(), - /** The payment networks supported by this FinancialAddress */ + /**The payment networks supported by this FinancialAddress*/ supported_networks: z .array( z.enum([ @@ -27171,7 +25852,7 @@ export namespace stripe { .describe('The payment networks supported by this FinancialAddress') .optional(), swift: FundingInstructionsBankTransferSwiftRecordSchema.optional(), - /** The type of financial address */ + /**The type of financial address*/ type: z .enum(['aba', 'iban', 'sort_code', 'spei', 'swift', 'zengin']) .describe('The type of financial address'), @@ -27184,35 +25865,33 @@ export namespace stripe { typeof FundingInstructionsBankTransferFinancialAddressSchema > - /** A Configurations object represents how features should be configured for terminal readers. */ + /**A Configurations object represents how features should be configured for terminal readers.*/ export const TerminalConfigurationSchema = z .object({ bbpos_wisepos_e: TerminalConfigurationConfigurationResourceDeviceTypeSpecificConfigSchema.optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Whether this Configuration is the default for your account */ + /**Whether this Configuration is the default for your account*/ is_account_default: z .boolean() - .nullable() .describe('Whether this Configuration is the default for your account') .optional(), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String indicating the name of the Configuration object, set by the user */ + /**String indicating the name of the Configuration object, set by the user*/ name: z .string() .max(5000) - .nullable() .describe( 'String indicating the name of the Configuration object, set by the user' ) .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('terminal.configuration') .describe( @@ -27238,40 +25917,33 @@ export namespace stripe { export const LegalEntityCompanySchema = z.object({ address: AddressSchema.optional(), - /** The Kana variation of the company's primary address (Japan only). */ - address_kana: LegalEntityJapanAddressSchema.nullable() - .describe( - "The Kana variation of the company's primary address (Japan only)." - ) - .optional(), - /** The Kanji variation of the company's primary address (Japan only). */ - address_kanji: LegalEntityJapanAddressSchema.nullable() - .describe( - "The Kanji variation of the company's primary address (Japan only)." - ) - .optional(), - /** Whether the company's directors have been provided. This Boolean will be `true` if you've manually indicated that all directors are provided via [the `directors_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-directors_provided). */ + /**The Kana variation of the company's primary address (Japan only).*/ + address_kana: LegalEntityJapanAddressSchema.describe( + "The Kana variation of the company's primary address (Japan only)." + ).optional(), + /**The Kanji variation of the company's primary address (Japan only).*/ + address_kanji: LegalEntityJapanAddressSchema.describe( + "The Kanji variation of the company's primary address (Japan only)." + ).optional(), + /**Whether the company's directors have been provided. This Boolean will be `true` if you've manually indicated that all directors are provided via [the `directors_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-directors_provided).*/ directors_provided: z .boolean() .describe( "Whether the company's directors have been provided. This Boolean will be `true` if you've manually indicated that all directors are provided via [the `directors_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-directors_provided)." ) .optional(), - /** This hash is used to attest that the director information provided to Stripe is both current and correct. */ - directorship_declaration: - LegalEntityDirectorshipDeclarationSchema.nullable() - .describe( - 'This hash is used to attest that the director information provided to Stripe is both current and correct.' - ) - .optional(), - /** Whether the company's executives have been provided. This Boolean will be `true` if you've manually indicated that all executives are provided via [the `executives_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-executives_provided), or if Stripe determined that sufficient executives were provided. */ + /**This hash is used to attest that the director information provided to Stripe is both current and correct.*/ + directorship_declaration: LegalEntityDirectorshipDeclarationSchema.describe( + 'This hash is used to attest that the director information provided to Stripe is both current and correct.' + ).optional(), + /**Whether the company's executives have been provided. This Boolean will be `true` if you've manually indicated that all executives are provided via [the `executives_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-executives_provided), or if Stripe determined that sufficient executives were provided.*/ executives_provided: z .boolean() .describe( "Whether the company's executives have been provided. This Boolean will be `true` if you've manually indicated that all executives are provided via [the `executives_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-executives_provided), or if Stripe determined that sufficient executives were provided." ) .optional(), - /** The export license ID number of the company, also referred as Import Export Code (India only). */ + /**The export license ID number of the company, also referred as Import Export Code (India only).*/ export_license_id: z .string() .max(5000) @@ -27279,60 +25951,50 @@ export namespace stripe { 'The export license ID number of the company, also referred as Import Export Code (India only).' ) .optional(), - /** The purpose code to use for export transactions (India only). */ + /**The purpose code to use for export transactions (India only).*/ export_purpose_code: z .string() .max(5000) .describe('The purpose code to use for export transactions (India only).') .optional(), - /** The company's legal name. */ - name: z - .string() - .max(5000) - .nullable() - .describe("The company's legal name.") - .optional(), - /** The Kana variation of the company's legal name (Japan only). */ + /**The company's legal name.*/ + name: z.string().max(5000).describe("The company's legal name.").optional(), + /**The Kana variation of the company's legal name (Japan only).*/ name_kana: z .string() .max(5000) - .nullable() .describe("The Kana variation of the company's legal name (Japan only).") .optional(), - /** The Kanji variation of the company's legal name (Japan only). */ + /**The Kanji variation of the company's legal name (Japan only).*/ name_kanji: z .string() .max(5000) - .nullable() .describe("The Kanji variation of the company's legal name (Japan only).") .optional(), - /** Whether the company's owners have been provided. This Boolean will be `true` if you've manually indicated that all owners are provided via [the `owners_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-owners_provided), or if Stripe determined that sufficient owners were provided. Stripe determines ownership requirements using both the number of owners provided and their total percent ownership (calculated by adding the `percent_ownership` of each owner together). */ + /**Whether the company's owners have been provided. This Boolean will be `true` if you've manually indicated that all owners are provided via [the `owners_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-owners_provided), or if Stripe determined that sufficient owners were provided. Stripe determines ownership requirements using both the number of owners provided and their total percent ownership (calculated by adding the `percent_ownership` of each owner together).*/ owners_provided: z .boolean() .describe( "Whether the company's owners have been provided. This Boolean will be `true` if you've manually indicated that all owners are provided via [the `owners_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-owners_provided), or if Stripe determined that sufficient owners were provided. Stripe determines ownership requirements using both the number of owners provided and their total percent ownership (calculated by adding the `percent_ownership` of each owner together)." ) .optional(), - /** This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct. */ - ownership_declaration: LegalEntityUboDeclarationSchema.nullable() - .describe( - 'This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.' - ) - .optional(), + /**This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.*/ + ownership_declaration: LegalEntityUboDeclarationSchema.describe( + 'This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.' + ).optional(), ownership_exemption_reason: z .enum([ 'qualified_entity_exceeds_ownership_threshold', 'qualifies_as_financial_institution' ]) .optional(), - /** The company's phone number (used for verification). */ + /**The company's phone number (used for verification).*/ phone: z .string() .max(5000) - .nullable() .describe("The company's phone number (used for verification).") .optional(), - /** The category identifying the legal structure of the company or legal entity. See [Business structure](https://stripe.com/docs/connect/identity-verification#business-structure) for more details. */ + /**The category identifying the legal structure of the company or legal entity. See [Business structure](https://stripe.com/docs/connect/identity-verification#business-structure) for more details.*/ structure: z .enum([ 'free_zone_establishment', @@ -27363,12 +26025,12 @@ export namespace stripe { 'The category identifying the legal structure of the company or legal entity. See [Business structure](https://stripe.com/docs/connect/identity-verification#business-structure) for more details.' ) .optional(), - /** Whether the company's business ID number was provided. */ + /**Whether the company's business ID number was provided.*/ tax_id_provided: z .boolean() .describe("Whether the company's business ID number was provided.") .optional(), - /** The jurisdiction in which the `tax_id` is registered (Germany-based companies only). */ + /**The jurisdiction in which the `tax_id` is registered (Germany-based companies only).*/ tax_id_registrar: z .string() .max(5000) @@ -27376,242 +26038,215 @@ export namespace stripe { 'The jurisdiction in which the `tax_id` is registered (Germany-based companies only).' ) .optional(), - /** Whether the company's business VAT number was provided. */ + /**Whether the company's business VAT number was provided.*/ vat_id_provided: z .boolean() .describe("Whether the company's business VAT number was provided.") .optional(), - /** Information on the verification state of the company. */ - verification: LegalEntityCompanyVerificationSchema.nullable() - .describe('Information on the verification state of the company.') - .optional() + /**Information on the verification state of the company.*/ + verification: LegalEntityCompanyVerificationSchema.describe( + 'Information on the verification state of the company.' + ).optional() }) export type LegalEntityCompany = z.infer export const DisputeEvidenceSchema = z.object({ - /** Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product. This information should include IP addresses, corresponding timestamps, and any detailed recorded activity. */ + /**Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product. This information should include IP addresses, corresponding timestamps, and any detailed recorded activity.*/ access_activity_log: z .string() .max(150_000) - .nullable() .describe( 'Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product. This information should include IP addresses, corresponding timestamps, and any detailed recorded activity.' ) .optional(), - /** The billing address provided by the customer. */ + /**The billing address provided by the customer.*/ billing_address: z .string() .max(5000) - .nullable() .describe('The billing address provided by the customer.') .optional(), - /** (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer. */ + /**(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer.*/ cancellation_policy: z .union([z.string().max(5000), FileSchema]) - .nullable() .describe( '(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer.' ) .optional(), - /** An explanation of how and when the customer was shown your refund policy prior to purchase. */ + /**An explanation of how and when the customer was shown your refund policy prior to purchase.*/ cancellation_policy_disclosure: z .string() .max(150_000) - .nullable() .describe( 'An explanation of how and when the customer was shown your refund policy prior to purchase.' ) .optional(), - /** A justification for why the customer's subscription was not canceled. */ + /**A justification for why the customer's subscription was not canceled.*/ cancellation_rebuttal: z .string() .max(150_000) - .nullable() .describe( "A justification for why the customer's subscription was not canceled." ) .optional(), - /** (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any communication with the customer that you feel is relevant to your case. Examples include emails proving that the customer received the product or service, or demonstrating their use of or satisfaction with the product or service. */ + /**(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any communication with the customer that you feel is relevant to your case. Examples include emails proving that the customer received the product or service, or demonstrating their use of or satisfaction with the product or service.*/ customer_communication: z .union([z.string().max(5000), FileSchema]) - .nullable() .describe( '(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any communication with the customer that you feel is relevant to your case. Examples include emails proving that the customer received the product or service, or demonstrating their use of or satisfaction with the product or service.' ) .optional(), - /** The email address of the customer. */ + /**The email address of the customer.*/ customer_email_address: z .string() .max(5000) - .nullable() .describe('The email address of the customer.') .optional(), - /** The name of the customer. */ + /**The name of the customer.*/ customer_name: z .string() .max(5000) - .nullable() .describe('The name of the customer.') .optional(), - /** The IP address that the customer used when making the purchase. */ + /**The IP address that the customer used when making the purchase.*/ customer_purchase_ip: z .string() .max(5000) - .nullable() .describe( 'The IP address that the customer used when making the purchase.' ) .optional(), - /** (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature. */ + /**(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature.*/ customer_signature: z .union([z.string().max(5000), FileSchema]) - .nullable() .describe( "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature." ) .optional(), - /** (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation for the prior charge that can uniquely identify the charge, such as a receipt, shipping label, work order, etc. This document should be paired with a similar document from the disputed payment that proves the two payments are separate. */ + /**(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation for the prior charge that can uniquely identify the charge, such as a receipt, shipping label, work order, etc. This document should be paired with a similar document from the disputed payment that proves the two payments are separate.*/ duplicate_charge_documentation: z .union([z.string().max(5000), FileSchema]) - .nullable() .describe( '(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation for the prior charge that can uniquely identify the charge, such as a receipt, shipping label, work order, etc. This document should be paired with a similar document from the disputed payment that proves the two payments are separate.' ) .optional(), - /** An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate. */ + /**An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate.*/ duplicate_charge_explanation: z .string() .max(150_000) - .nullable() .describe( 'An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate.' ) .optional(), - /** The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge. */ + /**The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge.*/ duplicate_charge_id: z .string() .max(5000) - .nullable() .describe( 'The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge.' ) .optional(), enhanced_evidence: DisputeEnhancedEvidenceSchema, - /** A description of the product or service that was sold. */ + /**A description of the product or service that was sold.*/ product_description: z .string() .max(150_000) - .nullable() .describe('A description of the product or service that was sold.') .optional(), - /** (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any receipt or message sent to the customer notifying them of the charge. */ + /**(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any receipt or message sent to the customer notifying them of the charge.*/ receipt: z .union([z.string().max(5000), FileSchema]) - .nullable() .describe( '(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any receipt or message sent to the customer notifying them of the charge.' ) .optional(), - /** (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer. */ + /**(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer.*/ refund_policy: z .union([z.string().max(5000), FileSchema]) - .nullable() .describe( '(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer.' ) .optional(), - /** Documentation demonstrating that the customer was shown your refund policy prior to purchase. */ + /**Documentation demonstrating that the customer was shown your refund policy prior to purchase.*/ refund_policy_disclosure: z .string() .max(150_000) - .nullable() .describe( 'Documentation demonstrating that the customer was shown your refund policy prior to purchase.' ) .optional(), - /** A justification for why the customer is not entitled to a refund. */ + /**A justification for why the customer is not entitled to a refund.*/ refund_refusal_explanation: z .string() .max(150_000) - .nullable() .describe( 'A justification for why the customer is not entitled to a refund.' ) .optional(), - /** The date on which the customer received or began receiving the purchased service, in a clear human-readable format. */ + /**The date on which the customer received or began receiving the purchased service, in a clear human-readable format.*/ service_date: z .string() .max(5000) - .nullable() .describe( 'The date on which the customer received or began receiving the purchased service, in a clear human-readable format.' ) .optional(), - /** (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a service was provided to the customer. This could include a copy of a signed contract, work order, or other form of written agreement. */ + /**(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a service was provided to the customer. This could include a copy of a signed contract, work order, or other form of written agreement.*/ service_documentation: z .union([z.string().max(5000), FileSchema]) - .nullable() .describe( '(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a service was provided to the customer. This could include a copy of a signed contract, work order, or other form of written agreement.' ) .optional(), - /** The address to which a physical product was shipped. You should try to include as complete address information as possible. */ + /**The address to which a physical product was shipped. You should try to include as complete address information as possible.*/ shipping_address: z .string() .max(5000) - .nullable() .describe( 'The address to which a physical product was shipped. You should try to include as complete address information as possible.' ) .optional(), - /** The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. If multiple carriers were used for this purchase, please separate them with commas. */ + /**The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. If multiple carriers were used for this purchase, please separate them with commas.*/ shipping_carrier: z .string() .max(5000) - .nullable() .describe( 'The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. If multiple carriers were used for this purchase, please separate them with commas.' ) .optional(), - /** The date on which a physical product began its route to the shipping address, in a clear human-readable format. */ + /**The date on which a physical product began its route to the shipping address, in a clear human-readable format.*/ shipping_date: z .string() .max(5000) - .nullable() .describe( 'The date on which a physical product began its route to the shipping address, in a clear human-readable format.' ) .optional(), - /** (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a product was shipped to the customer at the same address the customer provided to you. This could include a copy of the shipment receipt, shipping label, etc. It should show the customer's full shipping address, if possible. */ + /**(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a product was shipped to the customer at the same address the customer provided to you. This could include a copy of the shipment receipt, shipping label, etc. It should show the customer's full shipping address, if possible.*/ shipping_documentation: z .union([z.string().max(5000), FileSchema]) - .nullable() .describe( "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a product was shipped to the customer at the same address the customer provided to you. This could include a copy of the shipment receipt, shipping label, etc. It should show the customer's full shipping address, if possible." ) .optional(), - /** The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas. */ + /**The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.*/ shipping_tracking_number: z .string() .max(5000) - .nullable() .describe( 'The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.' ) .optional(), - /** (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements. */ + /**(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements.*/ uncategorized_file: z .union([z.string().max(5000), FileSchema]) - .nullable() .describe( '(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements.' ) .optional(), - /** Any additional evidence or statements. */ + /**Any additional evidence or statements.*/ uncategorized_text: z .string() .max(150_000) - .nullable() .describe('Any additional evidence or statements.') .optional() }) @@ -27621,11 +26256,10 @@ export namespace stripe { amex_express_checkout: PaymentMethodDetailsCardWalletAmexExpressCheckoutSchema.optional(), apple_pay: PaymentMethodDetailsCardWalletApplePaySchema.optional(), - /** (For tokenized numbers only.) The last four digits of the device account number. */ + /**(For tokenized numbers only.) The last four digits of the device account number.*/ dynamic_last4: z .string() .max(5000) - .nullable() .describe( '(For tokenized numbers only.) The last four digits of the device account number.' ) @@ -27634,7 +26268,7 @@ export namespace stripe { link: PaymentMethodDetailsCardWalletLinkSchema.optional(), masterpass: PaymentMethodDetailsCardWalletMasterpassSchema.optional(), samsung_pay: PaymentMethodDetailsCardWalletSamsungPaySchema.optional(), - /** The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, `visa_checkout`, or `link`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type. */ + /**The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, `visa_checkout`, or `link`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.*/ type: z .enum([ 'amex_express_checkout', @@ -27656,49 +26290,45 @@ export namespace stripe { export const PaymentIntentNextActionDisplayBankTransferInstructionsSchema = z.object({ - /** The remaining amount that needs to be transferred to complete the payment. */ + /**The remaining amount that needs to be transferred to complete the payment.*/ amount_remaining: z .number() .int() - .nullable() .describe( 'The remaining amount that needs to be transferred to complete the payment.' ) .optional(), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() - .nullable() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ) .optional(), - /** A list of financial addresses that can be used to fund the customer balance */ + /**A list of financial addresses that can be used to fund the customer balance*/ financial_addresses: z .array(FundingInstructionsBankTransferFinancialAddressSchema) .describe( 'A list of financial addresses that can be used to fund the customer balance' ) .optional(), - /** A link to a hosted page that guides your customer through completing the transfer. */ + /**A link to a hosted page that guides your customer through completing the transfer.*/ hosted_instructions_url: z .string() .max(5000) - .nullable() .describe( 'A link to a hosted page that guides your customer through completing the transfer.' ) .optional(), - /** A string identifying this payment. Instruct your customer to include this code in the reference or memo field of their bank transfer. */ + /**A string identifying this payment. Instruct your customer to include this code in the reference or memo field of their bank transfer.*/ reference: z .string() .max(5000) - .nullable() .describe( 'A string identifying this payment. Instruct your customer to include this code in the reference or memo field of their bank transfer.' ) .optional(), - /** Type of bank transfer */ + /**Type of bank transfer*/ type: z .enum([ 'eu_bank_transfer', @@ -27717,11 +26347,10 @@ export namespace stripe { amex_express_checkout: PaymentMethodCardWalletAmexExpressCheckoutSchema.optional(), apple_pay: PaymentMethodCardWalletApplePaySchema.optional(), - /** (For tokenized numbers only.) The last four digits of the device account number. */ + /**(For tokenized numbers only.) The last four digits of the device account number.*/ dynamic_last4: z .string() .max(5000) - .nullable() .describe( '(For tokenized numbers only.) The last four digits of the device account number.' ) @@ -27730,7 +26359,7 @@ export namespace stripe { link: PaymentMethodCardWalletLinkSchema.optional(), masterpass: PaymentMethodCardWalletMasterpassSchema.optional(), samsung_pay: PaymentMethodCardWalletSamsungPaySchema.optional(), - /** The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, `visa_checkout`, or `link`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type. */ + /**The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, `visa_checkout`, or `link`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.*/ type: z .enum([ 'amex_express_checkout', @@ -27751,18 +26380,18 @@ export namespace stripe { > export const FundingInstructionsBankTransferSchema = z.object({ - /** The country of the bank account to fund */ + /**The country of the bank account to fund*/ country: z .string() .max(5000) .describe('The country of the bank account to fund'), - /** A list of financial addresses that can be used to fund a particular balance */ + /**A list of financial addresses that can be used to fund a particular balance*/ financial_addresses: z .array(FundingInstructionsBankTransferFinancialAddressSchema) .describe( 'A list of financial addresses that can be used to fund a particular balance' ), - /** The bank_transfer type */ + /**The bank_transfer type*/ type: z .enum(['eu_bank_transfer', 'jp_bank_transfer']) .describe('The bank_transfer type') @@ -27778,120 +26407,114 @@ export namespace stripe { */ export const TaxTransactionSchema = z .object({ - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .max(5000) .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource. */ + /**The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource.*/ customer: z .string() .max(5000) - .nullable() .describe( 'The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource.' ) .optional(), customer_details: TaxProductResourceCustomerDetailsSchema, - /** Unique identifier for the transaction. */ + /**Unique identifier for the transaction.*/ id: z .string() .max(5000) .describe('Unique identifier for the transaction.'), - /** The tax collected or refunded, by line item. */ + /**The tax collected or refunded, by line item.*/ line_items: z .object({ - /** Details about each object. */ + /**Details about each object.*/ data: z .array(TaxTransactionLineItemSchema) .describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/tax/transactions/[^/]+/line_items')) .max(5000) .describe('The URL where this list can be accessed.') }) - .nullable() .describe('The tax collected or refunded, by line item.') .optional(), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) - .nullable() .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ) .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('tax.transaction') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The Unix timestamp representing when the tax liability is assumed or reduced. */ + /**The Unix timestamp representing when the tax liability is assumed or reduced.*/ posted_at: z .number() .int() .describe( 'The Unix timestamp representing when the tax liability is assumed or reduced.' ), - /** A custom unique identifier, such as 'myOrder_123'. */ + /**A custom unique identifier, such as 'myOrder_123'.*/ reference: z .string() .max(5000) .describe("A custom unique identifier, such as 'myOrder_123'."), - /** If `type=reversal`, contains information about what was reversed. */ - reversal: - TaxProductResourceTaxTransactionResourceReversalSchema.nullable() - .describe( - 'If `type=reversal`, contains information about what was reversed.' - ) - .optional(), - /** The details of the ship from location, such as the address. */ - ship_from_details: TaxProductResourceShipFromDetailsSchema.nullable() - .describe('The details of the ship from location, such as the address.') - .optional(), - /** The shipping cost details for the transaction. */ + /**If `type=reversal`, contains information about what was reversed.*/ + reversal: TaxProductResourceTaxTransactionResourceReversalSchema.describe( + 'If `type=reversal`, contains information about what was reversed.' + ).optional(), + /**The details of the ship from location, such as the address.*/ + ship_from_details: TaxProductResourceShipFromDetailsSchema.describe( + 'The details of the ship from location, such as the address.' + ).optional(), + /**The shipping cost details for the transaction.*/ shipping_cost: - TaxProductResourceTaxTransactionShippingCostSchema.nullable() - .describe('The shipping cost details for the transaction.') - .optional(), - /** Timestamp of date at which the tax rules and rates in effect applies for the calculation. */ + TaxProductResourceTaxTransactionShippingCostSchema.describe( + 'The shipping cost details for the transaction.' + ).optional(), + /**Timestamp of date at which the tax rules and rates in effect applies for the calculation.*/ tax_date: z .number() .int() .describe( 'Timestamp of date at which the tax rules and rates in effect applies for the calculation.' ), - /** If `reversal`, this transaction reverses an earlier transaction. */ + /**If `reversal`, this transaction reverses an earlier transaction.*/ type: z .enum(['reversal', 'transaction']) .describe( @@ -27904,30 +26527,29 @@ export namespace stripe { export type TaxTransaction = z.infer export const InvoicesResourceShippingCostSchema = z.object({ - /** Total shipping cost before any taxes are applied. */ + /**Total shipping cost before any taxes are applied.*/ amount_subtotal: z .number() .int() .describe('Total shipping cost before any taxes are applied.'), - /** Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0. */ + /**Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.*/ amount_tax: z .number() .int() .describe( 'Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.' ), - /** Total shipping cost after taxes are applied. */ + /**Total shipping cost after taxes are applied.*/ amount_total: z .number() .int() .describe('Total shipping cost after taxes are applied.'), - /** The ID of the ShippingRate for this invoice. */ + /**The ID of the ShippingRate for this invoice.*/ shipping_rate: z .union([z.string().max(5000), ShippingRateSchema]) - .nullable() .describe('The ID of the ShippingRate for this invoice.') .optional(), - /** The taxes applied to the shipping rate. */ + /**The taxes applied to the shipping rate.*/ taxes: z .array(LineItemsTaxAmountSchema) .describe('The taxes applied to the shipping rate.') @@ -27947,32 +26569,31 @@ export namespace stripe { export type PortalFeatures = z.infer export const PaymentPagesCheckoutSessionShippingCostSchema = z.object({ - /** Total shipping cost before any discounts or taxes are applied. */ + /**Total shipping cost before any discounts or taxes are applied.*/ amount_subtotal: z .number() .int() .describe( 'Total shipping cost before any discounts or taxes are applied.' ), - /** Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0. */ + /**Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.*/ amount_tax: z .number() .int() .describe( 'Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.' ), - /** Total shipping cost after discounts and taxes are applied. */ + /**Total shipping cost after discounts and taxes are applied.*/ amount_total: z .number() .int() .describe('Total shipping cost after discounts and taxes are applied.'), - /** The ID of the ShippingRate for this order. */ + /**The ID of the ShippingRate for this order.*/ shipping_rate: z .union([z.string().max(5000), ShippingRateSchema]) - .nullable() .describe('The ID of the ShippingRate for this order.') .optional(), - /** The taxes applied to the shipping rate. */ + /**The taxes applied to the shipping rate.*/ taxes: z .array(LineItemsTaxAmountSchema) .describe('The taxes applied to the shipping rate.') @@ -27992,24 +26613,24 @@ export namespace stripe { export const FundingInstructionsSchema = z .object({ bank_transfer: FundingInstructionsBankTransferSchema, - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .max(5000) .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** The `funding_type` of the returned instructions */ + /**The `funding_type` of the returned instructions*/ funding_type: z .literal('bank_transfer') .describe('The `funding_type` of the returned instructions'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('funding_instructions') .describe( @@ -28037,7 +26658,7 @@ export namespace stripe { TreasuryFinancialAccountsResourceInboundTransfersSchema.optional(), intra_stripe_flows: TreasuryFinancialAccountsResourceToggleSettingsSchema.optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('treasury.financial_account_features') .describe( @@ -28065,7 +26686,7 @@ export namespace stripe { IssuingDisputeNoValidAuthorizationEvidenceSchema.optional(), not_received: IssuingDisputeNotReceivedEvidenceSchema.optional(), other: IssuingDisputeOtherEvidenceSchema.optional(), - /** The reason for filing the dispute. Its value will match the field containing the evidence. */ + /**The reason for filing the dispute. Its value will match the field containing the evidence.*/ reason: z .enum([ 'canceled', @@ -28097,136 +26718,124 @@ export namespace stripe { */ export const PriceSchema = z .object({ - /** Whether the price can be used for new purchases. */ + /**Whether the price can be used for new purchases.*/ active: z .boolean() .describe('Whether the price can be used for new purchases.'), - /** Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes. */ + /**Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.*/ billing_scheme: z .enum(['per_unit', 'tiered']) .describe( 'Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.' ), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). */ + /**Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).*/ currency_options: z .record(CurrencyOptionSchema) .describe( 'Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).' ) .optional(), - /** When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links. */ - custom_unit_amount: CustomUnitAmountSchema.nullable() - .describe( - 'When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.' - ) - .optional(), - /** Unique identifier for the object. */ + /**When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.*/ + custom_unit_amount: CustomUnitAmountSchema.describe( + 'When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.' + ).optional(), + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. */ + /**A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.*/ lookup_key: z .string() .max(5000) - .nullable() .describe( 'A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.' ) .optional(), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ), - /** A brief description of the price, hidden from customers. */ + /**A brief description of the price, hidden from customers.*/ nickname: z .string() .max(5000) - .nullable() .describe('A brief description of the price, hidden from customers.') .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('price') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The ID of the product this price is associated with. */ + /**The ID of the product this price is associated with.*/ product: z .union([z.string().max(5000), ProductSchema, DeletedProductSchema]) .describe('The ID of the product this price is associated with.'), - /** The recurring components of a price such as `interval` and `usage_type`. */ - recurring: RecurringSchema.nullable() - .describe( - 'The recurring components of a price such as `interval` and `usage_type`.' - ) - .optional(), - /** Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. */ + /**The recurring components of a price such as `interval` and `usage_type`.*/ + recurring: RecurringSchema.describe( + 'The recurring components of a price such as `interval` and `usage_type`.' + ).optional(), + /**Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.*/ tax_behavior: z .enum(['exclusive', 'inclusive', 'unspecified']) - .nullable() .describe( 'Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.' ) .optional(), - /** Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ + /**Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.*/ tiers: z .array(PriceTierSchema) .describe( 'Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.' ) .optional(), - /** Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows. */ + /**Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows.*/ tiers_mode: z .enum(['graduated', 'volume']) - .nullable() .describe( 'Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows.' ) .optional(), - /** Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`. */ - transform_quantity: TransformQuantitySchema.nullable() - .describe( - 'Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.' - ) - .optional(), - /** One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase. */ + /**Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.*/ + transform_quantity: TransformQuantitySchema.describe( + 'Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.' + ).optional(), + /**One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.*/ type: z .enum(['one_time', 'recurring']) .describe( 'One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.' ), - /** The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. */ + /**The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.*/ unit_amount: z .number() .int() - .nullable() .describe( 'The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.' ) .optional(), - /** The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. */ + /**The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.*/ unit_amount_decimal: z .string() - .nullable() .describe( 'The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.' ) @@ -28249,121 +26858,114 @@ export namespace stripe { */ export const ProductSchema = z .object({ - /** Whether the product is currently available for purchase. */ + /**Whether the product is currently available for purchase.*/ active: z .boolean() .describe('Whether the product is currently available for purchase.'), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product. */ + /**The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product.*/ default_price: z .union([z.string().max(5000), PriceSchema]) - .nullable() .describe( 'The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product.' ) .optional(), - /** The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes. */ + /**The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.*/ description: z .string() .max(5000) - .nullable() .describe( "The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes." ) .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** A list of up to 8 URLs of images for this product, meant to be displayable to the customer. */ + /**A list of up to 8 URLs of images for this product, meant to be displayable to the customer.*/ images: z .array(z.string().max(5000)) .describe( 'A list of up to 8 URLs of images for this product, meant to be displayable to the customer.' ), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table). */ + /**A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).*/ marketing_features: z .array(ProductMarketingFeatureSchema) .describe( 'A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ), - /** The product's name, meant to be displayable to the customer. */ + /**The product's name, meant to be displayable to the customer.*/ name: z .string() .max(5000) .describe( "The product's name, meant to be displayable to the customer." ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('product') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The dimensions of this product for shipping purposes. */ - package_dimensions: PackageDimensionsSchema.nullable() - .describe('The dimensions of this product for shipping purposes.') - .optional(), - /** Whether this product is shipped (i.e., physical goods). */ + /**The dimensions of this product for shipping purposes.*/ + package_dimensions: PackageDimensionsSchema.describe( + 'The dimensions of this product for shipping purposes.' + ).optional(), + /**Whether this product is shipped (i.e., physical goods).*/ shippable: z .boolean() - .nullable() .describe('Whether this product is shipped (i.e., physical goods).') .optional(), - /** Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments. */ + /**Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments.*/ statement_descriptor: z .string() .max(5000) - .nullable() .describe( "Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments." ) .optional(), - /** A [tax code](https://stripe.com/docs/tax/tax-categories) ID. */ + /**A [tax code](https://stripe.com/docs/tax/tax-categories) ID.*/ tax_code: z .union([z.string().max(5000), TaxCodeSchema]) - .nullable() .describe( 'A [tax code](https://stripe.com/docs/tax/tax-categories) ID.' ) .optional(), - /** A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. */ + /**A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.*/ unit_label: z .string() .max(5000) - .nullable() .describe( "A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal." ) .optional(), - /** Time at which the object was last updated. Measured in seconds since the Unix epoch. */ + /**Time at which the object was last updated. Measured in seconds since the Unix epoch.*/ updated: z .number() .int() .describe( 'Time at which the object was last updated. Measured in seconds since the Unix epoch.' ), - /** A URL of a publicly-accessible webpage for this product. */ + /**A URL of a publicly-accessible webpage for this product.*/ url: z .string() .max(2048) - .nullable() .describe('A URL of a publicly-accessible webpage for this product.') .optional() }) @@ -28374,20 +26976,20 @@ export namespace stripe { export const PortalFlowsFlowSchema = z.object({ after_completion: PortalFlowsFlowAfterCompletionSchema, - /** Configuration when `flow.type=subscription_cancel`. */ - subscription_cancel: PortalFlowsFlowSubscriptionCancelSchema.nullable() - .describe('Configuration when `flow.type=subscription_cancel`.') - .optional(), - /** Configuration when `flow.type=subscription_update`. */ - subscription_update: PortalFlowsFlowSubscriptionUpdateSchema.nullable() - .describe('Configuration when `flow.type=subscription_update`.') - .optional(), - /** Configuration when `flow.type=subscription_update_confirm`. */ + /**Configuration when `flow.type=subscription_cancel`.*/ + subscription_cancel: PortalFlowsFlowSubscriptionCancelSchema.describe( + 'Configuration when `flow.type=subscription_cancel`.' + ).optional(), + /**Configuration when `flow.type=subscription_update`.*/ + subscription_update: PortalFlowsFlowSubscriptionUpdateSchema.describe( + 'Configuration when `flow.type=subscription_update`.' + ).optional(), + /**Configuration when `flow.type=subscription_update_confirm`.*/ subscription_update_confirm: - PortalFlowsFlowSubscriptionUpdateConfirmSchema.nullable() - .describe('Configuration when `flow.type=subscription_update_confirm`.') - .optional(), - /** Type of flow that the customer will go through. */ + PortalFlowsFlowSubscriptionUpdateConfirmSchema.describe( + 'Configuration when `flow.type=subscription_update_confirm`.' + ).optional(), + /**Type of flow that the customer will go through.*/ type: z .enum([ 'payment_method_update', @@ -28400,41 +27002,31 @@ export namespace stripe { export type PortalFlowsFlow = z.infer export const IssuingTransactionPurchaseDetailsSchema = z.object({ - /** Fleet-specific information for transactions using Fleet cards. */ - fleet: IssuingTransactionFleetDataSchema.nullable() - .describe( - 'Fleet-specific information for transactions using Fleet cards.' - ) - .optional(), - /** Information about the flight that was purchased with this transaction. */ - flight: IssuingTransactionFlightDataSchema.nullable() - .describe( - 'Information about the flight that was purchased with this transaction.' - ) - .optional(), - /** Information about fuel that was purchased with this transaction. */ - fuel: IssuingTransactionFuelDataSchema.nullable() - .describe( - 'Information about fuel that was purchased with this transaction.' - ) - .optional(), - /** Information about lodging that was purchased with this transaction. */ - lodging: IssuingTransactionLodgingDataSchema.nullable() - .describe( - 'Information about lodging that was purchased with this transaction.' - ) - .optional(), - /** The line items in the purchase. */ + /**Fleet-specific information for transactions using Fleet cards.*/ + fleet: IssuingTransactionFleetDataSchema.describe( + 'Fleet-specific information for transactions using Fleet cards.' + ).optional(), + /**Information about the flight that was purchased with this transaction.*/ + flight: IssuingTransactionFlightDataSchema.describe( + 'Information about the flight that was purchased with this transaction.' + ).optional(), + /**Information about fuel that was purchased with this transaction.*/ + fuel: IssuingTransactionFuelDataSchema.describe( + 'Information about fuel that was purchased with this transaction.' + ).optional(), + /**Information about lodging that was purchased with this transaction.*/ + lodging: IssuingTransactionLodgingDataSchema.describe( + 'Information about lodging that was purchased with this transaction.' + ).optional(), + /**The line items in the purchase.*/ receipt: z .array(IssuingTransactionReceiptDataSchema) - .nullable() .describe('The line items in the purchase.') .optional(), - /** A merchant-specific order number. */ + /**A merchant-specific order number.*/ reference: z .string() .max(5000) - .nullable() .describe('A merchant-specific order number.') .optional() }) @@ -28541,115 +27133,111 @@ export namespace stripe { */ export const TaxCalculationSchema = z .object({ - /** Total amount after taxes in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /**Total amount after taxes in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).*/ amount_total: z .number() .int() .describe( 'Total amount after taxes in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .max(5000) .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource. */ + /**The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource.*/ customer: z .string() .max(5000) - .nullable() .describe( 'The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource.' ) .optional(), customer_details: TaxProductResourceCustomerDetailsSchema, - /** Timestamp of date at which the tax calculation will expire. */ + /**Timestamp of date at which the tax calculation will expire.*/ expires_at: z .number() .int() - .nullable() .describe('Timestamp of date at which the tax calculation will expire.') .optional(), - /** Unique identifier for the calculation. */ + /**Unique identifier for the calculation.*/ id: z .string() .max(5000) - .nullable() .describe('Unique identifier for the calculation.') .optional(), - /** The list of items the customer is purchasing. */ + /**The list of items the customer is purchasing.*/ line_items: z .object({ - /** Details about each object. */ + /**Details about each object.*/ data: z .array(TaxCalculationLineItemSchema) .describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/tax/calculations/[^/]+/line_items')) .max(5000) .describe('The URL where this list can be accessed.') }) - .nullable() .describe('The list of items the customer is purchasing.') .optional(), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('tax.calculation') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The details of the ship from location, such as the address. */ - ship_from_details: TaxProductResourceShipFromDetailsSchema.nullable() - .describe('The details of the ship from location, such as the address.') - .optional(), - /** The shipping cost details for the calculation. */ + /**The details of the ship from location, such as the address.*/ + ship_from_details: TaxProductResourceShipFromDetailsSchema.describe( + 'The details of the ship from location, such as the address.' + ).optional(), + /**The shipping cost details for the calculation.*/ shipping_cost: - TaxProductResourceTaxCalculationShippingCostSchema.nullable() - .describe('The shipping cost details for the calculation.') - .optional(), - /** The amount of tax to be collected on top of the line item prices. */ + TaxProductResourceTaxCalculationShippingCostSchema.describe( + 'The shipping cost details for the calculation.' + ).optional(), + /**The amount of tax to be collected on top of the line item prices.*/ tax_amount_exclusive: z .number() .int() .describe( 'The amount of tax to be collected on top of the line item prices.' ), - /** The amount of tax already included in the line item prices. */ + /**The amount of tax already included in the line item prices.*/ tax_amount_inclusive: z .number() .int() .describe( 'The amount of tax already included in the line item prices.' ), - /** Breakdown of individual tax amounts that add up to the total. */ + /**Breakdown of individual tax amounts that add up to the total.*/ tax_breakdown: z .array(TaxProductResourceTaxBreakdownSchema) .describe( 'Breakdown of individual tax amounts that add up to the total.' ), - /** Timestamp of date at which the tax rules and rates in effect applies for the calculation. */ + /**Timestamp of date at which the tax rules and rates in effect applies for the calculation.*/ tax_date: z .number() .int() @@ -28671,14 +27259,14 @@ export namespace stripe { */ export const TaxRegistrationSchema = z .object({ - /** Time at which the registration becomes active. Measured in seconds since the Unix epoch. */ + /**Time at which the registration becomes active. Measured in seconds since the Unix epoch.*/ active_from: z .number() .int() .describe( 'Time at which the registration becomes active. Measured in seconds since the Unix epoch.' ), - /** Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ + /**Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).*/ country: z .string() .max(5000) @@ -28686,37 +27274,36 @@ export namespace stripe { 'Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).' ), country_options: TaxProductRegistrationsResourceCountryOptionsSchema, - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. Measured in seconds since the Unix epoch. */ + /**If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. Measured in seconds since the Unix epoch.*/ expires_at: z .number() .int() - .nullable() .describe( 'If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. Measured in seconds since the Unix epoch.' ) .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('tax.registration') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The status of the registration. This field is present for convenience and can be deduced from `active_from` and `expires_at`. */ + /**The status of the registration. This field is present for convenience and can be deduced from `active_from` and `expires_at`.*/ status: z .enum(['active', 'expired', 'scheduled']) .describe( @@ -28741,7 +27328,7 @@ export namespace stripe { paypal: MandatePaypalSchema.optional(), revolut_pay: MandateRevolutPaySchema.optional(), sepa_debit: MandateSepaDebitSchema.optional(), - /** This mandate corresponds with a specific payment method type. The `payment_method_details` includes an additional hash with the same name and contains mandate information that's specific to that payment method. */ + /**This mandate corresponds with a specific payment method type. The `payment_method_details` includes an additional hash with the same name and contains mandate information that's specific to that payment method.*/ type: z .string() .max(5000) @@ -28783,7 +27370,7 @@ export namespace stripe { sofort: DestinationDetailsUnimplementedSchema.optional(), swish: RefundDestinationDetailsSwishSchema.optional(), th_bank_transfer: RefundDestinationDetailsThBankTransferSchema.optional(), - /** The type of transaction-specific details of the payment method used in the refund (e.g., `card`). An additional hash is included on `destination_details` with a name matching this value. It contains information specific to the refund transaction. */ + /**The type of transaction-specific details of the payment method used in the refund (e.g., `card`). An additional hash is included on `destination_details` with a name matching this value. It contains information specific to the refund transaction.*/ type: z .string() .max(5000) @@ -28799,98 +27386,68 @@ export namespace stripe { > export const SubscriptionsResourcePaymentMethodOptionsSchema = z.object({ - /** This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to invoices created by the subscription. */ - acss_debit: InvoicePaymentMethodOptionsAcssDebitSchema.nullable() - .describe( - 'This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to invoices created by the subscription.' - ) - .optional(), - /** This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription. */ - bancontact: InvoicePaymentMethodOptionsBancontactSchema.nullable() - .describe( - 'This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription.' - ) - .optional(), - /** This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription. */ - card: SubscriptionPaymentMethodOptionsCardSchema.nullable() - .describe( - 'This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription.' - ) - .optional(), - /** This sub-hash contains details about the Bank transfer payment method options to pass to invoices created by the subscription. */ - customer_balance: - InvoicePaymentMethodOptionsCustomerBalanceSchema.nullable() - .describe( - 'This sub-hash contains details about the Bank transfer payment method options to pass to invoices created by the subscription.' - ) - .optional(), - /** This sub-hash contains details about the Konbini payment method options to pass to invoices created by the subscription. */ - konbini: InvoicePaymentMethodOptionsKonbiniSchema.nullable() - .describe( - 'This sub-hash contains details about the Konbini payment method options to pass to invoices created by the subscription.' - ) - .optional(), - /** This sub-hash contains details about the SEPA Direct Debit payment method options to pass to invoices created by the subscription. */ - sepa_debit: InvoicePaymentMethodOptionsSepaDebitSchema.nullable() - .describe( - 'This sub-hash contains details about the SEPA Direct Debit payment method options to pass to invoices created by the subscription.' - ) - .optional(), - /** This sub-hash contains details about the ACH direct debit payment method options to pass to invoices created by the subscription. */ - us_bank_account: InvoicePaymentMethodOptionsUsBankAccountSchema.nullable() - .describe( - 'This sub-hash contains details about the ACH direct debit payment method options to pass to invoices created by the subscription.' - ) - .optional() + /**This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to invoices created by the subscription.*/ + acss_debit: InvoicePaymentMethodOptionsAcssDebitSchema.describe( + 'This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to invoices created by the subscription.' + ).optional(), + /**This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription.*/ + bancontact: InvoicePaymentMethodOptionsBancontactSchema.describe( + 'This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription.' + ).optional(), + /**This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription.*/ + card: SubscriptionPaymentMethodOptionsCardSchema.describe( + 'This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription.' + ).optional(), + /**This sub-hash contains details about the Bank transfer payment method options to pass to invoices created by the subscription.*/ + customer_balance: InvoicePaymentMethodOptionsCustomerBalanceSchema.describe( + 'This sub-hash contains details about the Bank transfer payment method options to pass to invoices created by the subscription.' + ).optional(), + /**This sub-hash contains details about the Konbini payment method options to pass to invoices created by the subscription.*/ + konbini: InvoicePaymentMethodOptionsKonbiniSchema.describe( + 'This sub-hash contains details about the Konbini payment method options to pass to invoices created by the subscription.' + ).optional(), + /**This sub-hash contains details about the SEPA Direct Debit payment method options to pass to invoices created by the subscription.*/ + sepa_debit: InvoicePaymentMethodOptionsSepaDebitSchema.describe( + 'This sub-hash contains details about the SEPA Direct Debit payment method options to pass to invoices created by the subscription.' + ).optional(), + /**This sub-hash contains details about the ACH direct debit payment method options to pass to invoices created by the subscription.*/ + us_bank_account: InvoicePaymentMethodOptionsUsBankAccountSchema.describe( + 'This sub-hash contains details about the ACH direct debit payment method options to pass to invoices created by the subscription.' + ).optional() }) export type SubscriptionsResourcePaymentMethodOptions = z.infer< typeof SubscriptionsResourcePaymentMethodOptionsSchema > export const InvoicesPaymentMethodOptionsSchema = z.object({ - /** If paying by `acss_debit`, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent. */ - acss_debit: InvoicePaymentMethodOptionsAcssDebitSchema.nullable() - .describe( - 'If paying by `acss_debit`, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.' - ) - .optional(), - /** If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent. */ - bancontact: InvoicePaymentMethodOptionsBancontactSchema.nullable() - .describe( - 'If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.' - ) - .optional(), - /** If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent. */ - card: InvoicePaymentMethodOptionsCardSchema.nullable() - .describe( - 'If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.' - ) - .optional(), - /** If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent. */ - customer_balance: - InvoicePaymentMethodOptionsCustomerBalanceSchema.nullable() - .describe( - 'If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.' - ) - .optional(), - /** If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent. */ - konbini: InvoicePaymentMethodOptionsKonbiniSchema.nullable() - .describe( - 'If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.' - ) - .optional(), - /** If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent. */ - sepa_debit: InvoicePaymentMethodOptionsSepaDebitSchema.nullable() - .describe( - 'If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.' - ) - .optional(), - /** If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent. */ - us_bank_account: InvoicePaymentMethodOptionsUsBankAccountSchema.nullable() - .describe( - 'If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.' - ) - .optional() + /**If paying by `acss_debit`, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.*/ + acss_debit: InvoicePaymentMethodOptionsAcssDebitSchema.describe( + 'If paying by `acss_debit`, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.' + ).optional(), + /**If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.*/ + bancontact: InvoicePaymentMethodOptionsBancontactSchema.describe( + 'If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.' + ).optional(), + /**If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.*/ + card: InvoicePaymentMethodOptionsCardSchema.describe( + 'If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.' + ).optional(), + /**If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.*/ + customer_balance: InvoicePaymentMethodOptionsCustomerBalanceSchema.describe( + 'If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.' + ).optional(), + /**If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.*/ + konbini: InvoicePaymentMethodOptionsKonbiniSchema.describe( + 'If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.' + ).optional(), + /**If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.*/ + sepa_debit: InvoicePaymentMethodOptionsSepaDebitSchema.describe( + 'If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.' + ).optional(), + /**If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.*/ + us_bank_account: InvoicePaymentMethodOptionsUsBankAccountSchema.describe( + 'If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.' + ).optional() }) export type InvoicesPaymentMethodOptions = z.infer< typeof InvoicesPaymentMethodOptionsSchema @@ -28908,140 +27465,129 @@ export namespace stripe { */ export const PlanSchema = z .object({ - /** Whether the plan can be used for new purchases. */ + /**Whether the plan can be used for new purchases.*/ active: z .boolean() .describe('Whether the plan can be used for new purchases.'), - /** Specifies a usage aggregation strategy for plans of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`. */ + /**Specifies a usage aggregation strategy for plans of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`.*/ aggregate_usage: z .enum(['last_during_period', 'last_ever', 'max', 'sum']) - .nullable() .describe( 'Specifies a usage aggregation strategy for plans of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`.' ) .optional(), - /** The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. */ + /**The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.*/ amount: z .number() .int() - .nullable() .describe( 'The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.' ) .optional(), - /** The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. */ + /**The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.*/ amount_decimal: z .string() - .nullable() .describe( 'The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.' ) .optional(), - /** Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes. */ + /**Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.*/ billing_scheme: z .enum(['per_unit', 'tiered']) .describe( 'Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.' ), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`. */ + /**The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.*/ interval: z .enum(['day', 'month', 'week', 'year']) .describe( 'The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.' ), - /** The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. */ + /**The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.*/ interval_count: z .number() .int() .describe( 'The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.' ), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) - .nullable() .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ) .optional(), - /** The meter tracking the usage of a metered price */ + /**The meter tracking the usage of a metered price*/ meter: z .string() .max(5000) - .nullable() .describe('The meter tracking the usage of a metered price') .optional(), - /** A brief description of the plan, hidden from customers. */ + /**A brief description of the plan, hidden from customers.*/ nickname: z .string() .max(5000) - .nullable() .describe('A brief description of the plan, hidden from customers.') .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('plan') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The product whose pricing this plan determines. */ + /**The product whose pricing this plan determines.*/ product: z .union([z.string().max(5000), ProductSchema, DeletedProductSchema]) - .nullable() .describe('The product whose pricing this plan determines.') .optional(), - /** Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. */ + /**Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.*/ tiers: z .array(PlanTierSchema) .describe( 'Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.' ) .optional(), - /** Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows. */ + /**Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows.*/ tiers_mode: z .enum(['graduated', 'volume']) - .nullable() .describe( 'Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows.' ) .optional(), - /** Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`. */ - transform_usage: TransformUsageSchema.nullable() - .describe( - 'Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.' - ) - .optional(), - /** Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan). */ + /**Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.*/ + transform_usage: TransformUsageSchema.describe( + 'Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.' + ).optional(), + /**Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).*/ trial_period_days: z .number() .int() - .nullable() .describe( 'Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).' ) .optional(), - /** Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`. */ + /**Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`.*/ usage_type: z .enum(['licensed', 'metered']) .describe( @@ -29061,60 +27607,58 @@ export namespace stripe { export const IssuingCardholderSchema = z .object({ billing: IssuingCardholderAddressSchema, - /** Additional information about a `company` cardholder. */ - company: IssuingCardholderCompanySchema.nullable() - .describe('Additional information about a `company` cardholder.') - .optional(), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Additional information about a `company` cardholder.*/ + company: IssuingCardholderCompanySchema.describe( + 'Additional information about a `company` cardholder.' + ).optional(), + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** The cardholder's email address. */ + /**The cardholder's email address.*/ email: z .string() .max(5000) - .nullable() .describe("The cardholder's email address.") .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Additional information about an `individual` cardholder. */ - individual: IssuingCardholderIndividualSchema.nullable() - .describe('Additional information about an `individual` cardholder.') - .optional(), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Additional information about an `individual` cardholder.*/ + individual: IssuingCardholderIndividualSchema.describe( + 'Additional information about an `individual` cardholder.' + ).optional(), + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ), - /** The cardholder's name. This will be printed on cards issued to them. */ + /**The cardholder's name. This will be printed on cards issued to them.*/ name: z .string() .max(5000) .describe( "The cardholder's name. This will be printed on cards issued to them." ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('issuing.cardholder') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) for more details. */ + /**The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) for more details.*/ phone_number: z .string() .max(5000) - .nullable() .describe( "The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) for more details." ) @@ -29125,25 +27669,22 @@ export namespace stripe { */ preferred_locales: z .array(z.enum(['de', 'en', 'es', 'fr', 'it'])) - .nullable() .describe( 'The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`.\n This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder.' ) .optional(), requirements: IssuingCardholderRequirementsSchema, - /** Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. */ - spending_controls: IssuingCardholderAuthorizationControlsSchema.nullable() - .describe( - "Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details." - ) - .optional(), - /** Specifies whether to permit authorizations on this cardholder's cards. */ + /**Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.*/ + spending_controls: IssuingCardholderAuthorizationControlsSchema.describe( + "Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details." + ).optional(), + /**Specifies whether to permit authorizations on this cardholder's cards.*/ status: z .enum(['active', 'blocked', 'inactive']) .describe( "Specifies whether to permit authorizations on this cardholder's cards." ), - /** One of `individual` or `company`. See [Choose a cardholder type](https://stripe.com/docs/issuing/other/choose-cardholder) for more details. */ + /**One of `individual` or `company`. See [Choose a cardholder type](https://stripe.com/docs/issuing/other/choose-cardholder) for more details.*/ type: z .enum(['company', 'individual']) .describe( @@ -29156,14 +27697,12 @@ export namespace stripe { export type IssuingCardholder = z.infer export const SubscriptionsResourcePaymentSettingsSchema = z.object({ - /** Payment-method-specific configuration to provide to invoices created by the subscription. */ + /**Payment-method-specific configuration to provide to invoices created by the subscription.*/ payment_method_options: - SubscriptionsResourcePaymentMethodOptionsSchema.nullable() - .describe( - 'Payment-method-specific configuration to provide to invoices created by the subscription.' - ) - .optional(), - /** The list of payment method types to provide to every invoice created by the subscription. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). */ + SubscriptionsResourcePaymentMethodOptionsSchema.describe( + 'Payment-method-specific configuration to provide to invoices created by the subscription.' + ).optional(), + /**The list of payment method types to provide to every invoice created by the subscription. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice).*/ payment_method_types: z .array( z.enum([ @@ -29204,15 +27743,13 @@ export namespace stripe { 'wechat_pay' ]) ) - .nullable() .describe( 'The list of payment method types to provide to every invoice created by the subscription. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice).' ) .optional(), - /** Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off`. */ + /**Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off`.*/ save_default_payment_method: z .enum(['off', 'on_subscription']) - .nullable() .describe( 'Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off`.' ) @@ -29223,22 +27760,19 @@ export namespace stripe { > export const InvoicesPaymentSettingsSchema = z.object({ - /** ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set. */ + /**ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set.*/ default_mandate: z .string() .max(5000) - .nullable() .describe( "ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set." ) .optional(), - /** Payment-method-specific configuration to provide to the invoice’s PaymentIntent. */ - payment_method_options: InvoicesPaymentMethodOptionsSchema.nullable() - .describe( - 'Payment-method-specific configuration to provide to the invoice’s PaymentIntent.' - ) - .optional(), - /** The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). */ + /**Payment-method-specific configuration to provide to the invoice’s PaymentIntent.*/ + payment_method_options: InvoicesPaymentMethodOptionsSchema.describe( + 'Payment-method-specific configuration to provide to the invoice’s PaymentIntent.' + ).optional(), + /**The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice).*/ payment_method_types: z .array( z.enum([ @@ -29279,7 +27813,6 @@ export namespace stripe { 'wechat_pay' ]) ) - .nullable() .describe( 'The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice).' ) @@ -29298,7 +27831,7 @@ export namespace stripe { */ export const PersonSchema = z .object({ - /** The account the person is associated with. */ + /**The account the person is associated with.*/ account: z .string() .max(5000) @@ -29306,9 +27839,9 @@ export namespace stripe { additional_tos_acceptances: PersonAdditionalTosAcceptancesSchema.optional(), address: AddressSchema.optional(), - address_kana: LegalEntityJapanAddressSchema.nullable().optional(), - address_kanji: LegalEntityJapanAddressSchema.nullable().optional(), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + address_kana: LegalEntityJapanAddressSchema.optional(), + address_kanji: LegalEntityJapanAddressSchema.optional(), + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() @@ -29316,116 +27849,106 @@ export namespace stripe { 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), dob: LegalEntityDobSchema.optional(), - /** The person's email address. */ + /**The person's email address.*/ email: z .string() .max(5000) - .nullable() .describe("The person's email address.") .optional(), - /** The person's first name. */ + /**The person's first name.*/ first_name: z .string() .max(5000) - .nullable() .describe("The person's first name.") .optional(), - /** The Kana variation of the person's first name (Japan only). */ + /**The Kana variation of the person's first name (Japan only).*/ first_name_kana: z .string() .max(5000) - .nullable() .describe("The Kana variation of the person's first name (Japan only).") .optional(), - /** The Kanji variation of the person's first name (Japan only). */ + /**The Kanji variation of the person's first name (Japan only).*/ first_name_kanji: z .string() .max(5000) - .nullable() .describe( "The Kanji variation of the person's first name (Japan only)." ) .optional(), - /** A list of alternate names or aliases that the person is known by. */ + /**A list of alternate names or aliases that the person is known by.*/ full_name_aliases: z .array(z.string().max(5000)) .describe( 'A list of alternate names or aliases that the person is known by.' ) .optional(), - future_requirements: PersonFutureRequirementsSchema.nullable().optional(), - /** The person's gender. */ - gender: z.string().nullable().describe("The person's gender.").optional(), - /** Unique identifier for the object. */ + future_requirements: PersonFutureRequirementsSchema.optional(), + /**The person's gender.*/ + gender: z.string().describe("The person's gender.").optional(), + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Whether the person's `id_number` was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by `ssn_last_4_provided`). */ + /**Whether the person's `id_number` was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by `ssn_last_4_provided`).*/ id_number_provided: z .boolean() .describe( "Whether the person's `id_number` was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by `ssn_last_4_provided`)." ) .optional(), - /** Whether the person's `id_number_secondary` was provided. */ + /**Whether the person's `id_number_secondary` was provided.*/ id_number_secondary_provided: z .boolean() .describe("Whether the person's `id_number_secondary` was provided.") .optional(), - /** The person's last name. */ + /**The person's last name.*/ last_name: z .string() .max(5000) - .nullable() .describe("The person's last name.") .optional(), - /** The Kana variation of the person's last name (Japan only). */ + /**The Kana variation of the person's last name (Japan only).*/ last_name_kana: z .string() .max(5000) - .nullable() .describe("The Kana variation of the person's last name (Japan only).") .optional(), - /** The Kanji variation of the person's last name (Japan only). */ + /**The Kanji variation of the person's last name (Japan only).*/ last_name_kanji: z .string() .max(5000) - .nullable() .describe("The Kanji variation of the person's last name (Japan only).") .optional(), - /** The person's maiden name. */ + /**The person's maiden name.*/ maiden_name: z .string() .max(5000) - .nullable() .describe("The person's maiden name.") .optional(), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ) .optional(), - /** The country where the person is a national. */ + /**The country where the person is a national.*/ nationality: z .string() .max(5000) - .nullable() .describe('The country where the person is a national.') .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('person') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The person's phone number. */ + /**The person's phone number.*/ phone: z .string() .max(5000) - .nullable() .describe("The person's phone number.") .optional(), - /** Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. */ + /**Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.*/ political_exposure: z .enum(['existing', 'none']) .describe( @@ -29434,8 +27957,8 @@ export namespace stripe { .optional(), registered_address: AddressSchema.optional(), relationship: PersonRelationshipSchema.optional(), - requirements: PersonRequirementsSchema.nullable().optional(), - /** Whether the last four digits of the person's Social Security number have been provided (U.S. only). */ + requirements: PersonRequirementsSchema.optional(), + /**Whether the last four digits of the person's Social Security number have been provided (U.S. only).*/ ssn_last_4_provided: z .boolean() .describe( @@ -29449,75 +27972,72 @@ export namespace stripe { ) export type Person = z.infer - /** A portal configuration describes the functionality and behavior of a portal session. */ + /**A portal configuration describes the functionality and behavior of a portal session.*/ export const BillingPortalConfigurationSchema = z .object({ - /** Whether the configuration is active and can be used to create portal sessions. */ + /**Whether the configuration is active and can be used to create portal sessions.*/ active: z .boolean() .describe( 'Whether the configuration is active and can be used to create portal sessions.' ), - /** ID of the Connect Application that created the configuration. */ + /**ID of the Connect Application that created the configuration.*/ application: z .union([ z.string().max(5000), ApplicationSchema, DeletedApplicationSchema ]) - .nullable() .describe( 'ID of the Connect Application that created the configuration.' ) .optional(), business_profile: PortalBusinessProfileSchema, - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session. */ + /**The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.*/ default_return_url: z .string() .max(5000) - .nullable() .describe( "The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session." ) .optional(), features: PortalFeaturesSchema, - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Whether the configuration is the default. If `true`, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session. */ + /**Whether the configuration is the default. If `true`, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.*/ is_default: z .boolean() .describe( 'Whether the configuration is the default. If `true`, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session.' ), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), login_page: PortalLoginPageSchema, - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) - .nullable() .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ) .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('billing_portal.configuration') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** Time at which the object was last updated. Measured in seconds since the Unix epoch. */ + /**Time at which the object was last updated. Measured in seconds since the Unix epoch.*/ updated: z .number() .int() @@ -29560,7 +28080,7 @@ export namespace stripe { */ export const TreasuryFinancialAccountSchema = z .object({ - /** The array of paths to active Features in the Features hash. */ + /**The array of paths to active Features in the Features hash.*/ active_features: z .array( z.enum([ @@ -29580,14 +28100,14 @@ export namespace stripe { .describe('The array of paths to active Features in the Features hash.') .optional(), balance: TreasuryFinancialAccountsResourceBalanceSchema, - /** Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ + /**Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).*/ country: z .string() .max(5000) .describe( 'Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).' ), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() @@ -29595,41 +28115,39 @@ export namespace stripe { 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), features: TreasuryFinancialAccountFeaturesSchema.optional(), - /** The set of credentials that resolve to a FinancialAccount. */ + /**The set of credentials that resolve to a FinancialAccount.*/ financial_addresses: z .array(TreasuryFinancialAccountsResourceFinancialAddressSchema) .describe('The set of credentials that resolve to a FinancialAccount.'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), is_default: z.boolean().optional(), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) - .nullable() .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ) .optional(), - /** The nickname for the FinancialAccount. */ + /**The nickname for the FinancialAccount.*/ nickname: z .string() .max(5000) - .nullable() .describe('The nickname for the FinancialAccount.') .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('treasury.financial_account') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The array of paths to pending Features in the Features hash. */ + /**The array of paths to pending Features in the Features hash.*/ pending_features: z .array( z.enum([ @@ -29650,14 +28168,12 @@ export namespace stripe { 'The array of paths to pending Features in the Features hash.' ) .optional(), - /** The set of functionalities that the platform can restrict on the FinancialAccount. */ + /**The set of functionalities that the platform can restrict on the FinancialAccount.*/ platform_restrictions: - TreasuryFinancialAccountsResourcePlatformRestrictionsSchema.nullable() - .describe( - 'The set of functionalities that the platform can restrict on the FinancialAccount.' - ) - .optional(), - /** The array of paths to restricted Features in the Features hash. */ + TreasuryFinancialAccountsResourcePlatformRestrictionsSchema.describe( + 'The set of functionalities that the platform can restrict on the FinancialAccount.' + ).optional(), + /**The array of paths to restricted Features in the Features hash.*/ restricted_features: z .array( z.enum([ @@ -29678,12 +28194,12 @@ export namespace stripe { 'The array of paths to restricted Features in the Features hash.' ) .optional(), - /** Status of this FinancialAccount. */ + /**Status of this FinancialAccount.*/ status: z .enum(['closed', 'open']) .describe('Status of this FinancialAccount.'), status_details: TreasuryFinancialAccountsResourceStatusDetailsSchema, - /** The currencies the FinancialAccount can hold a balance in. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. */ + /**The currencies the FinancialAccount can hold a balance in. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.*/ supported_currencies: z .array(z.string()) .describe( @@ -29768,7 +28284,7 @@ export namespace stripe { */ export const AccountSessionSchema = z .object({ - /** The ID of the account the AccountSession was created for */ + /**The ID of the account the AccountSession was created for*/ account: z .string() .max(5000) @@ -29787,18 +28303,18 @@ export namespace stripe { 'The client secret of this AccountSession. Used on the client to set up secure access to the given `account`.\n\nThe client secret can be used to provide access to `account` from your frontend. It should not be stored, logged, or exposed to anyone other than the connected account. Make sure that you have TLS enabled on any page that includes the client secret.\n\nRefer to our docs to [setup Connect embedded components](https://stripe.com/docs/connect/get-started-connect-embedded-components) and learn about how `client_secret` should be handled.' ), components: ConnectEmbeddedAccountSessionCreateComponentsSchema, - /** The timestamp at which this AccountSession will expire. */ + /**The timestamp at which this AccountSession will expire.*/ expires_at: z .number() .int() .describe('The timestamp at which this AccountSession will expire.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('account_session') .describe( @@ -29811,30 +28327,27 @@ export namespace stripe { export type AccountSession = z.infer export const PaymentMethodDetailsCardSchema = z.object({ - /** The authorized amount. */ + /**The authorized amount.*/ amount_authorized: z .number() .int() - .nullable() .describe('The authorized amount.') .optional(), - /** Authorization code on the charge. */ + /**Authorization code on the charge.*/ authorization_code: z .string() .max(5000) - .nullable() .describe('Authorization code on the charge.') .optional(), - /** Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /**Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.*/ brand: z .string() .max(5000) - .nullable() .describe( 'Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.' ) .optional(), - /** When using manual capture, a future timestamp at which the charge will be automatically refunded if uncaptured. */ + /**When using manual capture, a future timestamp at which the charge will be automatically refunded if uncaptured.*/ capture_before: z .number() .int() @@ -29842,27 +28355,24 @@ export namespace stripe { 'When using manual capture, a future timestamp at which the charge will be automatically refunded if uncaptured.' ) .optional(), - /** Check results by Card networks on Card address and CVC at time of payment. */ - checks: PaymentMethodDetailsCardChecksSchema.nullable() - .describe( - 'Check results by Card networks on Card address and CVC at time of payment.' - ) - .optional(), - /** Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. */ + /**Check results by Card networks on Card address and CVC at time of payment.*/ + checks: PaymentMethodDetailsCardChecksSchema.describe( + 'Check results by Card networks on Card address and CVC at time of payment.' + ).optional(), + /**Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.*/ country: z .string() .max(5000) - .nullable() .describe( "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected." ) .optional(), - /** Two-digit number representing the card's expiration month. */ + /**Two-digit number representing the card's expiration month.*/ exp_month: z .number() .int() .describe("Two-digit number representing the card's expiration month."), - /** Four-digit number representing the card's expiration year. */ + /**Four-digit number representing the card's expiration year.*/ exp_year: z .number() .int() @@ -29877,16 +28387,14 @@ export namespace stripe { fingerprint: z .string() .max(5000) - .nullable() .describe( 'Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*' ) .optional(), - /** Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ + /**Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.*/ funding: z .string() .max(5000) - .nullable() .describe( 'Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.' ) @@ -29898,69 +28406,58 @@ export namespace stripe { * * For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments). */ - installments: PaymentMethodDetailsCardInstallmentsSchema.nullable() - .describe( - 'Installment details for this payment (Mexico only).\n\nFor more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).' - ) - .optional(), - /** The last four digits of the card. */ + installments: PaymentMethodDetailsCardInstallmentsSchema.describe( + 'Installment details for this payment (Mexico only).\n\nFor more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).' + ).optional(), + /**The last four digits of the card.*/ last4: z .string() .max(5000) - .nullable() .describe('The last four digits of the card.') .optional(), - /** ID of the mandate used to make this payment or created by it. */ + /**ID of the mandate used to make this payment or created by it.*/ mandate: z .string() .max(5000) - .nullable() .describe('ID of the mandate used to make this payment or created by it.') .optional(), multicapture: PaymentFlowsPrivatePaymentMethodsCardDetailsApiResourceMulticaptureSchema.optional(), - /** Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /**Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.*/ network: z .string() .max(5000) - .nullable() .describe( 'Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.' ) .optional(), - /** If this card has network token credentials, this contains the details of the network token credentials. */ - network_token: PaymentMethodDetailsCardNetworkTokenSchema.nullable() - .describe( - 'If this card has network token credentials, this contains the details of the network token credentials.' - ) - .optional(), - /** This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise. */ + /**If this card has network token credentials, this contains the details of the network token credentials.*/ + network_token: PaymentMethodDetailsCardNetworkTokenSchema.describe( + 'If this card has network token credentials, this contains the details of the network token credentials.' + ).optional(), + /**This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.*/ network_transaction_id: z .string() .max(5000) - .nullable() .describe( 'This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.' ) .optional(), overcapture: PaymentFlowsPrivatePaymentMethodsCardDetailsApiResourceEnterpriseFeaturesOvercaptureOvercaptureSchema.optional(), - /** Status of a card based on the card issuer. */ + /**Status of a card based on the card issuer.*/ regulated_status: z .enum(['regulated', 'unregulated']) - .nullable() .describe('Status of a card based on the card issuer.') .optional(), - /** Populated if this transaction used 3D Secure authentication. */ - three_d_secure: ThreeDSecureDetailsChargeSchema.nullable() - .describe('Populated if this transaction used 3D Secure authentication.') - .optional(), - /** If this Card is part of a card wallet, this contains the details of the card wallet. */ - wallet: PaymentMethodDetailsCardWalletSchema.nullable() - .describe( - 'If this Card is part of a card wallet, this contains the details of the card wallet.' - ) - .optional() + /**Populated if this transaction used 3D Secure authentication.*/ + three_d_secure: ThreeDSecureDetailsChargeSchema.describe( + 'Populated if this transaction used 3D Secure authentication.' + ).optional(), + /**If this Card is part of a card wallet, this contains the details of the card wallet.*/ + wallet: PaymentMethodDetailsCardWalletSchema.describe( + 'If this Card is part of a card wallet, this contains the details of the card wallet.' + ).optional() }) export type PaymentMethodDetailsCard = z.infer< typeof PaymentMethodDetailsCardSchema @@ -29981,16 +28478,15 @@ export namespace stripe { */ export const IdentityVerificationReportSchema = z .object({ - /** A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. */ + /**A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.*/ client_reference_id: z .string() .max(5000) - .nullable() .describe( 'A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.' ) .optional(), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() @@ -29999,16 +28495,16 @@ export namespace stripe { ), document: GelatoDocumentReportSchema.optional(), email: GelatoEmailReportSchema.optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), id_number: GelatoIdNumberReportSchema.optional(), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('identity.verification_report') .describe( @@ -30017,11 +28513,11 @@ export namespace stripe { options: GelatoVerificationReportOptionsSchema.optional(), phone: GelatoPhoneReportSchema.optional(), selfie: GelatoSelfieReportSchema.optional(), - /** Type of report. */ + /**Type of report.*/ type: z .enum(['document', 'id_number', 'verification_flow']) .describe('Type of report.'), - /** The configuration token of a verification flow from the dashboard. */ + /**The configuration token of a verification flow from the dashboard.*/ verification_flow: z .string() .max(5000) @@ -30029,11 +28525,10 @@ export namespace stripe { 'The configuration token of a verification flow from the dashboard.' ) .optional(), - /** ID of the VerificationSession that created this report. */ + /**ID of the VerificationSession that created this report.*/ verification_session: z .string() .max(5000) - .nullable() .describe('ID of the VerificationSession that created this report.') .optional() }) @@ -30062,19 +28557,17 @@ export namespace stripe { ach_debit: SourceTypeAchDebitSchema.optional(), acss_debit: SourceTypeAcssDebitSchema.optional(), alipay: SourceTypeAlipaySchema.optional(), - /** This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”. */ + /**This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.*/ allow_redisplay: z .enum(['always', 'limited', 'unspecified']) - .nullable() .describe( 'This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.' ) .optional(), - /** A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources. */ + /**A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources.*/ amount: z .number() .int() - .nullable() .describe( 'A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources.' ) @@ -30083,7 +28576,7 @@ export namespace stripe { bancontact: SourceTypeBancontactSchema.optional(), card: SourceTypeCardSchema.optional(), card_present: SourceTypeCardPresentSchema.optional(), - /** The client secret of the source. Used for client-side retrieval using a publishable key. */ + /**The client secret of the source. Used for client-side retrieval using a publishable key.*/ client_secret: z .string() .max(5000) @@ -30091,22 +28584,21 @@ export namespace stripe { 'The client secret of the source. Used for client-side retrieval using a publishable key.' ), code_verification: SourceCodeVerificationFlowSchema.optional(), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. Required for `single_use` sources. */ + /**Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. Required for `single_use` sources.*/ currency: z .string() - .nullable() .describe( 'Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. Required for `single_use` sources.' ) .optional(), - /** The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer. */ + /**The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer.*/ customer: z .string() .max(5000) @@ -30115,7 +28607,7 @@ export namespace stripe { ) .optional(), eps: SourceTypeEpsSchema.optional(), - /** The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. */ + /**The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`.*/ flow: z .string() .max(5000) @@ -30123,53 +28615,49 @@ export namespace stripe { 'The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`.' ), giropay: SourceTypeGiropaySchema.optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), ideal: SourceTypeIdealSchema.optional(), klarna: SourceTypeKlarnaSchema.optional(), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) - .nullable() .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ) .optional(), multibanco: SourceTypeMultibancoSchema.optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('source') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** Information about the owner of the payment instrument that may be used or required by particular source types. */ - owner: SourceOwnerSchema.nullable() - .describe( - 'Information about the owner of the payment instrument that may be used or required by particular source types.' - ) - .optional(), + /**Information about the owner of the payment instrument that may be used or required by particular source types.*/ + owner: SourceOwnerSchema.describe( + 'Information about the owner of the payment instrument that may be used or required by particular source types.' + ).optional(), p24: SourceTypeP24Schema.optional(), receiver: SourceReceiverFlowSchema.optional(), redirect: SourceRedirectFlowSchema.optional(), sepa_debit: SourceTypeSepaDebitSchema.optional(), sofort: SourceTypeSofortSchema.optional(), source_order: SourceOrderSchema.optional(), - /** Extra information about a source. This will appear on your customer's statement every time you charge the source. */ + /**Extra information about a source. This will appear on your customer's statement every time you charge the source.*/ statement_descriptor: z .string() .max(5000) - .nullable() .describe( "Extra information about a source. This will appear on your customer's statement every time you charge the source." ) .optional(), - /** The status of the source, one of `canceled`, `chargeable`, `consumed`, `failed`, or `pending`. Only `chargeable` sources can be used to create a charge. */ + /**The status of the source, one of `canceled`, `chargeable`, `consumed`, `failed`, or `pending`. Only `chargeable` sources can be used to create a charge.*/ status: z .string() .max(5000) @@ -30177,7 +28665,7 @@ export namespace stripe { 'The status of the source, one of `canceled`, `chargeable`, `consumed`, `failed`, or `pending`. Only `chargeable` sources can be used to create a charge.' ), three_d_secure: SourceTypeThreeDSecureSchema.optional(), - /** The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the [payment method](https://stripe.com/docs/sources) used. */ + /**The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the [payment method](https://stripe.com/docs/sources) used.*/ type: z .enum([ 'ach_credit_transfer', @@ -30202,11 +28690,10 @@ export namespace stripe { .describe( 'The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the [payment method](https://stripe.com/docs/sources) used.' ), - /** Either `reusable` or `single_use`. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned. */ + /**Either `reusable` or `single_use`. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.*/ usage: z .string() .max(5000) - .nullable() .describe( 'Either `reusable` or `single_use`. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.' ) @@ -30236,39 +28723,37 @@ export namespace stripe { */ export const BillingPortalSessionSchema = z .object({ - /** The configuration used by this session, describing the features available. */ + /**The configuration used by this session, describing the features available.*/ configuration: z .union([z.string().max(5000), BillingPortalConfigurationSchema]) .describe( 'The configuration used by this session, describing the features available.' ), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** The ID of the customer for this session. */ + /**The ID of the customer for this session.*/ customer: z .string() .max(5000) .describe('The ID of the customer for this session.'), - /** Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows. */ - flow: PortalFlowsFlowSchema.nullable() - .describe( - 'Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.' - ) - .optional(), - /** Unique identifier for the object. */ + /**Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.*/ + flow: PortalFlowsFlowSchema.describe( + 'Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.' + ).optional(), + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used. */ + /**The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used.*/ locale: z .enum([ 'auto', @@ -30319,36 +28804,33 @@ export namespace stripe { 'zh-HK', 'zh-TW' ]) - .nullable() .describe( 'The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used.' ) .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('billing_portal.session') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays. */ + /**The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.*/ on_behalf_of: z .string() .max(5000) - .nullable() .describe( "The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays." ) .optional(), - /** The URL to redirect customers to when they click on the portal's link to return to your website. */ + /**The URL to redirect customers to when they click on the portal's link to return to your website.*/ return_url: z .string() .max(5000) - .nullable() .describe( "The URL to redirect customers to when they click on the portal's link to return to your website." ) .optional(), - /** The short-lived URL of the session that gives customers access to the customer portal. */ + /**The short-lived URL of the session that gives customers access to the customer portal.*/ url: z .string() .max(5000) @@ -30361,32 +28843,31 @@ export namespace stripe { ) export type BillingPortalSession = z.infer - /** You can [create physical or virtual cards](https://stripe.com/docs/issuing) that are issued to cardholders. */ + /**You can [create physical or virtual cards](https://stripe.com/docs/issuing) that are issued to cardholders.*/ export const IssuingCardSchema = z .object({ - /** The brand of the card. */ + /**The brand of the card.*/ brand: z.string().max(5000).describe('The brand of the card.'), - /** The reason why the card was canceled. */ + /**The reason why the card was canceled.*/ cancellation_reason: z .enum(['design_rejected', 'lost', 'stolen']) - .nullable() .describe('The reason why the card was canceled.') .optional(), cardholder: IssuingCardholderSchema, - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Supported currencies are `usd` in the US, `eur` in the EU, and `gbp` in the UK. */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Supported currencies are `usd` in the US, `eur` in the EU, and `gbp` in the UK.*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Supported currencies are `usd` in the US, `eur` in the EU, and `gbp` in the UK.' ), - /** The card's CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint. */ + /**The card's CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint.*/ cvc: z .string() .max(5000) @@ -30394,37 +28875,36 @@ export namespace stripe { 'The card\'s CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it\'s only available via the ["Retrieve a card" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint.' ) .optional(), - /** The expiration month of the card. */ + /**The expiration month of the card.*/ exp_month: z.number().int().describe('The expiration month of the card.'), - /** The expiration year of the card. */ + /**The expiration year of the card.*/ exp_year: z.number().int().describe('The expiration year of the card.'), - /** The financial account this card is attached to. */ + /**The financial account this card is attached to.*/ financial_account: z .string() .max(5000) - .nullable() .describe('The financial account this card is attached to.') .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** The last 4 digits of the card number. */ + /**The last 4 digits of the card number.*/ last4: z .string() .max(5000) .describe('The last 4 digits of the card number.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ), - /** The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint. */ + /**The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint.*/ number: z .string() .max(5000) @@ -30432,63 +28912,57 @@ export namespace stripe { 'The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it\'s only available via the ["Retrieve a card" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint.' ) .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('issuing.card') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The personalization design object belonging to this card. */ + /**The personalization design object belonging to this card.*/ personalization_design: z .union([z.string().max(5000), IssuingPersonalizationDesignSchema]) - .nullable() .describe('The personalization design object belonging to this card.') .optional(), - /** The latest card that replaces this card, if any. */ + /**The latest card that replaces this card, if any.*/ replaced_by: z .union([ z.string().max(5000), // TODO: Support recursive types for `IssuingCardSchema`. z.any() ]) - .nullable() .describe('The latest card that replaces this card, if any.') .optional(), - /** The card this card replaces, if any. */ + /**The card this card replaces, if any.*/ replacement_for: z .union([ z.string().max(5000), // TODO: Support recursive types for `IssuingCardSchema`. z.any() ]) - .nullable() .describe('The card this card replaces, if any.') .optional(), - /** The reason why the previous card needed to be replaced. */ + /**The reason why the previous card needed to be replaced.*/ replacement_reason: z .enum(['damaged', 'expired', 'lost', 'stolen']) - .nullable() .describe('The reason why the previous card needed to be replaced.') .optional(), - /** Where and how the card will be shipped. */ - shipping: IssuingCardShippingSchema.nullable() - .describe('Where and how the card will be shipped.') - .optional(), + /**Where and how the card will be shipped.*/ + shipping: IssuingCardShippingSchema.describe( + 'Where and how the card will be shipped.' + ).optional(), spending_controls: IssuingCardAuthorizationControlsSchema, - /** Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`. */ + /**Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`.*/ status: z .enum(['active', 'canceled', 'inactive']) .describe( 'Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`.' ), - /** The type of the card. */ + /**The type of the card.*/ type: z.enum(['physical', 'virtual']).describe('The type of the card.'), - /** Information relating to digital wallets (like Apple Pay and Google Pay). */ - wallets: IssuingCardWalletsSchema.nullable() - .describe( - 'Information relating to digital wallets (like Apple Pay and Google Pay).' - ) - .optional() + /**Information relating to digital wallets (like Apple Pay and Google Pay).*/ + wallets: IssuingCardWalletsSchema.describe( + 'Information relating to digital wallets (like Apple Pay and Google Pay).' + ).optional() }) .describe( 'You can [create physical or virtual cards](https://stripe.com/docs/issuing) that are issued to cardholders.' @@ -30510,110 +28984,99 @@ export namespace stripe { */ export const IdentityVerificationSessionSchema = z .object({ - /** A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. */ + /**A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.*/ client_reference_id: z .string() .max(5000) - .nullable() .describe( 'A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.' ) .optional(), - /** The short-lived client secret used by Stripe.js to [show a verification modal](https://stripe.com/docs/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://stripe.com/docs/identity/verification-sessions#client-secret) to learn more. */ + /**The short-lived client secret used by Stripe.js to [show a verification modal](https://stripe.com/docs/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://stripe.com/docs/identity/verification-sessions#client-secret) to learn more.*/ client_secret: z .string() .max(5000) - .nullable() .describe( 'The short-lived client secret used by Stripe.js to [show a verification modal](https://stripe.com/docs/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://stripe.com/docs/identity/verification-sessions#client-secret) to learn more.' ) .optional(), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** If present, this property tells you the last error encountered when processing the verification. */ - last_error: GelatoSessionLastErrorSchema.nullable() - .describe( - 'If present, this property tells you the last error encountered when processing the verification.' - ) - .optional(), - /** ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://stripe.com/docs/identity/verification-sessions#results) */ + /**If present, this property tells you the last error encountered when processing the verification.*/ + last_error: GelatoSessionLastErrorSchema.describe( + 'If present, this property tells you the last error encountered when processing the verification.' + ).optional(), + /**ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://stripe.com/docs/identity/verification-sessions#results)*/ last_verification_report: z .union([z.string().max(5000), IdentityVerificationReportSchema]) - .nullable() .describe( 'ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://stripe.com/docs/identity/verification-sessions#results)' ) .optional(), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('identity.verification_session') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** A set of options for the session’s verification checks. */ - options: GelatoVerificationSessionOptionsSchema.nullable() - .describe('A set of options for the session’s verification checks.') - .optional(), - /** Details provided about the user being verified. These details may be shown to the user. */ - provided_details: GelatoProvidedDetailsSchema.nullable() - .describe( - 'Details provided about the user being verified. These details may be shown to the user.' - ) - .optional(), - /** Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null. */ - redaction: VerificationSessionRedactionSchema.nullable() - .describe( - 'Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null.' - ) - .optional(), - /** Token referencing a Customer resource. */ + /**A set of options for the session’s verification checks.*/ + options: GelatoVerificationSessionOptionsSchema.describe( + 'A set of options for the session’s verification checks.' + ).optional(), + /**Details provided about the user being verified. These details may be shown to the user.*/ + provided_details: GelatoProvidedDetailsSchema.describe( + 'Details provided about the user being verified. These details may be shown to the user.' + ).optional(), + /**Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null.*/ + redaction: VerificationSessionRedactionSchema.describe( + 'Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null.' + ).optional(), + /**Token referencing a Customer resource.*/ related_customer: z .string() .max(5000) - .nullable() .describe('Token referencing a Customer resource.') .optional(), - /** Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work). */ + /**Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).*/ status: z .enum(['canceled', 'processing', 'requires_input', 'verified']) .describe( 'Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).' ), - /** The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. */ + /**The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.*/ type: z .enum(['document', 'id_number', 'verification_flow']) .describe( 'The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.' ), - /** The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://stripe.com/docs/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe. */ + /**The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://stripe.com/docs/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe.*/ url: z .string() .max(5000) - .nullable() .describe( 'The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://stripe.com/docs/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe.' ) .optional(), - /** The configuration token of a verification flow from the dashboard. */ + /**The configuration token of a verification flow from the dashboard.*/ verification_flow: z .string() .max(5000) @@ -30621,10 +29084,10 @@ export namespace stripe { 'The configuration token of a verification flow from the dashboard.' ) .optional(), - /** The user’s verified data. */ - verified_outputs: GelatoVerifiedOutputsSchema.nullable() - .describe('The user’s verified data.') - .optional() + /**The user’s verified data.*/ + verified_outputs: GelatoVerifiedOutputsSchema.describe( + 'The user’s verified data.' + ).optional() }) .describe( "A VerificationSession guides you through the process of collecting and verifying the identities\nof your users. It contains details about the type of verification, such as what [verification\ncheck](/docs/identity/verification-checks) to perform. Only create one VerificationSession for\neach verification in your system.\n\nA VerificationSession transitions through [multiple\nstatuses](/docs/identity/how-sessions-work) throughout its lifetime as it progresses through\nthe verification flow. The VerificationSession contains the user's verified data after\nverification checks are complete.\n\nRelated guide: [The Verification Sessions API](https://stripe.com/docs/identity/verification-sessions)" @@ -30641,38 +29104,37 @@ export namespace stripe { export const SourceMandateNotificationSchema = z .object({ acss_debit: SourceMandateNotificationAcssDebitDataSchema.optional(), - /** A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the amount associated with the mandate notification. The amount is expressed in the currency of the underlying source. Required if the notification type is `debit_initiated`. */ + /**A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the amount associated with the mandate notification. The amount is expressed in the currency of the underlying source. Required if the notification type is `debit_initiated`.*/ amount: z .number() .int() - .nullable() .describe( 'A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the amount associated with the mandate notification. The amount is expressed in the currency of the underlying source. Required if the notification type is `debit_initiated`.' ) .optional(), bacs_debit: SourceMandateNotificationBacsDebitDataSchema.optional(), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('source_mandate_notification') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The reason of the mandate notification. Valid reasons are `mandate_confirmed` or `debit_initiated`. */ + /**The reason of the mandate notification. Valid reasons are `mandate_confirmed` or `debit_initiated`.*/ reason: z .string() .max(5000) @@ -30681,14 +29143,14 @@ export namespace stripe { ), sepa_debit: SourceMandateNotificationSepaDebitDataSchema.optional(), source: SourceSchema, - /** The status of the mandate notification. Valid statuses are `pending` or `submitted`. */ + /**The status of the mandate notification. Valid statuses are `pending` or `submitted`.*/ status: z .string() .max(5000) .describe( 'The status of the mandate notification. Valid statuses are `pending` or `submitted`.' ), - /** The type of source this mandate notification is attached to. Should be the source type identifier code for the payment method, such as `three_d_secure`. */ + /**The type of source this mandate notification is attached to. Should be the source type identifier code for the payment method, such as `three_d_secure`.*/ type: z .string() .max(5000) @@ -30727,14 +29189,14 @@ export namespace stripe { redirect_to_url: PaymentIntentNextActionRedirectToUrlSchema.optional(), swish_handle_redirect_or_display_qr_code: PaymentIntentNextActionSwishHandleRedirectOrDisplayQrCodeSchema.optional(), - /** Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`. */ + /**Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`.*/ type: z .string() .max(5000) .describe( 'Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`.' ), - /** When confirming a PaymentIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js. */ + /**When confirming a PaymentIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js.*/ use_stripe_sdk: z .record(z.any()) .describe( @@ -30754,68 +29216,67 @@ export namespace stripe { typeof PaymentIntentNextActionSchema > - /** An issuing token object is created when an issued card is added to a digital wallet. As a [card issuer](https://stripe.com/docs/issuing), you can [view and manage these tokens](https://stripe.com/docs/issuing/controls/token-management) through Stripe. */ + /**An issuing token object is created when an issued card is added to a digital wallet. As a [card issuer](https://stripe.com/docs/issuing), you can [view and manage these tokens](https://stripe.com/docs/issuing/controls/token-management) through Stripe.*/ export const IssuingTokenSchema = z .object({ - /** Card associated with this token. */ + /**Card associated with this token.*/ card: z .union([z.string().max(5000), IssuingCardSchema]) .describe('Card associated with this token.'), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** The hashed ID derived from the device ID from the card network associated with the token. */ + /**The hashed ID derived from the device ID from the card network associated with the token.*/ device_fingerprint: z .string() .max(5000) - .nullable() .describe( 'The hashed ID derived from the device ID from the card network associated with the token.' ) .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** The last four digits of the token. */ + /**The last four digits of the token.*/ last4: z .string() .max(5000) .describe('The last four digits of the token.') .optional(), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** The token service provider / card network associated with the token. */ + /**The token service provider / card network associated with the token.*/ network: z .enum(['mastercard', 'visa']) .describe( 'The token service provider / card network associated with the token.' ), network_data: IssuingNetworkTokenNetworkDataSchema.optional(), - /** Time at which the token was last updated by the card network. Measured in seconds since the Unix epoch. */ + /**Time at which the token was last updated by the card network. Measured in seconds since the Unix epoch.*/ network_updated_at: z .number() .int() .describe( 'Time at which the token was last updated by the card network. Measured in seconds since the Unix epoch.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('issuing.token') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The usage state of the token. */ + /**The usage state of the token.*/ status: z .enum(['active', 'deleted', 'requested', 'suspended']) .describe('The usage state of the token.'), - /** The digital wallet for this token, if one was used. */ + /**The digital wallet for this token, if one was used.*/ wallet_provider: z .enum(['apple_pay', 'google_pay', 'samsung_pay']) .describe('The digital wallet for this token, if one was used.') @@ -31169,33 +29630,32 @@ export namespace stripe { */ export const AccountSchema = z .object({ - /** Business information about the account. */ - business_profile: AccountBusinessProfileSchema.nullable() - .describe('Business information about the account.') - .optional(), - /** The business type. After you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property is only returned for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. */ + /**Business information about the account.*/ + business_profile: AccountBusinessProfileSchema.describe( + 'Business information about the account.' + ).optional(), + /**The business type. After you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property is only returned for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.*/ business_type: z .enum(['company', 'government_entity', 'individual', 'non_profit']) - .nullable() .describe( 'The business type. After you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property is only returned for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.' ) .optional(), capabilities: AccountCapabilitiesSchema.optional(), - /** Whether the account can process charges. */ + /**Whether the account can process charges.*/ charges_enabled: z .boolean() .describe('Whether the account can process charges.') .optional(), company: LegalEntityCompanySchema.optional(), controller: AccountUnificationAccountControllerSchema.optional(), - /** The account's country. */ + /**The account's country.*/ country: z .string() .max(5000) .describe("The account's country.") .optional(), - /** Time at which the account was connected. Measured in seconds since the Unix epoch. */ + /**Time at which the account was connected. Measured in seconds since the Unix epoch.*/ created: z .number() .int() @@ -31203,7 +29663,7 @@ export namespace stripe { 'Time at which the account was connected. Measured in seconds since the Unix epoch.' ) .optional(), - /** Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts). */ + /**Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts).*/ default_currency: z .string() .max(5000) @@ -31211,44 +29671,43 @@ export namespace stripe { "Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts)." ) .optional(), - /** Whether account details have been submitted. Accounts with Stripe Dashboard access, which includes Standard accounts, cannot receive payouts before this is true. Accounts where this is false should be directed to [an onboarding flow](/connect/onboarding) to finish submitting account details. */ + /**Whether account details have been submitted. Accounts with Stripe Dashboard access, which includes Standard accounts, cannot receive payouts before this is true. Accounts where this is false should be directed to [an onboarding flow](/connect/onboarding) to finish submitting account details.*/ details_submitted: z .boolean() .describe( 'Whether account details have been submitted. Accounts with Stripe Dashboard access, which includes Standard accounts, cannot receive payouts before this is true. Accounts where this is false should be directed to [an onboarding flow](/connect/onboarding) to finish submitting account details.' ) .optional(), - /** An email address associated with the account. It's not used for authentication and Stripe doesn't market to this field without explicit approval from the platform. */ + /**An email address associated with the account. It's not used for authentication and Stripe doesn't market to this field without explicit approval from the platform.*/ email: z .string() .max(5000) - .nullable() .describe( "An email address associated with the account. It's not used for authentication and Stripe doesn't market to this field without explicit approval from the platform." ) .optional(), - /** External accounts (bank accounts and debit cards) currently attached to this account. External accounts are only returned for requests where `controller[is_controller]` is true. */ + /**External accounts (bank accounts and debit cards) currently attached to this account. External accounts are only returned for requests where `controller[is_controller]` is true.*/ external_accounts: z .object({ - /** The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards. */ + /**The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards.*/ data: z .array(z.union([BankAccountSchema, CardSchema])) .describe( 'The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards.' ), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -31259,40 +29718,38 @@ export namespace stripe { ) .optional(), future_requirements: AccountFutureRequirementsSchema.optional(), - /** The groups associated with the account. */ - groups: AccountGroupMembershipSchema.nullable() - .describe('The groups associated with the account.') - .optional(), - /** Unique identifier for the object. */ + /**The groups associated with the account.*/ + groups: AccountGroupMembershipSchema.describe( + 'The groups associated with the account.' + ).optional(), + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), individual: PersonSchema.optional(), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ) .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('account') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** Whether the funds in this account can be paid out. */ + /**Whether the funds in this account can be paid out.*/ payouts_enabled: z .boolean() .describe('Whether the funds in this account can be paid out.') .optional(), requirements: AccountRequirementsSchema.optional(), - /** Options for customizing how the account functions within Stripe. */ - settings: AccountSettingsSchema.nullable() - .describe( - 'Options for customizing how the account functions within Stripe.' - ) - .optional(), + /**Options for customizing how the account functions within Stripe.*/ + settings: AccountSettingsSchema.describe( + 'Options for customizing how the account functions within Stripe.' + ).optional(), tos_acceptance: AccountTosAcceptanceSchema.optional(), - /** The Stripe account type. Can be `standard`, `express`, `custom`, or `none`. */ + /**The Stripe account type. Can be `standard`, `express`, `custom`, or `none`.*/ type: z .enum(['custom', 'express', 'none', 'standard']) .describe( @@ -31316,134 +29773,119 @@ export namespace stripe { */ export const BankAccountSchema = z .object({ - /** The ID of the account that the bank account is associated with. */ + /**The ID of the account that the bank account is associated with.*/ account: z .union([z.string().max(5000), AccountSchema]) - .nullable() .describe( 'The ID of the account that the bank account is associated with.' ) .optional(), - /** The name of the person or business that owns the bank account. */ + /**The name of the person or business that owns the bank account.*/ account_holder_name: z .string() .max(5000) - .nullable() .describe( 'The name of the person or business that owns the bank account.' ) .optional(), - /** The type of entity that holds the account. This can be either `individual` or `company`. */ + /**The type of entity that holds the account. This can be either `individual` or `company`.*/ account_holder_type: z .string() .max(5000) - .nullable() .describe( 'The type of entity that holds the account. This can be either `individual` or `company`.' ) .optional(), - /** The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. */ + /**The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.*/ account_type: z .string() .max(5000) - .nullable() .describe( 'The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.' ) .optional(), - /** A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout. */ + /**A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout.*/ available_payout_methods: z .array(z.enum(['instant', 'standard'])) - .nullable() .describe( 'A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout.' ) .optional(), - /** Name of the bank associated with the routing number (e.g., `WELLS FARGO`). */ + /**Name of the bank associated with the routing number (e.g., `WELLS FARGO`).*/ bank_name: z .string() .max(5000) - .nullable() .describe( 'Name of the bank associated with the routing number (e.g., `WELLS FARGO`).' ) .optional(), - /** Two-letter ISO code representing the country the bank account is located in. */ + /**Two-letter ISO code representing the country the bank account is located in.*/ country: z .string() .max(5000) .describe( 'Two-letter ISO code representing the country the bank account is located in.' ), - /** Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account. */ + /**Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.*/ currency: z .string() .describe( 'Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.' ), - /** The ID of the customer that the bank account is associated with. */ + /**The ID of the customer that the bank account is associated with.*/ customer: z .union([z.string().max(5000), CustomerSchema, DeletedCustomerSchema]) - .nullable() .describe( 'The ID of the customer that the bank account is associated with.' ) .optional(), - /** Whether this bank account is the default external account for its currency. */ + /**Whether this bank account is the default external account for its currency.*/ default_for_currency: z .boolean() - .nullable() .describe( 'Whether this bank account is the default external account for its currency.' ) .optional(), - /** Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /**Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.*/ fingerprint: z .string() .max(5000) - .nullable() .describe( 'Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.' ) .optional(), - /** Information about the [upcoming new requirements for the bank account](https://stripe.com/docs/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when. */ - future_requirements: ExternalAccountRequirementsSchema.nullable() - .describe( - 'Information about the [upcoming new requirements for the bank account](https://stripe.com/docs/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when.' - ) - .optional(), - /** Unique identifier for the object. */ + /**Information about the [upcoming new requirements for the bank account](https://stripe.com/docs/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when.*/ + future_requirements: ExternalAccountRequirementsSchema.describe( + 'Information about the [upcoming new requirements for the bank account](https://stripe.com/docs/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when.' + ).optional(), + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** The last four digits of the bank account number. */ + /**The last four digits of the bank account number.*/ last4: z .string() .max(5000) .describe('The last four digits of the bank account number.'), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) - .nullable() .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ) .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('bank_account') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** Information about the requirements for the bank account, including what information needs to be collected. */ - requirements: ExternalAccountRequirementsSchema.nullable() - .describe( - 'Information about the requirements for the bank account, including what information needs to be collected.' - ) - .optional(), - /** The routing transit number for the bank account. */ + /**Information about the requirements for the bank account, including what information needs to be collected.*/ + requirements: ExternalAccountRequirementsSchema.describe( + 'Information about the requirements for the bank account, including what information needs to be collected.' + ).optional(), + /**The routing transit number for the bank account.*/ routing_number: z .string() .max(5000) - .nullable() .describe('The routing transit number for the bank account.') .optional(), /** @@ -31469,11 +29911,9 @@ export namespace stripe { */ export const CustomerSchema = z .object({ - /** The customer's address. */ - address: AddressSchema.nullable() - .describe("The customer's address.") - .optional(), - /** The current balance, if any, that's stored on the customer. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize. */ + /**The customer's address.*/ + address: AddressSchema.describe("The customer's address.").optional(), + /**The current balance, if any, that's stored on the customer. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize.*/ balance: z .number() .int() @@ -31481,24 +29921,21 @@ export namespace stripe { "The current balance, if any, that's stored on the customer. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize." ) .optional(), - /** The current funds being held by Stripe on behalf of the customer. You can apply these funds towards payment intents when the source is "cash_balance". The `settings[reconciliation_mode]` field describes if these funds apply to these payment intents manually or automatically. */ - cash_balance: CashBalanceSchema.nullable() - .describe( - 'The current funds being held by Stripe on behalf of the customer. You can apply these funds towards payment intents when the source is "cash_balance". The `settings[reconciliation_mode]` field describes if these funds apply to these payment intents manually or automatically.' - ) - .optional(), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**The current funds being held by Stripe on behalf of the customer. You can apply these funds towards payment intents when the source is "cash_balance". The `settings[reconciliation_mode]` field describes if these funds apply to these payment intents manually or automatically.*/ + cash_balance: CashBalanceSchema.describe( + 'The current funds being held by Stripe on behalf of the customer. You can apply these funds towards payment intents when the source is "cash_balance". The `settings[reconciliation_mode]` field describes if these funds apply to these payment intents manually or automatically.' + ).optional(), + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes. */ + /**Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes.*/ currency: z .string() .max(5000) - .nullable() .describe( 'Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes.' ) @@ -31515,7 +29952,6 @@ export namespace stripe { CardSchema, SourceSchema ]) - .nullable() .describe( 'ID of the default payment source for the customer.\n\nIf you use payment methods created through the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead.' ) @@ -31529,73 +29965,66 @@ export namespace stripe { */ delinquent: z .boolean() - .nullable() .describe( "Tracks the most recent state change on any invoice belonging to the customer. Paying an invoice or marking it uncollectible via the API will set this field to false. An automatic payment failure or passing the `invoice.due_date` will set this field to `true`.\n\nIf an invoice becomes uncollectible by [dunning](https://stripe.com/docs/billing/automatic-collection), `delinquent` doesn't reset to `false`.\n\nIf you care whether the customer has paid their most recent subscription invoice, use `subscription.status` instead. Paying or marking uncollectible any customer invoice regardless of whether it is the latest invoice for a subscription will always set this field to `false`." ) .optional(), - /** An arbitrary string attached to the object. Often useful for displaying to users. */ + /**An arbitrary string attached to the object. Often useful for displaying to users.*/ description: z .string() .max(5000) - .nullable() .describe( 'An arbitrary string attached to the object. Often useful for displaying to users.' ) .optional(), - /** Describes the current discount active on the customer, if there is one. */ - discount: DiscountSchema.nullable() - .describe( - 'Describes the current discount active on the customer, if there is one.' - ) - .optional(), - /** The customer's email address. */ + /**Describes the current discount active on the customer, if there is one.*/ + discount: DiscountSchema.describe( + 'Describes the current discount active on the customer, if there is one.' + ).optional(), + /**The customer's email address.*/ email: z .string() .max(5000) - .nullable() .describe("The customer's email address.") .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** The current multi-currency balances, if any, that's stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that's added to their next invoice denominated in that currency. These balances don't apply to unpaid invoices. They solely track amounts that Stripe hasn't successfully applied to any invoice. Stripe only applies a balance in a specific currency to an invoice after that invoice (which is in the same currency) finalizes. */ + /**The current multi-currency balances, if any, that's stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that's added to their next invoice denominated in that currency. These balances don't apply to unpaid invoices. They solely track amounts that Stripe hasn't successfully applied to any invoice. Stripe only applies a balance in a specific currency to an invoice after that invoice (which is in the same currency) finalizes.*/ invoice_credit_balance: z .record(z.number().int()) .describe( "The current multi-currency balances, if any, that's stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that's added to their next invoice denominated in that currency. These balances don't apply to unpaid invoices. They solely track amounts that Stripe hasn't successfully applied to any invoice. Stripe only applies a balance in a specific currency to an invoice after that invoice (which is in the same currency) finalizes." ) .optional(), - /** The prefix for the customer used to generate unique invoice numbers. */ + /**The prefix for the customer used to generate unique invoice numbers.*/ invoice_prefix: z .string() .max(5000) - .nullable() .describe( 'The prefix for the customer used to generate unique invoice numbers.' ) .optional(), invoice_settings: InvoiceSettingCustomerSettingSchema.optional(), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ) .optional(), - /** The customer's full name or business name. */ + /**The customer's full name or business name.*/ name: z .string() .max(5000) - .nullable() .describe("The customer's full name or business name.") .optional(), - /** The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses. */ + /**The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses.*/ next_invoice_sequence: z .number() .int() @@ -31603,53 +30032,49 @@ export namespace stripe { "The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses." ) .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('customer') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The customer's phone number. */ + /**The customer's phone number.*/ phone: z .string() .max(5000) - .nullable() .describe("The customer's phone number.") .optional(), - /** The customer's preferred locales (languages), ordered by preference. */ + /**The customer's preferred locales (languages), ordered by preference.*/ preferred_locales: z .array(z.string().max(5000)) - .nullable() .describe( "The customer's preferred locales (languages), ordered by preference." ) .optional(), - /** Mailing and shipping address for the customer. Appears on invoices emailed to this customer. */ - shipping: ShippingSchema.nullable() - .describe( - 'Mailing and shipping address for the customer. Appears on invoices emailed to this customer.' - ) - .optional(), - /** The customer's payment sources, if any. */ + /**Mailing and shipping address for the customer. Appears on invoices emailed to this customer.*/ + shipping: ShippingSchema.describe( + 'Mailing and shipping address for the customer. Appears on invoices emailed to this customer.' + ).optional(), + /**The customer's payment sources, if any.*/ sources: z .object({ - /** Details about each object. */ + /**Details about each object.*/ data: z .array(z.union([BankAccountSchema, CardSchema, SourceSchema])) .describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -31657,26 +30082,26 @@ export namespace stripe { }) .describe("The customer's payment sources, if any.") .optional(), - /** The customer's current subscriptions, if any. */ + /**The customer's current subscriptions, if any.*/ subscriptions: z .object({ - /** Details about each object. */ + /**Details about each object.*/ data: z .array(SubscriptionSchema) .describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -31685,32 +30110,31 @@ export namespace stripe { .describe("The customer's current subscriptions, if any.") .optional(), tax: CustomerTaxSchema.optional(), - /** Describes the customer's tax exemption status, which is `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the following text: **"Reverse charge"**. */ + /**Describes the customer's tax exemption status, which is `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the following text: **"Reverse charge"**.*/ tax_exempt: z .enum(['exempt', 'none', 'reverse']) - .nullable() .describe( 'Describes the customer\'s tax exemption status, which is `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the following text: **"Reverse charge"**.' ) .optional(), - /** The customer's tax IDs. */ + /**The customer's tax IDs.*/ tax_ids: z .object({ - /** Details about each object. */ + /**Details about each object.*/ data: z.array(TaxIdSchema).describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -31718,10 +30142,9 @@ export namespace stripe { }) .describe("The customer's tax IDs.") .optional(), - /** ID of the test clock that this customer belongs to. */ + /**ID of the test clock that this customer belongs to.*/ test_clock: z .union([z.string().max(5000), TestHelpersTestClockSchema]) - .nullable() .describe('ID of the test clock that this customer belongs to.') .optional() }) @@ -31739,154 +30162,137 @@ export namespace stripe { */ export const CardSchema = z .object({ - /** The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. */ + /**The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.*/ account: z .union([z.string().max(5000), AccountSchema]) - .nullable() .describe( 'The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.' ) .optional(), - /** City/District/Suburb/Town/Village. */ + /**City/District/Suburb/Town/Village.*/ address_city: z .string() .max(5000) - .nullable() .describe('City/District/Suburb/Town/Village.') .optional(), - /** Billing address country, if provided when creating card. */ + /**Billing address country, if provided when creating card.*/ address_country: z .string() .max(5000) - .nullable() .describe('Billing address country, if provided when creating card.') .optional(), - /** Address line 1 (Street address/PO Box/Company name). */ + /**Address line 1 (Street address/PO Box/Company name).*/ address_line1: z .string() .max(5000) - .nullable() .describe('Address line 1 (Street address/PO Box/Company name).') .optional(), - /** If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. */ + /**If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.*/ address_line1_check: z .string() .max(5000) - .nullable() .describe( 'If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.' ) .optional(), - /** Address line 2 (Apartment/Suite/Unit/Building). */ + /**Address line 2 (Apartment/Suite/Unit/Building).*/ address_line2: z .string() .max(5000) - .nullable() .describe('Address line 2 (Apartment/Suite/Unit/Building).') .optional(), - /** State/County/Province/Region. */ + /**State/County/Province/Region.*/ address_state: z .string() .max(5000) - .nullable() .describe('State/County/Province/Region.') .optional(), - /** ZIP or postal code. */ + /**ZIP or postal code.*/ address_zip: z .string() .max(5000) - .nullable() .describe('ZIP or postal code.') .optional(), - /** If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. */ + /**If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.*/ address_zip_check: z .string() .max(5000) - .nullable() .describe( 'If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.' ) .optional(), - /** This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”. */ + /**This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.*/ allow_redisplay: z .enum(['always', 'limited', 'unspecified']) - .nullable() .describe( 'This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.' ) .optional(), - /** A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout. */ + /**A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout.*/ available_payout_methods: z .array(z.enum(['instant', 'standard'])) - .nullable() .describe( 'A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout.' ) .optional(), - /** Card brand. Can be `American Express`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`. */ + /**Card brand. Can be `American Express`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.*/ brand: z .string() .max(5000) .describe( 'Card brand. Can be `American Express`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.' ), - /** Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. */ + /**Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.*/ country: z .string() .max(5000) - .nullable() .describe( "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected." ) .optional(), - /** Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. */ + /**Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.*/ currency: z .string() - .nullable() .describe( 'Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.' ) .optional(), - /** The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead. */ + /**The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.*/ customer: z .union([z.string().max(5000), CustomerSchema, DeletedCustomerSchema]) - .nullable() .describe( 'The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.' ) .optional(), - /** If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see [Check if a card is valid without a charge](https://support.stripe.com/questions/check-if-a-card-is-valid-without-a-charge). */ + /**If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see [Check if a card is valid without a charge](https://support.stripe.com/questions/check-if-a-card-is-valid-without-a-charge).*/ cvc_check: z .string() .max(5000) - .nullable() .describe( "If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see [Check if a card is valid without a charge](https://support.stripe.com/questions/check-if-a-card-is-valid-without-a-charge)." ) .optional(), - /** Whether this card is the default external account for its currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. */ + /**Whether this card is the default external account for its currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.*/ default_for_currency: z .boolean() - .nullable() .describe( 'Whether this card is the default external account for its currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts.' ) .optional(), - /** (For tokenized numbers only.) The last four digits of the device account number. */ + /**(For tokenized numbers only.) The last four digits of the device account number.*/ dynamic_last4: z .string() .max(5000) - .nullable() .describe( '(For tokenized numbers only.) The last four digits of the device account number.' ) .optional(), - /** Two-digit number representing the card's expiration month. */ + /**Two-digit number representing the card's expiration month.*/ exp_month: z .number() .int() .describe("Two-digit number representing the card's expiration month."), - /** Four-digit number representing the card's expiration year. */ + /**Four-digit number representing the card's expiration year.*/ exp_year: z .number() .int() @@ -31899,70 +30305,60 @@ export namespace stripe { fingerprint: z .string() .max(5000) - .nullable() .describe( 'Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*' ) .optional(), - /** Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ + /**Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.*/ funding: z .string() .max(5000) .describe( 'Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.' ), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Issuer identification number of the card. */ + /**Issuer identification number of the card.*/ iin: z .string() .max(5000) .describe('Issuer identification number of the card.') .optional(), - /** The last four digits of the card. */ + /**The last four digits of the card.*/ last4: z.string().max(5000).describe('The last four digits of the card.'), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) - .nullable() .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ) .optional(), - /** Cardholder name. */ - name: z - .string() - .max(5000) - .nullable() - .describe('Cardholder name.') - .optional(), + /**Cardholder name.*/ + name: z.string().max(5000).describe('Cardholder name.').optional(), networks: TokenCardNetworksSchema.optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('card') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** Status of a card based on the card issuer. */ + /**Status of a card based on the card issuer.*/ regulated_status: z .enum(['regulated', 'unregulated']) - .nullable() .describe('Status of a card based on the card issuer.') .optional(), - /** For external accounts that are cards, possible values are `new` and `errored`. If a payout fails, the status is set to `errored` and [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) are stopped until account details are updated. */ + /**For external accounts that are cards, possible values are `new` and `errored`. If a payout fails, the status is set to `errored` and [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) are stopped until account details are updated.*/ status: z .string() .max(5000) - .nullable() .describe( 'For external accounts that are cards, possible values are `new` and `errored`. If a payout fails, the status is set to `errored` and [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) are stopped until account details are updated.' ) .optional(), - /** If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null. */ + /**If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null.*/ tokenization_method: z .string() .max(5000) - .nullable() .describe( 'If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null.' ) @@ -31981,84 +30377,76 @@ export namespace stripe { */ export const DiscountSchema = z .object({ - /** The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode. */ + /**The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.*/ checkout_session: z .string() .max(5000) - .nullable() .describe( 'The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.' ) .optional(), coupon: CouponSchema, - /** The ID of the customer associated with this discount. */ + /**The ID of the customer associated with this discount.*/ customer: z .union([z.string().max(5000), CustomerSchema, DeletedCustomerSchema]) - .nullable() .describe('The ID of the customer associated with this discount.') .optional(), - /** If the coupon has a duration of `repeating`, the date that this discount will end. If the coupon has a duration of `once` or `forever`, this attribute will be null. */ + /**If the coupon has a duration of `repeating`, the date that this discount will end. If the coupon has a duration of `once` or `forever`, this attribute will be null.*/ end: z .number() .int() - .nullable() .describe( 'If the coupon has a duration of `repeating`, the date that this discount will end. If the coupon has a duration of `once` or `forever`, this attribute will be null.' ) .optional(), - /** The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array. */ + /**The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array.*/ id: z .string() .max(5000) .describe( 'The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array.' ), - /** The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. */ + /**The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.*/ invoice: z .string() .max(5000) - .nullable() .describe( "The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice." ) .optional(), - /** The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item. */ + /**The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.*/ invoice_item: z .string() .max(5000) - .nullable() .describe( "The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item." ) .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('discount') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The promotion code applied to create this discount. */ + /**The promotion code applied to create this discount.*/ promotion_code: z .union([z.string().max(5000), PromotionCodeSchema]) - .nullable() .describe('The promotion code applied to create this discount.') .optional(), - /** Date that the coupon was applied. */ + /**Date that the coupon was applied.*/ start: z.number().int().describe('Date that the coupon was applied.'), - /** The subscription that this coupon is applied to, if it is applied to a particular subscription. */ + /**The subscription that this coupon is applied to, if it is applied to a particular subscription.*/ subscription: z .string() .max(5000) - .nullable() .describe( 'The subscription that this coupon is applied to, if it is applied to a particular subscription.' ) .optional(), - /** The subscription item that this coupon is applied to, if it is applied to a particular subscription item. */ + /**The subscription item that this coupon is applied to, if it is applied to a particular subscription item.*/ subscription_item: z .string() .max(5000) - .nullable() .describe( 'The subscription item that this coupon is applied to, if it is applied to a particular subscription item.' ) @@ -32075,13 +30463,13 @@ export namespace stripe { */ export const PromotionCodeSchema = z .object({ - /** Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid. */ + /**Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.*/ active: z .boolean() .describe( 'Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.' ), - /** The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), and digits (0-9). */ + /**The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), and digits (0-9).*/ code: z .string() .max(5000) @@ -32089,59 +30477,55 @@ export namespace stripe { 'The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), and digits (0-9).' ), coupon: CouponSchema, - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** The customer that this promotion code can be used by. */ + /**The customer that this promotion code can be used by.*/ customer: z .union([z.string().max(5000), CustomerSchema, DeletedCustomerSchema]) - .nullable() .describe('The customer that this promotion code can be used by.') .optional(), - /** Date at which the promotion code can no longer be redeemed. */ + /**Date at which the promotion code can no longer be redeemed.*/ expires_at: z .number() .int() - .nullable() .describe('Date at which the promotion code can no longer be redeemed.') .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Maximum number of times this promotion code can be redeemed. */ + /**Maximum number of times this promotion code can be redeemed.*/ max_redemptions: z .number() .int() - .nullable() .describe( 'Maximum number of times this promotion code can be redeemed.' ) .optional(), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) - .nullable() .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ) .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('promotion_code') .describe( "String representing the object's type. Objects of the same type share the same value." ), restrictions: PromotionCodesResourceRestrictionsSchema, - /** Number of times this promotion code has been used. */ + /**Number of times this promotion code has been used.*/ times_redeemed: z .number() .int() @@ -32153,33 +30537,30 @@ export namespace stripe { export type PromotionCode = z.infer export const InvoiceSettingCustomerSettingSchema = z.object({ - /** Default custom fields to be displayed on invoices for this customer. */ + /**Default custom fields to be displayed on invoices for this customer.*/ custom_fields: z .array(InvoiceSettingCustomFieldSchema) - .nullable() .describe( 'Default custom fields to be displayed on invoices for this customer.' ) .optional(), - /** ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices. */ + /**ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices.*/ default_payment_method: z .union([z.string().max(5000), PaymentMethodSchema]) - .nullable() .describe( "ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices." ) .optional(), - /** Default footer to be displayed on invoices for this customer. */ + /**Default footer to be displayed on invoices for this customer.*/ footer: z .string() .max(5000) - .nullable() .describe('Default footer to be displayed on invoices for this customer.') .optional(), - /** Default options for invoice PDF rendering for this customer. */ - rendering_options: InvoiceSettingCustomerRenderingOptionsSchema.nullable() - .describe('Default options for invoice PDF rendering for this customer.') - .optional() + /**Default options for invoice PDF rendering for this customer.*/ + rendering_options: InvoiceSettingCustomerRenderingOptionsSchema.describe( + 'Default options for invoice PDF rendering for this customer.' + ).optional() }) export type InvoiceSettingCustomerSetting = z.infer< typeof InvoiceSettingCustomerSettingSchema @@ -32198,7 +30579,7 @@ export namespace stripe { affirm: PaymentMethodAffirmSchema.optional(), afterpay_clearpay: PaymentMethodAfterpayClearpaySchema.optional(), alipay: PaymentFlowsPrivatePaymentMethodsAlipaySchema.optional(), - /** This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”. */ + /**This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.*/ allow_redisplay: z .enum(['always', 'limited', 'unspecified']) .describe( @@ -32216,17 +30597,16 @@ export namespace stripe { card: PaymentMethodCardSchema.optional(), card_present: PaymentMethodCardPresentSchema.optional(), cashapp: PaymentMethodCashappSchema.optional(), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer. */ + /**The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.*/ customer: z .union([z.string().max(5000), CustomerSchema]) - .nullable() .describe( 'The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.' ) @@ -32236,7 +30616,7 @@ export namespace stripe { fpx: PaymentMethodFpxSchema.optional(), giropay: PaymentMethodGiropaySchema.optional(), grabpay: PaymentMethodGrabpaySchema.optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), ideal: PaymentMethodIdealSchema.optional(), interac_present: PaymentMethodInteracPresentSchema.optional(), @@ -32245,16 +30625,15 @@ export namespace stripe { konbini: PaymentMethodKonbiniSchema.optional(), kr_card: PaymentMethodKrCardSchema.optional(), link: PaymentMethodLinkSchema.optional(), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) - .nullable() .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ) @@ -32262,7 +30641,7 @@ export namespace stripe { mobilepay: PaymentMethodMobilepaySchema.optional(), multibanco: PaymentMethodMultibancoSchema.optional(), naver_pay: PaymentMethodNaverPaySchema.optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('payment_method') .describe( @@ -32283,7 +30662,7 @@ export namespace stripe { sofort: PaymentMethodSofortSchema.optional(), swish: PaymentMethodSwishSchema.optional(), twint: PaymentMethodTwintSchema.optional(), - /** The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type. */ + /**The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.*/ type: z .enum([ 'acss_debit', @@ -32346,41 +30725,39 @@ export namespace stripe { export type PaymentMethod = z.infer export const PaymentMethodCardSchema = z.object({ - /** Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /**Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.*/ brand: z .string() .max(5000) .describe( 'Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.' ), - /** Checks on Card address and CVC if provided. */ - checks: PaymentMethodCardChecksSchema.nullable() - .describe('Checks on Card address and CVC if provided.') - .optional(), - /** Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. */ + /**Checks on Card address and CVC if provided.*/ + checks: PaymentMethodCardChecksSchema.describe( + 'Checks on Card address and CVC if provided.' + ).optional(), + /**Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.*/ country: z .string() .max(5000) - .nullable() .describe( "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected." ) .optional(), - /** The brand to use when displaying the card, this accounts for customer's brand choice on dual-branded cards. Can be `american_express`, `cartes_bancaires`, `diners_club`, `discover`, `eftpos_australia`, `interac`, `jcb`, `mastercard`, `union_pay`, `visa`, or `other` and may contain more values in the future. */ + /**The brand to use when displaying the card, this accounts for customer's brand choice on dual-branded cards. Can be `american_express`, `cartes_bancaires`, `diners_club`, `discover`, `eftpos_australia`, `interac`, `jcb`, `mastercard`, `union_pay`, `visa`, or `other` and may contain more values in the future.*/ display_brand: z .string() .max(5000) - .nullable() .describe( "The brand to use when displaying the card, this accounts for customer's brand choice on dual-branded cards. Can be `american_express`, `cartes_bancaires`, `diners_club`, `discover`, `eftpos_australia`, `interac`, `jcb`, `mastercard`, `union_pay`, `visa`, or `other` and may contain more values in the future." ) .optional(), - /** Two-digit number representing the card's expiration month. */ + /**Two-digit number representing the card's expiration month.*/ exp_month: z .number() .int() .describe("Two-digit number representing the card's expiration month."), - /** Four-digit number representing the card's expiration year. */ + /**Four-digit number representing the card's expiration year.*/ exp_year: z .number() .int() @@ -32393,72 +30770,58 @@ export namespace stripe { fingerprint: z .string() .max(5000) - .nullable() .describe( 'Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*' ) .optional(), - /** Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. */ + /**Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.*/ funding: z .string() .max(5000) .describe( 'Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.' ), - /** Details of the original PaymentMethod that created this object. */ - generated_from: PaymentMethodCardGeneratedCardSchema.nullable() - .describe( - 'Details of the original PaymentMethod that created this object.' - ) - .optional(), - /** The last four digits of the card. */ + /**Details of the original PaymentMethod that created this object.*/ + generated_from: PaymentMethodCardGeneratedCardSchema.describe( + 'Details of the original PaymentMethod that created this object.' + ).optional(), + /**The last four digits of the card.*/ last4: z.string().max(5000).describe('The last four digits of the card.'), - /** Contains information about card networks that can be used to process the payment. */ - networks: NetworksSchema.nullable() - .describe( - 'Contains information about card networks that can be used to process the payment.' - ) - .optional(), - /** Status of a card based on the card issuer. */ + /**Contains information about card networks that can be used to process the payment.*/ + networks: NetworksSchema.describe( + 'Contains information about card networks that can be used to process the payment.' + ).optional(), + /**Status of a card based on the card issuer.*/ regulated_status: z .enum(['regulated', 'unregulated']) - .nullable() .describe('Status of a card based on the card issuer.') .optional(), - /** Contains details on how this Card may be used for 3D Secure authentication. */ - three_d_secure_usage: ThreeDSecureUsageSchema.nullable() - .describe( - 'Contains details on how this Card may be used for 3D Secure authentication.' - ) - .optional(), - /** If this Card is part of a card wallet, this contains the details of the card wallet. */ - wallet: PaymentMethodCardWalletSchema.nullable() - .describe( - 'If this Card is part of a card wallet, this contains the details of the card wallet.' - ) - .optional() + /**Contains details on how this Card may be used for 3D Secure authentication.*/ + three_d_secure_usage: ThreeDSecureUsageSchema.describe( + 'Contains details on how this Card may be used for 3D Secure authentication.' + ).optional(), + /**If this Card is part of a card wallet, this contains the details of the card wallet.*/ + wallet: PaymentMethodCardWalletSchema.describe( + 'If this Card is part of a card wallet, this contains the details of the card wallet.' + ).optional() }) export type PaymentMethodCard = z.infer export const PaymentMethodCardGeneratedCardSchema = z.object({ - /** The charge that created this object. */ + /**The charge that created this object.*/ charge: z .string() .max(5000) - .nullable() .describe('The charge that created this object.') .optional(), - /** Transaction-specific details of the payment method used in the payment. */ + /**Transaction-specific details of the payment method used in the payment.*/ payment_method_details: - CardGeneratedFromPaymentMethodDetailsSchema.nullable() - .describe( - 'Transaction-specific details of the payment method used in the payment.' - ) - .optional(), - /** The ID of the SetupAttempt that generated this PaymentMethod, if any. */ + CardGeneratedFromPaymentMethodDetailsSchema.describe( + 'Transaction-specific details of the payment method used in the payment.' + ).optional(), + /**The ID of the SetupAttempt that generated this PaymentMethod, if any.*/ setup_attempt: z .union([z.string().max(5000), SetupAttemptSchema]) - .nullable() .describe( 'The ID of the SetupAttempt that generated this PaymentMethod, if any.' ) @@ -32476,10 +30839,9 @@ export namespace stripe { */ export const SetupAttemptSchema = z .object({ - /** The value of [application](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-application) on the SetupIntent at the time of this confirmation. */ + /**The value of [application](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-application) on the SetupIntent at the time of this confirmation.*/ application: z .union([z.string().max(5000), ApplicationSchema]) - .nullable() .describe( 'The value of [application](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-application) on the SetupIntent at the time of this confirmation.' ) @@ -32495,17 +30857,16 @@ export namespace stripe { "If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.\n\nIt can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer." ) .optional(), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** The value of [customer](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-customer) on the SetupIntent at the time of this confirmation. */ + /**The value of [customer](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-customer) on the SetupIntent at the time of this confirmation.*/ customer: z .union([z.string().max(5000), CustomerSchema, DeletedCustomerSchema]) - .nullable() .describe( 'The value of [customer](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-customer) on the SetupIntent at the time of this confirmation.' ) @@ -32517,56 +30878,52 @@ export namespace stripe { */ flow_directions: z .array(z.enum(['inbound', 'outbound'])) - .nullable() .describe( 'Indicates the directions of money movement for which this payment method is intended to be used.\n\nInclude `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.' ) .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('setup_attempt') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The value of [on_behalf_of](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-on_behalf_of) on the SetupIntent at the time of this confirmation. */ + /**The value of [on_behalf_of](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-on_behalf_of) on the SetupIntent at the time of this confirmation.*/ on_behalf_of: z .union([z.string().max(5000), AccountSchema]) - .nullable() .describe( 'The value of [on_behalf_of](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-on_behalf_of) on the SetupIntent at the time of this confirmation.' ) .optional(), - /** ID of the payment method used with this SetupAttempt. */ + /**ID of the payment method used with this SetupAttempt.*/ payment_method: z .union([z.string().max(5000), PaymentMethodSchema]) .describe('ID of the payment method used with this SetupAttempt.'), payment_method_details: SetupAttemptPaymentMethodDetailsSchema, - /** The error encountered during this attempt to confirm the SetupIntent, if any. */ - setup_error: ApiErrorsSchema.nullable() - .describe( - 'The error encountered during this attempt to confirm the SetupIntent, if any.' - ) - .optional(), - /** ID of the SetupIntent that this attempt belongs to. */ + /**The error encountered during this attempt to confirm the SetupIntent, if any.*/ + setup_error: ApiErrorsSchema.describe( + 'The error encountered during this attempt to confirm the SetupIntent, if any.' + ).optional(), + /**ID of the SetupIntent that this attempt belongs to.*/ setup_intent: z .union([z.string().max(5000), SetupIntentSchema]) .describe('ID of the SetupIntent that this attempt belongs to.'), - /** Status of this SetupAttempt, one of `requires_confirmation`, `requires_action`, `processing`, `succeeded`, `failed`, or `abandoned`. */ + /**Status of this SetupAttempt, one of `requires_confirmation`, `requires_action`, `processing`, `succeeded`, `failed`, or `abandoned`.*/ status: z .string() .max(5000) .describe( 'Status of this SetupAttempt, one of `requires_confirmation`, `requires_action`, `processing`, `succeeded`, `failed`, or `abandoned`.' ), - /** The value of [usage](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-usage) on the SetupIntent at the time of this confirmation, one of `off_session` or `on_session`. */ + /**The value of [usage](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-usage) on the SetupIntent at the time of this confirmation, one of `off_session` or `on_session`.*/ usage: z .string() .max(5000) @@ -32598,7 +30955,7 @@ export namespace stripe { revolut_pay: SetupAttemptPaymentMethodDetailsRevolutPaySchema.optional(), sepa_debit: SetupAttemptPaymentMethodDetailsSepaDebitSchema.optional(), sofort: SetupAttemptPaymentMethodDetailsSofortSchema.optional(), - /** The type of the payment method used in the SetupIntent (e.g., `card`). An additional hash is included on `payment_method_details` with a name matching this value. It contains confirmation-specific information for the payment method. */ + /**The type of the payment method used in the SetupIntent (e.g., `card`). An additional hash is included on `payment_method_details` with a name matching this value. It contains confirmation-specific information for the payment method.*/ type: z .string() .max(5000) @@ -32613,50 +30970,44 @@ export namespace stripe { > export const SetupAttemptPaymentMethodDetailsBancontactSchema = z.object({ - /** Bank code of bank associated with the bank account. */ + /**Bank code of bank associated with the bank account.*/ bank_code: z .string() .max(5000) - .nullable() .describe('Bank code of bank associated with the bank account.') .optional(), - /** Name of the bank associated with the bank account. */ + /**Name of the bank associated with the bank account.*/ bank_name: z .string() .max(5000) - .nullable() .describe('Name of the bank associated with the bank account.') .optional(), - /** Bank Identifier Code of the bank associated with the bank account. */ + /**Bank Identifier Code of the bank associated with the bank account.*/ bic: z .string() .max(5000) - .nullable() .describe( 'Bank Identifier Code of the bank associated with the bank account.' ) .optional(), - /** The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ + /**The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.*/ generated_sepa_debit: z .union([z.string().max(5000), PaymentMethodSchema]) - .nullable() .describe( 'The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.' ) .optional(), - /** The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ + /**The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.*/ generated_sepa_debit_mandate: z .union([z.string().max(5000), MandateSchema]) - .nullable() .describe( 'The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.' ) .optional(), - /** Last four characters of the IBAN. */ + /**Last four characters of the IBAN.*/ iban_last4: z .string() .max(5000) - .nullable() .describe('Last four characters of the IBAN.') .optional(), /** @@ -32665,7 +31016,6 @@ export namespace stripe { */ preferred_language: z .enum(['de', 'en', 'fr', 'nl']) - .nullable() .describe( 'Preferred language of the Bancontact authorization page that the customer is redirected to.\nCan be one of `en`, `de`, `fr`, or `nl`' ) @@ -32677,7 +31027,6 @@ export namespace stripe { verified_name: z .string() .max(5000) - .nullable() .describe( "Owner's verified full name. Values are verified or provided by Bancontact directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated." ) @@ -32687,44 +31036,44 @@ export namespace stripe { typeof SetupAttemptPaymentMethodDetailsBancontactSchema > - /** A Mandate is a record of the permission that your customer gives you to debit their payment method. */ + /**A Mandate is a record of the permission that your customer gives you to debit their payment method.*/ export const MandateSchema = z .object({ customer_acceptance: CustomerAcceptanceSchema, - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), multi_use: MandateMultiUseSchema.optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('mandate') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The account (if any) that the mandate is intended for. */ + /**The account (if any) that the mandate is intended for.*/ on_behalf_of: z .string() .max(5000) .describe('The account (if any) that the mandate is intended for.') .optional(), - /** ID of the payment method associated with this mandate. */ + /**ID of the payment method associated with this mandate.*/ payment_method: z .union([z.string().max(5000), PaymentMethodSchema]) .describe('ID of the payment method associated with this mandate.'), payment_method_details: MandatePaymentMethodDetailsSchema, single_use: MandateSingleUseSchema.optional(), - /** The mandate status indicates whether or not you can use it to initiate a payment. */ + /**The mandate status indicates whether or not you can use it to initiate a payment.*/ status: z .enum(['active', 'inactive', 'pending']) .describe( 'The mandate status indicates whether or not you can use it to initiate a payment.' ), - /** The type of the mandate. */ + /**The type of the mandate.*/ type: z .enum(['multi_use', 'single_use']) .describe('The type of the mandate.') @@ -32735,25 +31084,24 @@ export namespace stripe { export type Mandate = z.infer export const SetupAttemptPaymentMethodDetailsCardPresentSchema = z.object({ - /** The ID of the Card PaymentMethod which was generated by this SetupAttempt. */ + /**The ID of the Card PaymentMethod which was generated by this SetupAttempt.*/ generated_card: z .union([z.string().max(5000), PaymentMethodSchema]) - .nullable() .describe( 'The ID of the Card PaymentMethod which was generated by this SetupAttempt.' ) .optional(), - /** Details about payments collected offline. */ - offline: PaymentMethodDetailsCardPresentOfflineSchema.nullable() - .describe('Details about payments collected offline.') - .optional() + /**Details about payments collected offline.*/ + offline: PaymentMethodDetailsCardPresentOfflineSchema.describe( + 'Details about payments collected offline.' + ).optional() }) export type SetupAttemptPaymentMethodDetailsCardPresent = z.infer< typeof SetupAttemptPaymentMethodDetailsCardPresentSchema > export const SetupAttemptPaymentMethodDetailsIdealSchema = z.object({ - /** The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. */ + /**The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.*/ bank: z .enum([ 'abn_amro', @@ -32773,12 +31121,11 @@ export namespace stripe { 'van_lanschot', 'yoursafe' ]) - .nullable() .describe( "The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`." ) .optional(), - /** The Bank Identifier Code of the customer's bank. */ + /**The Bank Identifier Code of the customer's bank.*/ bic: z .enum([ 'ABNANL2A', @@ -32799,30 +31146,26 @@ export namespace stripe { 'SNSBNL2A', 'TRIONL2U' ]) - .nullable() .describe("The Bank Identifier Code of the customer's bank.") .optional(), - /** The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ + /**The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.*/ generated_sepa_debit: z .union([z.string().max(5000), PaymentMethodSchema]) - .nullable() .describe( 'The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.' ) .optional(), - /** The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ + /**The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.*/ generated_sepa_debit_mandate: z .union([z.string().max(5000), MandateSchema]) - .nullable() .describe( 'The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.' ) .optional(), - /** Last four characters of the IBAN. */ + /**Last four characters of the IBAN.*/ iban_last4: z .string() .max(5000) - .nullable() .describe('Last four characters of the IBAN.') .optional(), /** @@ -32832,7 +31175,6 @@ export namespace stripe { verified_name: z .string() .max(5000) - .nullable() .describe( "Owner's verified full name. Values are verified or provided by iDEAL directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated." ) @@ -32843,50 +31185,44 @@ export namespace stripe { > export const SetupAttemptPaymentMethodDetailsSofortSchema = z.object({ - /** Bank code of bank associated with the bank account. */ + /**Bank code of bank associated with the bank account.*/ bank_code: z .string() .max(5000) - .nullable() .describe('Bank code of bank associated with the bank account.') .optional(), - /** Name of the bank associated with the bank account. */ + /**Name of the bank associated with the bank account.*/ bank_name: z .string() .max(5000) - .nullable() .describe('Name of the bank associated with the bank account.') .optional(), - /** Bank Identifier Code of the bank associated with the bank account. */ + /**Bank Identifier Code of the bank associated with the bank account.*/ bic: z .string() .max(5000) - .nullable() .describe( 'Bank Identifier Code of the bank associated with the bank account.' ) .optional(), - /** The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ + /**The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.*/ generated_sepa_debit: z .union([z.string().max(5000), PaymentMethodSchema]) - .nullable() .describe( 'The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.' ) .optional(), - /** The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ + /**The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.*/ generated_sepa_debit_mandate: z .union([z.string().max(5000), MandateSchema]) - .nullable() .describe( 'The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.' ) .optional(), - /** Last four characters of the IBAN. */ + /**Last four characters of the IBAN.*/ iban_last4: z .string() .max(5000) - .nullable() .describe('Last four characters of the IBAN.') .optional(), /** @@ -32895,7 +31231,6 @@ export namespace stripe { */ preferred_language: z .enum(['de', 'en', 'fr', 'nl']) - .nullable() .describe( 'Preferred language of the Sofort authorization page that the customer is redirected to.\nCan be one of `en`, `de`, `fr`, or `nl`' ) @@ -32907,7 +31242,6 @@ export namespace stripe { verified_name: z .string() .max(5000) - .nullable() .describe( "Owner's verified full name. Values are verified or provided by Sofort directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated." ) @@ -32918,7 +31252,7 @@ export namespace stripe { > export const ApiErrorsSchema = z.object({ - /** For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines) if they provide one. */ + /**For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines) if they provide one.*/ advice_code: z .string() .max(5000) @@ -32926,13 +31260,13 @@ export namespace stripe { 'For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines) if they provide one.' ) .optional(), - /** For card errors, the ID of the failed charge. */ + /**For card errors, the ID of the failed charge.*/ charge: z .string() .max(5000) .describe('For card errors, the ID of the failed charge.') .optional(), - /** For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported. */ + /**For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported.*/ code: z .string() .max(5000) @@ -32940,7 +31274,7 @@ export namespace stripe { 'For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported.' ) .optional(), - /** For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://stripe.com/docs/declines#issuer-declines) if they provide one. */ + /**For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://stripe.com/docs/declines#issuer-declines) if they provide one.*/ decline_code: z .string() .max(5000) @@ -32948,7 +31282,7 @@ export namespace stripe { "For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://stripe.com/docs/declines#issuer-declines) if they provide one." ) .optional(), - /** A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported. */ + /**A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported.*/ doc_url: z .string() .max(5000) @@ -32956,7 +31290,7 @@ export namespace stripe { 'A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported.' ) .optional(), - /** A human-readable message providing more details about the error. For card errors, these messages can be shown to your users. */ + /**A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.*/ message: z .string() .max(40_000) @@ -32964,7 +31298,7 @@ export namespace stripe { 'A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.' ) .optional(), - /** For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error. */ + /**For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.*/ network_advice_code: z .string() .max(5000) @@ -32972,7 +31306,7 @@ export namespace stripe { 'For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.' ) .optional(), - /** For card errors resulting from a card issuer decline, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed. */ + /**For card errors resulting from a card issuer decline, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed.*/ network_decline_code: z .string() .max(5000) @@ -32980,7 +31314,7 @@ export namespace stripe { 'For card errors resulting from a card issuer decline, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed.' ) .optional(), - /** If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field. */ + /**If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.*/ param: z .string() .max(5000) @@ -32990,7 +31324,7 @@ export namespace stripe { .optional(), payment_intent: PaymentIntentSchema.optional(), payment_method: PaymentMethodSchema.optional(), - /** If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors. */ + /**If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.*/ payment_method_type: z .string() .max(5000) @@ -32998,21 +31332,21 @@ export namespace stripe { 'If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.' ) .optional(), - /** A URL to the request log entry in your dashboard. */ + /**A URL to the request log entry in your dashboard.*/ request_log_url: z .string() .max(5000) .describe('A URL to the request log entry in your dashboard.') .optional(), setup_intent: SetupIntentSchema.optional(), - /** The [source object](https://stripe.com/docs/api/sources/object) for errors returned on a request involving a source. */ + /**The [source object](https://stripe.com/docs/api/sources/object) for errors returned on a request involving a source.*/ source: z .union([BankAccountSchema, CardSchema, SourceSchema]) .describe( 'The [source object](https://stripe.com/docs/api/sources/object) for errors returned on a request involving a source.' ) .optional(), - /** The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error` */ + /**The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error`*/ type: z .enum([ 'api_error', @@ -33041,14 +31375,14 @@ export namespace stripe { */ export const PaymentIntentSchema = z .object({ - /** Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). */ + /**Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).*/ amount: z .number() .int() .describe( 'Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).' ), - /** Amount that can be captured from this PaymentIntent. */ + /**Amount that can be captured from this PaymentIntent.*/ amount_capturable: z .number() .int() @@ -33060,46 +31394,41 @@ export namespace stripe { PaymentFlowsAmountDetailsClientSchema ]) .optional(), - /** Amount that this PaymentIntent collects. */ + /**Amount that this PaymentIntent collects.*/ amount_received: z .number() .int() .describe('Amount that this PaymentIntent collects.') .optional(), - /** ID of the Connect application that created the PaymentIntent. */ + /**ID of the Connect application that created the PaymentIntent.*/ application: z .union([z.string().max(5000), ApplicationSchema]) - .nullable() .describe( 'ID of the Connect application that created the PaymentIntent.' ) .optional(), - /** The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ + /**The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).*/ application_fee_amount: z .number() .int() - .nullable() .describe( "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts)." ) .optional(), - /** Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods) */ + /**Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods)*/ automatic_payment_methods: - PaymentFlowsAutomaticPaymentMethodsPaymentIntentSchema.nullable() - .describe( - 'Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods)' - ) - .optional(), - /** Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch. */ + PaymentFlowsAutomaticPaymentMethodsPaymentIntentSchema.describe( + 'Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods)' + ).optional(), + /**Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.*/ canceled_at: z .number() .int() - .nullable() .describe( 'Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.' ) .optional(), - /** Reason for cancellation of this PaymentIntent, either user-provided (`duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`) or generated by Stripe internally (`failed_invoice`, `void_invoice`, or `automatic`). */ + /**Reason for cancellation of this PaymentIntent, either user-provided (`duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`) or generated by Stripe internally (`failed_invoice`, `void_invoice`, or `automatic`).*/ cancellation_reason: z .enum([ 'abandoned', @@ -33110,12 +31439,11 @@ export namespace stripe { 'requested_by_customer', 'void_invoice' ]) - .nullable() .describe( 'Reason for cancellation of this PaymentIntent, either user-provided (`duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`) or generated by Stripe internally (`failed_invoice`, `void_invoice`, or `automatic`).' ) .optional(), - /** Controls when the funds will be captured from the customer's account. */ + /**Controls when the funds will be captured from the customer's account.*/ capture_method: z .enum(['automatic', 'automatic_async', 'manual']) .describe( @@ -33131,25 +31459,24 @@ export namespace stripe { client_secret: z .string() .max(5000) - .nullable() .describe( 'The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. \n\nThe client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.\n\nRefer to our docs to [accept a payment](https://stripe.com/docs/payments/accept-a-payment?ui=elements) and learn about how `client_secret` should be handled.' ) .optional(), - /** Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment. */ + /**Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment.*/ confirmation_method: z .enum(['automatic', 'manual']) .describe( 'Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment.' ), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( @@ -33164,121 +31491,103 @@ export namespace stripe { */ customer: z .union([z.string().max(5000), CustomerSchema, DeletedCustomerSchema]) - .nullable() .describe( "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead." ) .optional(), - /** An arbitrary string attached to the object. Often useful for displaying to users. */ + /**An arbitrary string attached to the object. Often useful for displaying to users.*/ description: z .string() .max(5000) - .nullable() .describe( 'An arbitrary string attached to the object. Often useful for displaying to users.' ) .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** ID of the invoice that created this PaymentIntent, if it exists. */ + /**ID of the invoice that created this PaymentIntent, if it exists.*/ invoice: z .union([z.string().max(5000), InvoiceSchema]) - .nullable() .describe( 'ID of the invoice that created this PaymentIntent, if it exists.' ) .optional(), - /** The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason. */ - last_payment_error: ApiErrorsSchema.nullable() - .describe( - 'The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.' - ) - .optional(), - /** ID of the latest [Charge object](https://stripe.com/docs/api/charges) created by this PaymentIntent. This property is `null` until PaymentIntent confirmation is attempted. */ + /**The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.*/ + last_payment_error: ApiErrorsSchema.describe( + 'The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.' + ).optional(), + /**ID of the latest [Charge object](https://stripe.com/docs/api/charges) created by this PaymentIntent. This property is `null` until PaymentIntent confirmation is attempted.*/ latest_charge: z .union([z.string().max(5000), ChargeSchema]) - .nullable() .describe( 'ID of the latest [Charge object](https://stripe.com/docs/api/charges) created by this PaymentIntent. This property is `null` until PaymentIntent confirmation is attempted.' ) .optional(), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Learn more about [storing information in metadata](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata). */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Learn more about [storing information in metadata](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata).*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Learn more about [storing information in metadata](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata).' ) .optional(), - /** If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source. */ - next_action: PaymentIntentNextActionSchema.nullable() - .describe( - 'If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.' - ) - .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.*/ + next_action: PaymentIntentNextActionSchema.describe( + 'If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.' + ).optional(), + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('payment_intent') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. */ + /**The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details.*/ on_behalf_of: z .union([z.string().max(5000), AccountSchema]) - .nullable() .describe( 'The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details.' ) .optional(), - /** ID of the payment method used in this PaymentIntent. */ + /**ID of the payment method used in this PaymentIntent.*/ payment_method: z .union([z.string().max(5000), PaymentMethodSchema]) - .nullable() .describe('ID of the payment method used in this PaymentIntent.') .optional(), - /** Information about the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) used for this PaymentIntent. */ + /**Information about the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) used for this PaymentIntent.*/ payment_method_configuration_details: - PaymentMethodConfigBizPaymentMethodConfigurationDetailsSchema.nullable() - .describe( - 'Information about the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) used for this PaymentIntent.' - ) - .optional(), - /** Payment-method-specific configuration for this PaymentIntent. */ - payment_method_options: PaymentIntentPaymentMethodOptionsSchema.nullable() - .describe( - 'Payment-method-specific configuration for this PaymentIntent.' - ) - .optional(), - /** The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. */ + PaymentMethodConfigBizPaymentMethodConfigurationDetailsSchema.describe( + 'Information about the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) used for this PaymentIntent.' + ).optional(), + /**Payment-method-specific configuration for this PaymentIntent.*/ + payment_method_options: PaymentIntentPaymentMethodOptionsSchema.describe( + 'Payment-method-specific configuration for this PaymentIntent.' + ).optional(), + /**The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.*/ payment_method_types: z .array(z.string().max(5000)) .describe( 'The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.' ), - /** If present, this property tells you about the processing state of the payment. */ - processing: PaymentIntentProcessingSchema.nullable() - .describe( - 'If present, this property tells you about the processing state of the payment.' - ) - .optional(), - /** Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails). */ + /**If present, this property tells you about the processing state of the payment.*/ + processing: PaymentIntentProcessingSchema.describe( + 'If present, this property tells you about the processing state of the payment.' + ).optional(), + /**Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).*/ receipt_email: z .string() .max(5000) - .nullable() .describe( 'Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).' ) .optional(), - /** ID of the review associated with this PaymentIntent, if any. */ + /**ID of the review associated with this PaymentIntent, if any.*/ review: z .union([z.string().max(5000), ReviewSchema]) - .nullable() .describe( 'ID of the review associated with this PaymentIntent, if any.' ) @@ -33294,15 +31603,14 @@ export namespace stripe { */ setup_future_usage: z .enum(['off_session', 'on_session']) - .nullable() .describe( "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)." ) .optional(), - /** Shipping information for this PaymentIntent. */ - shipping: ShippingSchema.nullable() - .describe('Shipping information for this PaymentIntent.') - .optional(), + /**Shipping information for this PaymentIntent.*/ + shipping: ShippingSchema.describe( + 'Shipping information for this PaymentIntent.' + ).optional(), /** * Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors). * @@ -33311,21 +31619,19 @@ export namespace stripe { statement_descriptor: z .string() .max(5000) - .nullable() .describe( "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead." ) .optional(), - /** Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. */ + /**Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.*/ statement_descriptor_suffix: z .string() .max(5000) - .nullable() .describe( "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement." ) .optional(), - /** Status of this PaymentIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `requires_capture`, `canceled`, or `succeeded`. Read more about each PaymentIntent [status](https://stripe.com/docs/payments/intents#intent-statuses). */ + /**Status of this PaymentIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `requires_capture`, `canceled`, or `succeeded`. Read more about each PaymentIntent [status](https://stripe.com/docs/payments/intents#intent-statuses).*/ status: z .enum([ 'canceled', @@ -33339,17 +31645,14 @@ export namespace stripe { .describe( 'Status of this PaymentIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `requires_capture`, `canceled`, or `succeeded`. Read more about each PaymentIntent [status](https://stripe.com/docs/payments/intents#intent-statuses).' ), - /** The data that automatically creates a Transfer after the payment finalizes. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ - transfer_data: TransferDataSchema.nullable() - .describe( - 'The data that automatically creates a Transfer after the payment finalizes. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).' - ) - .optional(), - /** A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers). */ + /**The data that automatically creates a Transfer after the payment finalizes. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).*/ + transfer_data: TransferDataSchema.describe( + 'The data that automatically creates a Transfer after the payment finalizes. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).' + ).optional(), + /**A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers).*/ transfer_group: z .string() .max(5000) - .nullable() .describe( 'A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers).' ) @@ -33396,89 +31699,84 @@ export namespace stripe { */ export const InvoiceSchema = z .object({ - /** The country of the business associated with this invoice, most often the business creating the invoice. */ + /**The country of the business associated with this invoice, most often the business creating the invoice.*/ account_country: z .string() .max(5000) - .nullable() .describe( 'The country of the business associated with this invoice, most often the business creating the invoice.' ) .optional(), - /** The public name of the business associated with this invoice, most often the business creating the invoice. */ + /**The public name of the business associated with this invoice, most often the business creating the invoice.*/ account_name: z .string() .max(5000) - .nullable() .describe( 'The public name of the business associated with this invoice, most often the business creating the invoice.' ) .optional(), - /** The account tax IDs associated with the invoice. Only editable when the invoice is a draft. */ + /**The account tax IDs associated with the invoice. Only editable when the invoice is a draft.*/ account_tax_ids: z .array(z.union([z.string().max(5000), TaxIdSchema, DeletedTaxIdSchema])) - .nullable() .describe( 'The account tax IDs associated with the invoice. Only editable when the invoice is a draft.' ) .optional(), - /** Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the `amount_due` may be 0. If there is a positive `starting_balance` for the invoice (the customer owes money), the `amount_due` will also take that into account. The charge that gets generated for the invoice will be for the amount specified in `amount_due`. */ + /**Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the `amount_due` may be 0. If there is a positive `starting_balance` for the invoice (the customer owes money), the `amount_due` will also take that into account. The charge that gets generated for the invoice will be for the amount specified in `amount_due`.*/ amount_due: z .number() .int() .describe( "Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the `amount_due` may be 0. If there is a positive `starting_balance` for the invoice (the customer owes money), the `amount_due` will also take that into account. The charge that gets generated for the invoice will be for the amount specified in `amount_due`." ), - /** The amount, in cents (or local equivalent), that was paid. */ + /**The amount, in cents (or local equivalent), that was paid.*/ amount_paid: z .number() .int() .describe('The amount, in cents (or local equivalent), that was paid.'), - /** The difference between amount_due and amount_paid, in cents (or local equivalent). */ + /**The difference between amount_due and amount_paid, in cents (or local equivalent).*/ amount_remaining: z .number() .int() .describe( 'The difference between amount_due and amount_paid, in cents (or local equivalent).' ), - /** This is the sum of all the shipping amounts. */ + /**This is the sum of all the shipping amounts.*/ amount_shipping: z .number() .int() .describe('This is the sum of all the shipping amounts.'), - /** ID of the Connect Application that created the invoice. */ + /**ID of the Connect Application that created the invoice.*/ application: z .union([ z.string().max(5000), ApplicationSchema, DeletedApplicationSchema ]) - .nullable() .describe('ID of the Connect Application that created the invoice.') .optional(), - /** The fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid. */ + /**The fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid.*/ application_fee_amount: z .number() .int() - .nullable() .describe( "The fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid." ) .optional(), - /** Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained. */ + /**Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained.*/ attempt_count: z .number() .int() .describe( 'Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained.' ), - /** Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the `invoice.created` webhook, for example, so you might not want to display that invoice as unpaid to your users. */ + /**Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the `invoice.created` webhook, for example, so you might not want to display that invoice as unpaid to your users.*/ attempted: z .boolean() .describe( 'Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the `invoice.created` webhook, for example, so you might not want to display that invoice as unpaid to your users.' ), - /** Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action. */ + /**Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.*/ auto_advance: z .boolean() .describe( @@ -33486,11 +31784,10 @@ export namespace stripe { ) .optional(), automatic_tax: AutomaticTaxSchema, - /** The time when this invoice is currently scheduled to be automatically finalized. The field will be `null` if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be `null` - see `finalized_at` for the time when an already-finalized invoice was finalized. */ + /**The time when this invoice is currently scheduled to be automatically finalized. The field will be `null` if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be `null` - see `finalized_at` for the time when an already-finalized invoice was finalized.*/ automatically_finalizes_at: z .number() .int() - .nullable() .describe( 'The time when this invoice is currently scheduled to be automatically finalized. The field will be `null` if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be `null` - see `finalized_at` for the time when an already-finalized invoice was finalized.' ) @@ -33518,112 +31815,98 @@ export namespace stripe { 'subscription_update', 'upcoming' ]) - .nullable() .describe( 'Indicates the reason why the invoice was created.\n\n* `manual`: Unrelated to a subscription, for example, created via the invoice editor.\n* `subscription`: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds.\n* `subscription_create`: A new subscription was created.\n* `subscription_cycle`: A subscription advanced into a new period.\n* `subscription_threshold`: A subscription reached a billing threshold.\n* `subscription_update`: A subscription was updated.\n* `upcoming`: Reserved for simulated invoices, per the upcoming invoice endpoint.' ) .optional(), - /** ID of the latest charge generated for this invoice, if any. */ + /**ID of the latest charge generated for this invoice, if any.*/ charge: z .union([z.string().max(5000), ChargeSchema]) - .nullable() .describe('ID of the latest charge generated for this invoice, if any.') .optional(), - /** Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions. */ + /**Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.*/ collection_method: z .enum(['charge_automatically', 'send_invoice']) .describe( 'Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.' ), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** Custom fields displayed on the invoice. */ + /**Custom fields displayed on the invoice.*/ custom_fields: z .array(InvoiceSettingCustomFieldSchema) - .nullable() .describe('Custom fields displayed on the invoice.') .optional(), - /** The ID of the customer who will be billed. */ + /**The ID of the customer who will be billed.*/ customer: z .union([z.string().max(5000), CustomerSchema, DeletedCustomerSchema]) - .nullable() .describe('The ID of the customer who will be billed.') .optional(), - /** The customer's address. Until the invoice is finalized, this field will equal `customer.address`. Once the invoice is finalized, this field will no longer be updated. */ - customer_address: AddressSchema.nullable() - .describe( - "The customer's address. Until the invoice is finalized, this field will equal `customer.address`. Once the invoice is finalized, this field will no longer be updated." - ) - .optional(), - /** The customer's email. Until the invoice is finalized, this field will equal `customer.email`. Once the invoice is finalized, this field will no longer be updated. */ + /**The customer's address. Until the invoice is finalized, this field will equal `customer.address`. Once the invoice is finalized, this field will no longer be updated.*/ + customer_address: AddressSchema.describe( + "The customer's address. Until the invoice is finalized, this field will equal `customer.address`. Once the invoice is finalized, this field will no longer be updated." + ).optional(), + /**The customer's email. Until the invoice is finalized, this field will equal `customer.email`. Once the invoice is finalized, this field will no longer be updated.*/ customer_email: z .string() .max(5000) - .nullable() .describe( "The customer's email. Until the invoice is finalized, this field will equal `customer.email`. Once the invoice is finalized, this field will no longer be updated." ) .optional(), - /** The customer's name. Until the invoice is finalized, this field will equal `customer.name`. Once the invoice is finalized, this field will no longer be updated. */ + /**The customer's name. Until the invoice is finalized, this field will equal `customer.name`. Once the invoice is finalized, this field will no longer be updated.*/ customer_name: z .string() .max(5000) - .nullable() .describe( "The customer's name. Until the invoice is finalized, this field will equal `customer.name`. Once the invoice is finalized, this field will no longer be updated." ) .optional(), - /** The customer's phone number. Until the invoice is finalized, this field will equal `customer.phone`. Once the invoice is finalized, this field will no longer be updated. */ + /**The customer's phone number. Until the invoice is finalized, this field will equal `customer.phone`. Once the invoice is finalized, this field will no longer be updated.*/ customer_phone: z .string() .max(5000) - .nullable() .describe( "The customer's phone number. Until the invoice is finalized, this field will equal `customer.phone`. Once the invoice is finalized, this field will no longer be updated." ) .optional(), - /** The customer's shipping information. Until the invoice is finalized, this field will equal `customer.shipping`. Once the invoice is finalized, this field will no longer be updated. */ - customer_shipping: ShippingSchema.nullable() - .describe( - "The customer's shipping information. Until the invoice is finalized, this field will equal `customer.shipping`. Once the invoice is finalized, this field will no longer be updated." - ) - .optional(), - /** The customer's tax exempt status. Until the invoice is finalized, this field will equal `customer.tax_exempt`. Once the invoice is finalized, this field will no longer be updated. */ + /**The customer's shipping information. Until the invoice is finalized, this field will equal `customer.shipping`. Once the invoice is finalized, this field will no longer be updated.*/ + customer_shipping: ShippingSchema.describe( + "The customer's shipping information. Until the invoice is finalized, this field will equal `customer.shipping`. Once the invoice is finalized, this field will no longer be updated." + ).optional(), + /**The customer's tax exempt status. Until the invoice is finalized, this field will equal `customer.tax_exempt`. Once the invoice is finalized, this field will no longer be updated.*/ customer_tax_exempt: z .enum(['exempt', 'none', 'reverse']) - .nullable() .describe( "The customer's tax exempt status. Until the invoice is finalized, this field will equal `customer.tax_exempt`. Once the invoice is finalized, this field will no longer be updated." ) .optional(), - /** The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as `customer.tax_ids`. Once the invoice is finalized, this field will no longer be updated. */ + /**The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as `customer.tax_ids`. Once the invoice is finalized, this field will no longer be updated.*/ customer_tax_ids: z .array(InvoicesResourceInvoiceTaxIdSchema) - .nullable() .describe( "The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as `customer.tax_ids`. Once the invoice is finalized, this field will no longer be updated." ) .optional(), - /** ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings. */ + /**ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.*/ default_payment_method: z .union([z.string().max(5000), PaymentMethodSchema]) - .nullable() .describe( "ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings." ) .optional(), - /** ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source. */ + /**ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.*/ default_source: z .union([ z.string().max(5000), @@ -33631,31 +31914,27 @@ export namespace stripe { CardSchema, SourceSchema ]) - .nullable() .describe( "ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source." ) .optional(), - /** The tax rates applied to this invoice, if any. */ + /**The tax rates applied to this invoice, if any.*/ default_tax_rates: z .array(TaxRateSchema) .describe('The tax rates applied to this invoice, if any.'), - /** An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. */ + /**An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.*/ description: z .string() .max(5000) - .nullable() .describe( "An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard." ) .optional(), - /** Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts. */ - discount: DiscountSchema.nullable() - .describe( - 'Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts.' - ) - .optional(), - /** The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. */ + /**Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts.*/ + discount: DiscountSchema.describe( + 'Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts.' + ).optional(), + /**The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.*/ discounts: z .array( z.union([z.string().max(5000), DiscountSchema, DeletedDiscountSchema]) @@ -33663,56 +31942,49 @@ export namespace stripe { .describe( 'The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.' ), - /** The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`. */ + /**The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`.*/ due_date: z .number() .int() - .nullable() .describe( 'The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`.' ) .optional(), - /** The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt. */ + /**The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.*/ effective_at: z .number() .int() - .nullable() .describe( "The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt." ) .optional(), - /** Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null. */ + /**Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.*/ ending_balance: z .number() .int() - .nullable() .describe( 'Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.' ) .optional(), - /** Footer displayed on the invoice. */ + /**Footer displayed on the invoice.*/ footer: z .string() .max(5000) - .nullable() .describe('Footer displayed on the invoice.') .optional(), - /** Details of the invoice that was cloned. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details. */ - from_invoice: InvoicesResourceFromInvoiceSchema.nullable() - .describe( - 'Details of the invoice that was cloned. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details.' - ) - .optional(), - /** The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null. */ + /**Details of the invoice that was cloned. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details.*/ + from_invoice: InvoicesResourceFromInvoiceSchema.describe( + 'Details of the invoice that was cloned. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details.' + ).optional(), + /**The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.*/ hosted_invoice_url: z .string() .max(5000) - .nullable() .describe( 'The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.' ) .optional(), - /** Unique identifier for the object. This property is always present unless the invoice is an upcoming invoice. See [Retrieve an upcoming invoice](https://stripe.com/docs/api/invoices/upcoming) for more details. */ + /**Unique identifier for the object. This property is always present unless the invoice is an upcoming invoice. See [Retrieve an upcoming invoice](https://stripe.com/docs/api/invoices/upcoming) for more details.*/ id: z .string() .max(5000) @@ -33720,52 +31992,48 @@ export namespace stripe { 'Unique identifier for the object. This property is always present unless the invoice is an upcoming invoice. See [Retrieve an upcoming invoice](https://stripe.com/docs/api/invoices/upcoming) for more details.' ) .optional(), - /** The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null. */ + /**The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.*/ invoice_pdf: z .string() .max(5000) - .nullable() .describe( 'The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.' ) .optional(), issuer: ConnectAccountReferenceSchema, - /** The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized. */ - last_finalization_error: ApiErrorsSchema.nullable() - .describe( - 'The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.' - ) - .optional(), - /** The ID of the most recent non-draft revision of this invoice */ + /**The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.*/ + last_finalization_error: ApiErrorsSchema.describe( + 'The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.' + ).optional(), + /**The ID of the most recent non-draft revision of this invoice*/ latest_revision: z .union([ z.string().max(5000), // TODO: Support recursive types for `InvoiceSchema`. z.any() ]) - .nullable() .describe( 'The ID of the most recent non-draft revision of this invoice' ) .optional(), - /** The individual line items that make up the invoice. `lines` is sorted as follows: (1) pending invoice items (including prorations) in reverse chronological order, (2) subscription items in reverse chronological order, and (3) invoice items added after invoice creation in chronological order. */ + /**The individual line items that make up the invoice. `lines` is sorted as follows: (1) pending invoice items (including prorations) in reverse chronological order, (2) subscription items in reverse chronological order, and (3) invoice items added after invoice creation in chronological order.*/ lines: z .object({ - /** Details about each object. */ + /**Details about each object.*/ data: z.array(LineItemSchema).describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -33774,172 +32042,156 @@ export namespace stripe { .describe( 'The individual line items that make up the invoice. `lines` is sorted as follows: (1) pending invoice items (including prorations) in reverse chronological order, (2) subscription items in reverse chronological order, and (3) invoice items added after invoice creation in chronological order.' ), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) - .nullable() .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ) .optional(), - /** The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`. */ + /**The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`.*/ next_payment_attempt: z .number() .int() - .nullable() .describe( 'The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`.' ) .optional(), - /** A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified. */ + /**A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.*/ number: z .string() .max(5000) - .nullable() .describe( "A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified." ) .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('invoice') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. */ + /**The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.*/ on_behalf_of: z .union([z.string().max(5000), AccountSchema]) - .nullable() .describe( 'The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.' ) .optional(), - /** Whether payment was successfully collected for this invoice. An invoice can be paid (most commonly) with a charge or with credit from the customer's account balance. */ + /**Whether payment was successfully collected for this invoice. An invoice can be paid (most commonly) with a charge or with credit from the customer's account balance.*/ paid: z .boolean() .describe( "Whether payment was successfully collected for this invoice. An invoice can be paid (most commonly) with a charge or with credit from the customer's account balance." ), - /** Returns true if the invoice was manually marked paid, returns false if the invoice hasn't been paid yet or was paid on Stripe. */ + /**Returns true if the invoice was manually marked paid, returns false if the invoice hasn't been paid yet or was paid on Stripe.*/ paid_out_of_band: z .boolean() .describe( "Returns true if the invoice was manually marked paid, returns false if the invoice hasn't been paid yet or was paid on Stripe." ), - /** The PaymentIntent associated with this invoice. The PaymentIntent is generated when the invoice is finalized, and can then be used to pay the invoice. Note that voiding an invoice will cancel the PaymentIntent. */ + /**The PaymentIntent associated with this invoice. The PaymentIntent is generated when the invoice is finalized, and can then be used to pay the invoice. Note that voiding an invoice will cancel the PaymentIntent.*/ payment_intent: z .union([z.string().max(5000), PaymentIntentSchema]) - .nullable() .describe( 'The PaymentIntent associated with this invoice. The PaymentIntent is generated when the invoice is finalized, and can then be used to pay the invoice. Note that voiding an invoice will cancel the PaymentIntent.' ) .optional(), payment_settings: InvoicesPaymentSettingsSchema, - /** End of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price. */ + /**End of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price.*/ period_end: z .number() .int() .describe( 'End of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price.' ), - /** Start of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price. */ + /**Start of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price.*/ period_start: z .number() .int() .describe( 'Start of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price.' ), - /** Total amount of all post-payment credit notes issued for this invoice. */ + /**Total amount of all post-payment credit notes issued for this invoice.*/ post_payment_credit_notes_amount: z .number() .int() .describe( 'Total amount of all post-payment credit notes issued for this invoice.' ), - /** Total amount of all pre-payment credit notes issued for this invoice. */ + /**Total amount of all pre-payment credit notes issued for this invoice.*/ pre_payment_credit_notes_amount: z .number() .int() .describe( 'Total amount of all pre-payment credit notes issued for this invoice.' ), - /** The quote this invoice was generated from. */ + /**The quote this invoice was generated from.*/ quote: z .union([z.string().max(5000), QuoteSchema]) - .nullable() .describe('The quote this invoice was generated from.') .optional(), - /** This is the transaction number that appears on email receipts sent for this invoice. */ + /**This is the transaction number that appears on email receipts sent for this invoice.*/ receipt_number: z .string() .max(5000) - .nullable() .describe( 'This is the transaction number that appears on email receipts sent for this invoice.' ) .optional(), - /** The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page. */ - rendering: InvoicesResourceInvoiceRenderingSchema.nullable() - .describe( - 'The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.' - ) - .optional(), - /** The details of the cost of shipping, including the ShippingRate applied on the invoice. */ - shipping_cost: InvoicesResourceShippingCostSchema.nullable() - .describe( - 'The details of the cost of shipping, including the ShippingRate applied on the invoice.' - ) - .optional(), - /** Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer. */ - shipping_details: ShippingSchema.nullable() - .describe( - 'Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer.' - ) - .optional(), - /** Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice. */ + /**The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.*/ + rendering: InvoicesResourceInvoiceRenderingSchema.describe( + 'The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.' + ).optional(), + /**The details of the cost of shipping, including the ShippingRate applied on the invoice.*/ + shipping_cost: InvoicesResourceShippingCostSchema.describe( + 'The details of the cost of shipping, including the ShippingRate applied on the invoice.' + ).optional(), + /**Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer.*/ + shipping_details: ShippingSchema.describe( + 'Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer.' + ).optional(), + /**Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.*/ starting_balance: z .number() .int() .describe( 'Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.' ), - /** Extra information about an invoice for the customer's credit card statement. */ + /**Extra information about an invoice for the customer's credit card statement.*/ statement_descriptor: z .string() .max(5000) - .nullable() .describe( "Extra information about an invoice for the customer's credit card statement." ) .optional(), - /** The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview) */ + /**The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview)*/ status: z .enum(['draft', 'open', 'paid', 'uncollectible', 'void']) - .nullable() .describe( 'The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview)' ) .optional(), status_transitions: InvoicesResourceStatusTransitionsSchema, - /** The subscription that this invoice was prepared for, if any. */ + /**The subscription that this invoice was prepared for, if any.*/ subscription: z .union([z.string().max(5000), SubscriptionSchema]) - .nullable() .describe( 'The subscription that this invoice was prepared for, if any.' ) .optional(), - /** Details about the subscription that created this invoice. */ - subscription_details: SubscriptionDetailsDataSchema.nullable() - .describe('Details about the subscription that created this invoice.') - .optional(), - /** Only set for upcoming invoices that preview prorations. The time used to calculate prorations. */ + /**Details about the subscription that created this invoice.*/ + subscription_details: SubscriptionDetailsDataSchema.describe( + 'Details about the subscription that created this invoice.' + ).optional(), + /**Only set for upcoming invoices that preview prorations. The time used to calculate prorations.*/ subscription_proration_date: z .number() .int() @@ -33947,82 +32199,73 @@ export namespace stripe { 'Only set for upcoming invoices that preview prorations. The time used to calculate prorations.' ) .optional(), - /** Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated */ + /**Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated*/ subtotal: z .number() .int() .describe( 'Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated' ), - /** The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated */ + /**The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated*/ subtotal_excluding_tax: z .number() .int() - .nullable() .describe( 'The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated' ) .optional(), - /** The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice. */ + /**The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice.*/ tax: z .number() .int() - .nullable() .describe( 'The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice.' ) .optional(), - /** ID of the test clock this invoice belongs to. */ + /**ID of the test clock this invoice belongs to.*/ test_clock: z .union([z.string().max(5000), TestHelpersTestClockSchema]) - .nullable() .describe('ID of the test clock this invoice belongs to.') .optional(), threshold_reason: InvoiceThresholdReasonSchema.optional(), - /** Total after discounts and taxes. */ + /**Total after discounts and taxes.*/ total: z.number().int().describe('Total after discounts and taxes.'), - /** The aggregate amounts calculated per discount across all line items. */ + /**The aggregate amounts calculated per discount across all line items.*/ total_discount_amounts: z .array(DiscountsResourceDiscountAmountSchema) - .nullable() .describe( 'The aggregate amounts calculated per discount across all line items.' ) .optional(), - /** The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax. */ + /**The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.*/ total_excluding_tax: z .number() .int() - .nullable() .describe( 'The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.' ) .optional(), - /** Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items. */ + /**Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.*/ total_pretax_credit_amounts: z .array(InvoicesResourcePretaxCreditAmountSchema) - .nullable() .describe( 'Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.' ) .optional(), - /** The aggregate amounts calculated per tax rate for all line items. */ + /**The aggregate amounts calculated per tax rate for all line items.*/ total_tax_amounts: z .array(InvoiceTaxAmountSchema) .describe( 'The aggregate amounts calculated per tax rate for all line items.' ), - /** The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to for the invoice. */ - transfer_data: InvoiceTransferDataSchema.nullable() - .describe( - 'The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to for the invoice.' - ) - .optional(), - /** Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://stripe.com/docs/billing/webhooks#understand). This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created. */ + /**The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to for the invoice.*/ + transfer_data: InvoiceTransferDataSchema.describe( + 'The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to for the invoice.' + ).optional(), + /**Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://stripe.com/docs/billing/webhooks#understand). This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.*/ webhooks_delivered_at: z .number() .int() - .nullable() .describe( 'Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://stripe.com/docs/billing/webhooks#understand). This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.' ) @@ -34041,45 +32284,43 @@ export namespace stripe { */ export const TaxIdSchema = z .object({ - /** Two-letter ISO code representing the country of the tax ID. */ + /**Two-letter ISO code representing the country of the tax ID.*/ country: z .string() .max(5000) - .nullable() .describe('Two-letter ISO code representing the country of the tax ID.') .optional(), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** ID of the customer. */ + /**ID of the customer.*/ customer: z .union([z.string().max(5000), CustomerSchema]) - .nullable() .describe('ID of the customer.') .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('tax_id') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The account or customer the tax ID belongs to. */ - owner: TaxIDsOwnerSchema.nullable() - .describe('The account or customer the tax ID belongs to.') - .optional(), - /** Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`. Note that some legacy tax IDs have type `unknown` */ + /**The account or customer the tax ID belongs to.*/ + owner: TaxIDsOwnerSchema.describe( + 'The account or customer the tax ID belongs to.' + ).optional(), + /**Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`. Note that some legacy tax IDs have type `unknown`*/ type: z .enum([ 'ad_nrt', @@ -34187,12 +32428,12 @@ export namespace stripe { .describe( 'Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`. Note that some legacy tax IDs have type `unknown`' ), - /** Value of the tax ID. */ + /**Value of the tax ID.*/ value: z.string().max(5000).describe('Value of the tax ID.'), - /** Tax ID verification information. */ - verification: TaxIdVerificationSchema.nullable() - .describe('Tax ID verification information.') - .optional() + /**Tax ID verification information.*/ + verification: TaxIdVerificationSchema.describe( + 'Tax ID verification information.' + ).optional() }) .describe( 'You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers) or account.\nCustomer and account tax IDs get displayed on related invoices and credit notes.\n\nRelated guides: [Customer tax identification numbers](https://stripe.com/docs/billing/taxes/tax-ids), [Account tax IDs](https://stripe.com/docs/invoicing/connect#account-tax-ids)' @@ -34200,24 +32441,24 @@ export namespace stripe { export type TaxId = z.infer export const TaxIDsOwnerSchema = z.object({ - /** The account being referenced when `type` is `account`. */ + /**The account being referenced when `type` is `account`.*/ account: z .union([z.string().max(5000), AccountSchema]) .describe('The account being referenced when `type` is `account`.') .optional(), - /** The Connect Application being referenced when `type` is `application`. */ + /**The Connect Application being referenced when `type` is `application`.*/ application: z .union([z.string().max(5000), ApplicationSchema]) .describe( 'The Connect Application being referenced when `type` is `application`.' ) .optional(), - /** The customer being referenced when `type` is `customer`. */ + /**The customer being referenced when `type` is `customer`.*/ customer: z .union([z.string().max(5000), CustomerSchema]) .describe('The customer being referenced when `type` is `customer`.') .optional(), - /** Type of owner referenced. */ + /**Type of owner referenced.*/ type: z .enum(['account', 'application', 'customer', 'self']) .describe('Type of owner referenced.') @@ -34225,31 +32466,27 @@ export namespace stripe { export type TaxIDsOwner = z.infer export const AutomaticTaxSchema = z.object({ - /** If Stripe disabled automatic tax, this enum describes why. */ + /**If Stripe disabled automatic tax, this enum describes why.*/ disabled_reason: z .enum([ 'finalization_requires_location_inputs', 'finalization_system_error' ]) - .nullable() .describe('If Stripe disabled automatic tax, this enum describes why.') .optional(), - /** Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices. */ + /**Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.*/ enabled: z .boolean() .describe( 'Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.' ), - /** The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. */ - liability: ConnectAccountReferenceSchema.nullable() - .describe( - "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account." - ) - .optional(), - /** The status of the most recent automated tax calculation for this invoice. */ + /**The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.*/ + liability: ConnectAccountReferenceSchema.describe( + "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account." + ).optional(), + /**The status of the most recent automated tax calculation for this invoice.*/ status: z .enum(['complete', 'failed', 'requires_location_inputs']) - .nullable() .describe( 'The status of the most recent automated tax calculation for this invoice.' ) @@ -34258,14 +32495,14 @@ export namespace stripe { export type AutomaticTax = z.infer export const ConnectAccountReferenceSchema = z.object({ - /** The connected account being referenced when `type` is `account`. */ + /**The connected account being referenced when `type` is `account`.*/ account: z .union([z.string().max(5000), AccountSchema]) .describe( 'The connected account being referenced when `type` is `account`.' ) .optional(), - /** Type of the account referenced. */ + /**Type of the account referenced.*/ type: z .enum(['account', 'self']) .describe('Type of the account referenced.') @@ -34282,275 +32519,251 @@ export namespace stripe { */ export const ChargeSchema = z .object({ - /** Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). */ + /**Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).*/ amount: z .number() .int() .describe( 'Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).' ), - /** Amount in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made). */ + /**Amount in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made).*/ amount_captured: z .number() .int() .describe( 'Amount in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made).' ), - /** Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued). */ + /**Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued).*/ amount_refunded: z .number() .int() .describe( 'Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued).' ), - /** ID of the Connect application that created the charge. */ + /**ID of the Connect application that created the charge.*/ application: z .union([z.string().max(5000), ApplicationSchema]) - .nullable() .describe('ID of the Connect application that created the charge.') .optional(), - /** The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details. */ + /**The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details.*/ application_fee: z .union([z.string().max(5000), ApplicationFeeSchema]) - .nullable() .describe( 'The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details.' ) .optional(), - /** The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details. */ + /**The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details.*/ application_fee_amount: z .number() .int() - .nullable() .describe( 'The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details.' ) .optional(), - /** ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes). */ + /**ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes).*/ balance_transaction: z .union([z.string().max(5000), BalanceTransactionSchema]) - .nullable() .describe( 'ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes).' ) .optional(), billing_details: BillingDetailsSchema, - /** The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. This value only exists for card payments. */ + /**The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. This value only exists for card payments.*/ calculated_statement_descriptor: z .string() .max(5000) - .nullable() .describe( "The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. This value only exists for card payments." ) .optional(), - /** If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured. */ + /**If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured.*/ captured: z .boolean() .describe( 'If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured.' ), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** ID of the customer this charge is for if one exists. */ + /**ID of the customer this charge is for if one exists.*/ customer: z .union([z.string().max(5000), CustomerSchema, DeletedCustomerSchema]) - .nullable() .describe('ID of the customer this charge is for if one exists.') .optional(), - /** An arbitrary string attached to the object. Often useful for displaying to users. */ + /**An arbitrary string attached to the object. Often useful for displaying to users.*/ description: z .string() .max(40_000) - .nullable() .describe( 'An arbitrary string attached to the object. Often useful for displaying to users.' ) .optional(), - /** Whether the charge has been disputed. */ + /**Whether the charge has been disputed.*/ disputed: z.boolean().describe('Whether the charge has been disputed.'), - /** ID of the balance transaction that describes the reversal of the balance on your account due to payment failure. */ + /**ID of the balance transaction that describes the reversal of the balance on your account due to payment failure.*/ failure_balance_transaction: z .union([z.string().max(5000), BalanceTransactionSchema]) - .nullable() .describe( 'ID of the balance transaction that describes the reversal of the balance on your account due to payment failure.' ) .optional(), - /** Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/docs/error-codes) for a list of codes). */ + /**Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/docs/error-codes) for a list of codes).*/ failure_code: z .string() .max(5000) - .nullable() .describe( 'Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/docs/error-codes) for a list of codes).' ) .optional(), - /** Message to user further explaining reason for charge failure if available. */ + /**Message to user further explaining reason for charge failure if available.*/ failure_message: z .string() .max(5000) - .nullable() .describe( 'Message to user further explaining reason for charge failure if available.' ) .optional(), - /** Information on fraud assessments for the charge. */ - fraud_details: ChargeFraudDetailsSchema.nullable() - .describe('Information on fraud assessments for the charge.') - .optional(), - /** Unique identifier for the object. */ + /**Information on fraud assessments for the charge.*/ + fraud_details: ChargeFraudDetailsSchema.describe( + 'Information on fraud assessments for the charge.' + ).optional(), + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** ID of the invoice this charge is for if one exists. */ + /**ID of the invoice this charge is for if one exists.*/ invoice: z .union([z.string().max(5000), InvoiceSchema]) - .nullable() .describe('ID of the invoice this charge is for if one exists.') .optional(), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('charge') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details. */ + /**The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.*/ on_behalf_of: z .union([z.string().max(5000), AccountSchema]) - .nullable() .describe( 'The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.' ) .optional(), - /** Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/docs/declines) for details. */ - outcome: ChargeOutcomeSchema.nullable() - .describe( - 'Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/docs/declines) for details.' - ) - .optional(), - /** `true` if the charge succeeded, or was successfully authorized for later capture. */ + /**Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/docs/declines) for details.*/ + outcome: ChargeOutcomeSchema.describe( + 'Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/docs/declines) for details.' + ).optional(), + /**`true` if the charge succeeded, or was successfully authorized for later capture.*/ paid: z .boolean() .describe( '`true` if the charge succeeded, or was successfully authorized for later capture.' ), - /** ID of the PaymentIntent associated with this charge, if one exists. */ + /**ID of the PaymentIntent associated with this charge, if one exists.*/ payment_intent: z .union([z.string().max(5000), PaymentIntentSchema]) - .nullable() .describe( 'ID of the PaymentIntent associated with this charge, if one exists.' ) .optional(), - /** ID of the payment method used in this charge. */ + /**ID of the payment method used in this charge.*/ payment_method: z .string() .max(5000) - .nullable() .describe('ID of the payment method used in this charge.') .optional(), - /** Details about the payment method at the time of the transaction. */ - payment_method_details: PaymentMethodDetailsSchema.nullable() - .describe( - 'Details about the payment method at the time of the transaction.' - ) - .optional(), + /**Details about the payment method at the time of the transaction.*/ + payment_method_details: PaymentMethodDetailsSchema.describe( + 'Details about the payment method at the time of the transaction.' + ).optional(), radar_options: RadarRadarOptionsSchema.optional(), - /** This is the email address that the receipt for this charge was sent to. */ + /**This is the email address that the receipt for this charge was sent to.*/ receipt_email: z .string() .max(5000) - .nullable() .describe( 'This is the email address that the receipt for this charge was sent to.' ) .optional(), - /** This is the transaction number that appears on email receipts sent for this charge. This attribute will be `null` until a receipt has been sent. */ + /**This is the transaction number that appears on email receipts sent for this charge. This attribute will be `null` until a receipt has been sent.*/ receipt_number: z .string() .max(5000) - .nullable() .describe( 'This is the transaction number that appears on email receipts sent for this charge. This attribute will be `null` until a receipt has been sent.' ) .optional(), - /** This is the URL to view the receipt for this charge. The receipt is kept up-to-date to the latest state of the charge, including any refunds. If the charge is for an Invoice, the receipt will be stylized as an Invoice receipt. */ + /**This is the URL to view the receipt for this charge. The receipt is kept up-to-date to the latest state of the charge, including any refunds. If the charge is for an Invoice, the receipt will be stylized as an Invoice receipt.*/ receipt_url: z .string() .max(5000) - .nullable() .describe( 'This is the URL to view the receipt for this charge. The receipt is kept up-to-date to the latest state of the charge, including any refunds. If the charge is for an Invoice, the receipt will be stylized as an Invoice receipt.' ) .optional(), - /** Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false. */ + /**Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.*/ refunded: z .boolean() .describe( 'Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.' ), - /** A list of refunds that have been applied to the charge. */ + /**A list of refunds that have been applied to the charge.*/ refunds: z .object({ - /** Details about each object. */ + /**Details about each object.*/ data: z.array(RefundSchema).describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) .describe('The URL where this list can be accessed.') }) - .nullable() .describe('A list of refunds that have been applied to the charge.') .optional(), - /** ID of the review associated with this charge if one exists. */ + /**ID of the review associated with this charge if one exists.*/ review: z .union([z.string().max(5000), ReviewSchema]) - .nullable() .describe('ID of the review associated with this charge if one exists.') .optional(), - /** Shipping information for the charge. */ - shipping: ShippingSchema.nullable() - .describe('Shipping information for the charge.') - .optional(), - /** The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details. */ + /**Shipping information for the charge.*/ + shipping: ShippingSchema.describe( + 'Shipping information for the charge.' + ).optional(), + /**The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details.*/ source_transfer: z .union([z.string().max(5000), TransferSchema]) - .nullable() .describe( 'The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details.' ) @@ -34563,44 +32776,39 @@ export namespace stripe { statement_descriptor: z .string() .max(5000) - .nullable() .describe( "For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nFor a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix." ) .optional(), - /** Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor. */ + /**Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor.*/ statement_descriptor_suffix: z .string() .max(5000) - .nullable() .describe( "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor." ) .optional(), - /** The status of the payment is either `succeeded`, `pending`, or `failed`. */ + /**The status of the payment is either `succeeded`, `pending`, or `failed`.*/ status: z .enum(['failed', 'pending', 'succeeded']) .describe( 'The status of the payment is either `succeeded`, `pending`, or `failed`.' ), - /** ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter). */ + /**ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter).*/ transfer: z .union([z.string().max(5000), TransferSchema]) .describe( 'ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter).' ) .optional(), - /** An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details. */ - transfer_data: ChargeTransferDataSchema.nullable() - .describe( - 'An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.' - ) - .optional(), - /** A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details. */ + /**An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.*/ + transfer_data: ChargeTransferDataSchema.describe( + 'An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.' + ).optional(), + /**A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.*/ transfer_group: z .string() .max(5000) - .nullable() .describe( 'A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.' ) @@ -34612,103 +32820,99 @@ export namespace stripe { export type Charge = z.infer export const ApplicationFeeSchema = z.object({ - /** ID of the Stripe account this fee was taken from. */ + /**ID of the Stripe account this fee was taken from.*/ account: z .union([z.string().max(5000), AccountSchema]) .describe('ID of the Stripe account this fee was taken from.'), - /** Amount earned, in cents (or local equivalent). */ + /**Amount earned, in cents (or local equivalent).*/ amount: z .number() .int() .describe('Amount earned, in cents (or local equivalent).'), - /** Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the fee if a partial refund was issued) */ + /**Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the fee if a partial refund was issued)*/ amount_refunded: z .number() .int() .describe( 'Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the fee if a partial refund was issued)' ), - /** ID of the Connect application that earned the fee. */ + /**ID of the Connect application that earned the fee.*/ application: z .union([z.string().max(5000), ApplicationSchema]) .describe('ID of the Connect application that earned the fee.'), - /** Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds). */ + /**Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds).*/ balance_transaction: z .union([z.string().max(5000), BalanceTransactionSchema]) - .nullable() .describe( 'Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds).' ) .optional(), - /** ID of the charge that the application fee was taken from. */ + /**ID of the charge that the application fee was taken from.*/ charge: z .union([z.string().max(5000), ChargeSchema]) .describe('ID of the charge that the application fee was taken from.'), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** Polymorphic source of the application fee. Includes the ID of the object the application fee was created from. */ - fee_source: PlatformEarningFeeSourceSchema.nullable() - .describe( - 'Polymorphic source of the application fee. Includes the ID of the object the application fee was created from.' - ) - .optional(), - /** Unique identifier for the object. */ + /**Polymorphic source of the application fee. Includes the ID of the object the application fee was created from.*/ + fee_source: PlatformEarningFeeSourceSchema.describe( + 'Polymorphic source of the application fee. Includes the ID of the object the application fee was created from.' + ).optional(), + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('application_fee') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter. */ + /**ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter.*/ originating_transaction: z .union([z.string().max(5000), ChargeSchema]) - .nullable() .describe( 'ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter.' ) .optional(), - /** Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false. */ + /**Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false.*/ refunded: z .boolean() .describe( 'Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false.' ), - /** A list of refunds that have been applied to the fee. */ + /**A list of refunds that have been applied to the fee.*/ refunds: z .object({ - /** Details about each object. */ + /**Details about each object.*/ data: z.array(FeeRefundSchema).describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -34726,86 +32930,84 @@ export namespace stripe { */ export const BalanceTransactionSchema = z .object({ - /** Gross amount of this transaction (in cents (or local equivalent)). A positive value represents funds charged to another party, and a negative value represents funds sent to another party. */ + /**Gross amount of this transaction (in cents (or local equivalent)). A positive value represents funds charged to another party, and a negative value represents funds sent to another party.*/ amount: z .number() .int() .describe( 'Gross amount of this transaction (in cents (or local equivalent)). A positive value represents funds charged to another party, and a negative value represents funds sent to another party.' ), - /** The date that the transaction's net funds become available in the Stripe balance. */ + /**The date that the transaction's net funds become available in the Stripe balance.*/ available_on: z .number() .int() .describe( "The date that the transaction's net funds become available in the Stripe balance." ), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** An arbitrary string attached to the object. Often useful for displaying to users. */ + /**An arbitrary string attached to the object. Often useful for displaying to users.*/ description: z .string() .max(5000) - .nullable() .describe( 'An arbitrary string attached to the object. Often useful for displaying to users.' ) .optional(), - /** If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then the `amount` in currency A, multipled by the `exchange_rate`, equals the `amount` in currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent's `amount` is `1000` and `currency` is `eur`. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction's `amount` is `1234`, its `currency` is `usd`, and the `exchange_rate` is `1.234`. */ + /**If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then the `amount` in currency A, multipled by the `exchange_rate`, equals the `amount` in currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent's `amount` is `1000` and `currency` is `eur`. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction's `amount` is `1234`, its `currency` is `usd`, and the `exchange_rate` is `1.234`.*/ exchange_rate: z .number() - .nullable() .describe( "If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then the `amount` in currency A, multipled by the `exchange_rate`, equals the `amount` in currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent's `amount` is `1000` and `currency` is `eur`. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction's `amount` is `1234`, its `currency` is `usd`, and the `exchange_rate` is `1.234`." ) .optional(), - /** Fees (in cents (or local equivalent)) paid for this transaction. Represented as a positive integer when assessed. */ + /**Fees (in cents (or local equivalent)) paid for this transaction. Represented as a positive integer when assessed.*/ fee: z .number() .int() .describe( 'Fees (in cents (or local equivalent)) paid for this transaction. Represented as a positive integer when assessed.' ), - /** Detailed breakdown of fees (in cents (or local equivalent)) paid for this transaction. */ + /**Detailed breakdown of fees (in cents (or local equivalent)) paid for this transaction.*/ fee_details: z .array(FeeSchema) .describe( 'Detailed breakdown of fees (in cents (or local equivalent)) paid for this transaction.' ), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Net impact to a Stripe balance (in cents (or local equivalent)). A positive value represents incrementing a Stripe balance, and a negative value decrementing a Stripe balance. You can calculate the net impact of a transaction on a balance by `amount` - `fee` */ + /**Net impact to a Stripe balance (in cents (or local equivalent)). A positive value represents incrementing a Stripe balance, and a negative value decrementing a Stripe balance. You can calculate the net impact of a transaction on a balance by `amount` - `fee`*/ net: z .number() .int() .describe( 'Net impact to a Stripe balance (in cents (or local equivalent)). A positive value represents incrementing a Stripe balance, and a negative value decrementing a Stripe balance. You can calculate the net impact of a transaction on a balance by `amount` - `fee`' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('balance_transaction') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** Learn more about how [reporting categories](https://stripe.com/docs/reports/reporting-categories) can help you understand balance transactions from an accounting perspective. */ + /**Learn more about how [reporting categories](https://stripe.com/docs/reports/reporting-categories) can help you understand balance transactions from an accounting perspective.*/ reporting_category: z .string() .max(5000) .describe( 'Learn more about how [reporting categories](https://stripe.com/docs/reports/reporting-categories) can help you understand balance transactions from an accounting perspective.' ), - /** This transaction relates to the Stripe object. */ + /**This transaction relates to the Stripe object.*/ source: z .union([ z.string().max(5000), @@ -34826,17 +33028,16 @@ export namespace stripe { TransferSchema, TransferReversalSchema ]) - .nullable() .describe('This transaction relates to the Stripe object.') .optional(), - /** The transaction's net funds status in the Stripe balance, which are either `available` or `pending`. */ + /**The transaction's net funds status in the Stripe balance, which are either `available` or `pending`.*/ status: z .string() .max(5000) .describe( "The transaction's net funds status in the Stripe balance, which are either `available` or `pending`." ), - /** Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead. */ + /**Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead.*/ type: z .enum([ 'adjustment', @@ -34892,30 +33093,30 @@ export namespace stripe { export type BalanceTransaction = z.infer export const ConnectCollectionTransferSchema = z.object({ - /** Amount transferred, in cents (or local equivalent). */ + /**Amount transferred, in cents (or local equivalent).*/ amount: z .number() .int() .describe('Amount transferred, in cents (or local equivalent).'), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** ID of the account that funds are being collected for. */ + /**ID of the account that funds are being collected for.*/ destination: z .union([z.string().max(5000), AccountSchema]) .describe('ID of the account that funds are being collected for.'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('connect_collection_transfer') .describe( @@ -34938,27 +33139,27 @@ export namespace stripe { CustomerBalanceResourceCashBalanceTransactionResourceAdjustedForOverdraftSchema.optional(), applied_to_payment: CustomerBalanceResourceCashBalanceTransactionResourceAppliedToPaymentTransactionSchema.optional(), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .max(5000) .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** The customer whose available cash balance changed as a result of this transaction. */ + /**The customer whose available cash balance changed as a result of this transaction.*/ customer: z .union([z.string().max(5000), CustomerSchema]) .describe( 'The customer whose available cash balance changed as a result of this transaction.' ), - /** The total available cash balance for the specified currency after this transaction was applied. Represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /**The total available cash balance for the specified currency after this transaction was applied. Represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).*/ ending_balance: z .number() .int() @@ -34967,22 +33168,22 @@ export namespace stripe { ), funded: CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionSchema.optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** The amount by which the cash balance changed, represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance. */ + /**The amount by which the cash balance changed, represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance.*/ net_amount: z .number() .int() .describe( 'The amount by which the cash balance changed, represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('customer_cash_balance_transaction') .describe( @@ -34992,7 +33193,7 @@ export namespace stripe { CustomerBalanceResourceCashBalanceTransactionResourceRefundedFromPaymentTransactionSchema.optional(), transferred_to_balance: CustomerBalanceResourceCashBalanceTransactionResourceTransferredToBalanceSchema.optional(), - /** The type of the cash balance transaction. New types may be added in future. See [Customer Balance](https://stripe.com/docs/payments/customer-balance#types) to learn more about these types. */ + /**The type of the cash balance transaction. New types may be added in future. See [Customer Balance](https://stripe.com/docs/payments/customer-balance#types) to learn more about these types.*/ type: z .enum([ 'adjusted_for_overdraft', @@ -35020,13 +33221,13 @@ export namespace stripe { export const CustomerBalanceResourceCashBalanceTransactionResourceAdjustedForOverdraftSchema = z.object({ - /** The [Balance Transaction](https://stripe.com/docs/api/balance_transactions/object) that corresponds to funds taken out of your Stripe balance. */ + /**The [Balance Transaction](https://stripe.com/docs/api/balance_transactions/object) that corresponds to funds taken out of your Stripe balance.*/ balance_transaction: z .union([z.string().max(5000), BalanceTransactionSchema]) .describe( 'The [Balance Transaction](https://stripe.com/docs/api/balance_transactions/object) that corresponds to funds taken out of your Stripe balance.' ), - /** The [Cash Balance Transaction](https://stripe.com/docs/api/cash_balance_transactions/object) that brought the customer balance negative, triggering the clawback of funds. */ + /**The [Cash Balance Transaction](https://stripe.com/docs/api/cash_balance_transactions/object) that brought the customer balance negative, triggering the clawback of funds.*/ linked_transaction: z .union([z.string().max(5000), CustomerCashBalanceTransactionSchema]) .describe( @@ -35040,7 +33241,7 @@ export namespace stripe { export const CustomerBalanceResourceCashBalanceTransactionResourceAppliedToPaymentTransactionSchema = z.object({ - /** The [Payment Intent](https://stripe.com/docs/api/payment_intents/object) that funds were applied to. */ + /**The [Payment Intent](https://stripe.com/docs/api/payment_intents/object) that funds were applied to.*/ payment_intent: z .union([z.string().max(5000), PaymentIntentSchema]) .describe( @@ -35054,7 +33255,7 @@ export namespace stripe { export const CustomerBalanceResourceCashBalanceTransactionResourceRefundedFromPaymentTransactionSchema = z.object({ - /** The [Refund](https://stripe.com/docs/api/refunds/object) that moved these funds into the customer's cash balance. */ + /**The [Refund](https://stripe.com/docs/api/refunds/object) that moved these funds into the customer's cash balance.*/ refund: z .union([z.string().max(5000), RefundSchema]) .describe( @@ -35075,39 +33276,37 @@ export namespace stripe { */ export const RefundSchema = z .object({ - /** Amount, in cents (or local equivalent). */ + /**Amount, in cents (or local equivalent).*/ amount: z .number() .int() .describe('Amount, in cents (or local equivalent).'), - /** Balance transaction that describes the impact on your account balance. */ + /**Balance transaction that describes the impact on your account balance.*/ balance_transaction: z .union([z.string().max(5000), BalanceTransactionSchema]) - .nullable() .describe( 'Balance transaction that describes the impact on your account balance.' ) .optional(), - /** ID of the charge that's refunded. */ + /**ID of the charge that's refunded.*/ charge: z .union([z.string().max(5000), ChargeSchema]) - .nullable() .describe("ID of the charge that's refunded.") .optional(), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** An arbitrary string attached to the object. You can use this for displaying to users (available on non-card refunds only). */ + /**An arbitrary string attached to the object. You can use this for displaying to users (available on non-card refunds only).*/ description: z .string() .max(5000) @@ -35116,14 +33315,14 @@ export namespace stripe { ) .optional(), destination_details: RefundDestinationDetailsSchema.optional(), - /** After the refund fails, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction. */ + /**After the refund fails, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction.*/ failure_balance_transaction: z .union([z.string().max(5000), BalanceTransactionSchema]) .describe( 'After the refund fails, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction.' ) .optional(), - /** Provides the reason for the refund failure. Possible values are: `lost_or_stolen_card`, `expired_or_canceled_card`, `charge_for_pending_refund_disputed`, `insufficient_funds`, `declined`, `merchant_request`, or `unknown`. */ + /**Provides the reason for the refund failure. Possible values are: `lost_or_stolen_card`, `expired_or_canceled_card`, `charge_for_pending_refund_disputed`, `insufficient_funds`, `declined`, `merchant_request`, or `unknown`.*/ failure_reason: z .string() .max(5000) @@ -35131,9 +33330,9 @@ export namespace stripe { 'Provides the reason for the refund failure. Possible values are: `lost_or_stolen_card`, `expired_or_canceled_card`, `charge_for_pending_refund_disputed`, `insufficient_funds`, `declined`, `merchant_request`, or `unknown`.' ) .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** For payment methods without native refund support (for example, Konbini, PromptPay), provide an email address for the customer to receive refund instructions. */ + /**For payment methods without native refund support (for example, Konbini, PromptPay), provide an email address for the customer to receive refund instructions.*/ instructions_email: z .string() .max(5000) @@ -35141,28 +33340,26 @@ export namespace stripe { 'For payment methods without native refund support (for example, Konbini, PromptPay), provide an email address for the customer to receive refund instructions.' ) .optional(), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) - .nullable() .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ) .optional(), next_action: RefundNextActionSchema.optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('refund') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** ID of the PaymentIntent that's refunded. */ + /**ID of the PaymentIntent that's refunded.*/ payment_intent: z .union([z.string().max(5000), PaymentIntentSchema]) - .nullable() .describe("ID of the PaymentIntent that's refunded.") .optional(), - /** Reason for the refund, which is either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`). */ + /**Reason for the refund, which is either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`).*/ reason: z .enum([ 'duplicate', @@ -35170,41 +33367,36 @@ export namespace stripe { 'fraudulent', 'requested_by_customer' ]) - .nullable() .describe( 'Reason for the refund, which is either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`).' ) .optional(), - /** This is the transaction number that appears on email receipts sent for this refund. */ + /**This is the transaction number that appears on email receipts sent for this refund.*/ receipt_number: z .string() .max(5000) - .nullable() .describe( 'This is the transaction number that appears on email receipts sent for this refund.' ) .optional(), - /** The transfer reversal that's associated with the refund. Only present if the charge came from another Stripe account. */ + /**The transfer reversal that's associated with the refund. Only present if the charge came from another Stripe account.*/ source_transfer_reversal: z .union([z.string().max(5000), TransferReversalSchema]) - .nullable() .describe( "The transfer reversal that's associated with the refund. Only present if the charge came from another Stripe account." ) .optional(), - /** Status of the refund. This can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Learn more about [failed refunds](https://stripe.com/docs/refunds#failed-refunds). */ + /**Status of the refund. This can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Learn more about [failed refunds](https://stripe.com/docs/refunds#failed-refunds).*/ status: z .string() .max(5000) - .nullable() .describe( 'Status of the refund. This can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Learn more about [failed refunds](https://stripe.com/docs/refunds#failed-refunds).' ) .optional(), - /** This refers to the transfer reversal object if the accompanying transfer reverses. This is only applicable if the charge was created using the destination parameter. */ + /**This refers to the transfer reversal object if the accompanying transfer reverses. This is only applicable if the charge was created using the destination parameter.*/ transfer_reversal: z .union([z.string().max(5000), TransferReversalSchema]) - .nullable() .describe( 'This refers to the transfer reversal object if the accompanying transfer reverses. This is only applicable if the charge was created using the destination parameter.' ) @@ -35232,61 +33424,57 @@ export namespace stripe { */ export const TransferReversalSchema = z .object({ - /** Amount, in cents (or local equivalent). */ + /**Amount, in cents (or local equivalent).*/ amount: z .number() .int() .describe('Amount, in cents (or local equivalent).'), - /** Balance transaction that describes the impact on your account balance. */ + /**Balance transaction that describes the impact on your account balance.*/ balance_transaction: z .union([z.string().max(5000), BalanceTransactionSchema]) - .nullable() .describe( 'Balance transaction that describes the impact on your account balance.' ) .optional(), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** Linked payment refund for the transfer reversal. */ + /**Linked payment refund for the transfer reversal.*/ destination_payment_refund: z .union([z.string().max(5000), RefundSchema]) - .nullable() .describe('Linked payment refund for the transfer reversal.') .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) - .nullable() .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ) .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('transfer_reversal') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** ID of the refund responsible for the transfer reversal. */ + /**ID of the refund responsible for the transfer reversal.*/ source_refund: z .union([z.string().max(5000), RefundSchema]) - .nullable() .describe('ID of the refund responsible for the transfer reversal.') .optional(), - /** ID of the transfer that was reversed. */ + /**ID of the transfer that was reversed.*/ transfer: z .union([z.string().max(5000), TransferSchema]) .describe('ID of the transfer that was reversed.') @@ -35310,99 +33498,96 @@ export namespace stripe { */ export const TransferSchema = z .object({ - /** Amount in cents (or local equivalent) to be transferred. */ + /**Amount in cents (or local equivalent) to be transferred.*/ amount: z .number() .int() .describe('Amount in cents (or local equivalent) to be transferred.'), - /** Amount in cents (or local equivalent) reversed (can be less than the amount attribute on the transfer if a partial reversal was issued). */ + /**Amount in cents (or local equivalent) reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).*/ amount_reversed: z .number() .int() .describe( 'Amount in cents (or local equivalent) reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).' ), - /** Balance transaction that describes the impact of this transfer on your account balance. */ + /**Balance transaction that describes the impact of this transfer on your account balance.*/ balance_transaction: z .union([z.string().max(5000), BalanceTransactionSchema]) - .nullable() .describe( 'Balance transaction that describes the impact of this transfer on your account balance.' ) .optional(), - /** Time that this record of the transfer was first created. */ + /**Time that this record of the transfer was first created.*/ created: z .number() .int() .describe('Time that this record of the transfer was first created.'), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** An arbitrary string attached to the object. Often useful for displaying to users. */ + /**An arbitrary string attached to the object. Often useful for displaying to users.*/ description: z .string() .max(5000) - .nullable() .describe( 'An arbitrary string attached to the object. Often useful for displaying to users.' ) .optional(), - /** ID of the Stripe account the transfer was sent to. */ + /**ID of the Stripe account the transfer was sent to.*/ destination: z .union([z.string().max(5000), AccountSchema]) - .nullable() .describe('ID of the Stripe account the transfer was sent to.') .optional(), - /** If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer. */ + /**If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.*/ destination_payment: z .union([z.string().max(5000), ChargeSchema]) .describe( 'If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.' ) .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('transfer') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** A list of reversals that have been applied to the transfer. */ + /**A list of reversals that have been applied to the transfer.*/ reversals: z .object({ - /** Details about each object. */ + /**Details about each object.*/ data: z .array(TransferReversalSchema) .describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -35411,21 +33596,20 @@ export namespace stripe { .describe( 'A list of reversals that have been applied to the transfer.' ), - /** Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false. */ + /**Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.*/ reversed: z .boolean() .describe( 'Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.' ), - /** ID of the charge that was used to fund the transfer. If null, the transfer was funded from the available balance. */ + /**ID of the charge that was used to fund the transfer. If null, the transfer was funded from the available balance.*/ source_transaction: z .union([z.string().max(5000), ChargeSchema]) - .nullable() .describe( 'ID of the charge that was used to fund the transfer. If null, the transfer was funded from the available balance.' ) .optional(), - /** The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`. */ + /**The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`.*/ source_type: z .string() .max(5000) @@ -35433,11 +33617,10 @@ export namespace stripe { 'The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`.' ) .optional(), - /** A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details. */ + /**A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.*/ transfer_group: z .string() .max(5000) - .nullable() .describe( 'A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.' ) @@ -35450,7 +33633,7 @@ export namespace stripe { export const CustomerBalanceResourceCashBalanceTransactionResourceTransferredToBalanceSchema = z.object({ - /** The [Balance Transaction](https://stripe.com/docs/api/balance_transactions/object) that corresponds to funds transferred to your Stripe balance. */ + /**The [Balance Transaction](https://stripe.com/docs/api/balance_transactions/object) that corresponds to funds transferred to your Stripe balance.*/ balance_transaction: z .union([z.string().max(5000), BalanceTransactionSchema]) .describe( @@ -35464,7 +33647,7 @@ export namespace stripe { export const CustomerBalanceResourceCashBalanceTransactionResourceUnappliedFromPaymentTransactionSchema = z.object({ - /** The [Payment Intent](https://stripe.com/docs/api/payment_intents/object) that funds were unapplied from. */ + /**The [Payment Intent](https://stripe.com/docs/api/payment_intents/object) that funds were unapplied from.*/ payment_intent: z .union([z.string().max(5000), PaymentIntentSchema]) .describe( @@ -35485,37 +33668,37 @@ export namespace stripe { */ export const DisputeSchema = z .object({ - /** Disputed amount. Usually the amount of the charge, but it can differ (usually because of currency fluctuation or because only part of the order is disputed). */ + /**Disputed amount. Usually the amount of the charge, but it can differ (usually because of currency fluctuation or because only part of the order is disputed).*/ amount: z .number() .int() .describe( 'Disputed amount. Usually the amount of the charge, but it can differ (usually because of currency fluctuation or because only part of the order is disputed).' ), - /** List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute. */ + /**List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute.*/ balance_transactions: z .array(BalanceTransactionSchema) .describe( 'List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute.' ), - /** ID of the charge that's disputed. */ + /**ID of the charge that's disputed.*/ charge: z .union([z.string().max(5000), ChargeSchema]) .describe("ID of the charge that's disputed."), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** List of eligibility types that are included in `enhanced_evidence`. */ + /**List of eligibility types that are included in `enhanced_evidence`.*/ enhanced_eligibility_types: z .array(z.literal('visa_compelling_evidence_3')) .describe( @@ -35523,47 +33706,46 @@ export namespace stripe { ), evidence: DisputeEvidenceSchema, evidence_details: DisputeEvidenceDetailsSchema, - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** If true, it's still possible to refund the disputed payment. After the payment has been fully refunded, no further funds are withdrawn from your Stripe account as a result of this dispute. */ + /**If true, it's still possible to refund the disputed payment. After the payment has been fully refunded, no further funds are withdrawn from your Stripe account as a result of this dispute.*/ is_charge_refundable: z .boolean() .describe( "If true, it's still possible to refund the disputed payment. After the payment has been fully refunded, no further funds are withdrawn from your Stripe account as a result of this dispute." ), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('dispute') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** ID of the PaymentIntent that's disputed. */ + /**ID of the PaymentIntent that's disputed.*/ payment_intent: z .union([z.string().max(5000), PaymentIntentSchema]) - .nullable() .describe("ID of the PaymentIntent that's disputed.") .optional(), payment_method_details: DisputePaymentMethodDetailsSchema.optional(), - /** Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Learn more about [dispute reasons](https://stripe.com/docs/disputes/categories). */ + /**Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Learn more about [dispute reasons](https://stripe.com/docs/disputes/categories).*/ reason: z .string() .max(5000) .describe( 'Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Learn more about [dispute reasons](https://stripe.com/docs/disputes/categories).' ), - /** Current status of dispute. Possible values are `warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `won`, or `lost`. */ + /**Current status of dispute. Possible values are `warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `won`, or `lost`.*/ status: z .enum([ 'lost', @@ -35592,47 +33774,45 @@ export namespace stripe { */ export const FeeRefundSchema = z .object({ - /** Amount, in cents (or local equivalent). */ + /**Amount, in cents (or local equivalent).*/ amount: z .number() .int() .describe('Amount, in cents (or local equivalent).'), - /** Balance transaction that describes the impact on your account balance. */ + /**Balance transaction that describes the impact on your account balance.*/ balance_transaction: z .union([z.string().max(5000), BalanceTransactionSchema]) - .nullable() .describe( 'Balance transaction that describes the impact on your account balance.' ) .optional(), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** ID of the application fee that was refunded. */ + /**ID of the application fee that was refunded.*/ fee: z .union([z.string().max(5000), ApplicationFeeSchema]) .describe('ID of the application fee that was refunded.'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) - .nullable() .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ) .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('fee_refund') .describe( @@ -35653,163 +33833,146 @@ export namespace stripe { */ export const IssuingAuthorizationSchema = z .object({ - /** The total amount that was authorized or rejected. This amount is in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `amount` should be the same as `merchant_amount`, unless `currency` and `merchant_currency` are different. */ + /**The total amount that was authorized or rejected. This amount is in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `amount` should be the same as `merchant_amount`, unless `currency` and `merchant_currency` are different.*/ amount: z .number() .int() .describe( 'The total amount that was authorized or rejected. This amount is in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `amount` should be the same as `merchant_amount`, unless `currency` and `merchant_currency` are different.' ), - /** Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ - amount_details: IssuingAuthorizationAmountDetailsSchema.nullable() - .describe( - 'Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).' - ) - .optional(), - /** Whether the authorization has been approved. */ + /**Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).*/ + amount_details: IssuingAuthorizationAmountDetailsSchema.describe( + 'Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).' + ).optional(), + /**Whether the authorization has been approved.*/ approved: z .boolean() .describe('Whether the authorization has been approved.'), - /** How the card details were provided. */ + /**How the card details were provided.*/ authorization_method: z .enum(['chip', 'contactless', 'keyed_in', 'online', 'swipe']) .describe('How the card details were provided.'), - /** List of balance transactions associated with this authorization. */ + /**List of balance transactions associated with this authorization.*/ balance_transactions: z .array(BalanceTransactionSchema) .describe( 'List of balance transactions associated with this authorization.' ), card: IssuingCardSchema, - /** The cardholder to whom this authorization belongs. */ + /**The cardholder to whom this authorization belongs.*/ cardholder: z .union([z.string().max(5000), IssuingCardholderSchema]) - .nullable() .describe('The cardholder to whom this authorization belongs.') .optional(), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** The currency of the cardholder. This currency can be different from the currency presented at authorization and the `merchant_currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**The currency of the cardholder. This currency can be different from the currency presented at authorization and the `merchant_currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'The currency of the cardholder. This currency can be different from the currency presented at authorization and the `merchant_currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** Fleet-specific information for authorizations using Fleet cards. */ - fleet: IssuingAuthorizationFleetDataSchema.nullable() - .describe( - 'Fleet-specific information for authorizations using Fleet cards.' - ) - .optional(), - /** Fraud challenges sent to the cardholder, if this authorization was declined for fraud risk reasons. */ + /**Fleet-specific information for authorizations using Fleet cards.*/ + fleet: IssuingAuthorizationFleetDataSchema.describe( + 'Fleet-specific information for authorizations using Fleet cards.' + ).optional(), + /**Fraud challenges sent to the cardholder, if this authorization was declined for fraud risk reasons.*/ fraud_challenges: z .array(IssuingAuthorizationFraudChallengeSchema) - .nullable() .describe( 'Fraud challenges sent to the cardholder, if this authorization was declined for fraud risk reasons.' ) .optional(), - /** Information about fuel that was purchased with this transaction. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed. */ - fuel: IssuingAuthorizationFuelDataSchema.nullable() - .describe( - 'Information about fuel that was purchased with this transaction. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed.' - ) - .optional(), - /** Unique identifier for the object. */ + /**Information about fuel that was purchased with this transaction. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed.*/ + fuel: IssuingAuthorizationFuelDataSchema.describe( + 'Information about fuel that was purchased with this transaction. Typically this information is received from the merchant after the authorization has been approved and the fuel dispensed.' + ).optional(), + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** The total amount that was authorized or rejected. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `merchant_amount` should be the same as `amount`, unless `merchant_currency` and `currency` are different. */ + /**The total amount that was authorized or rejected. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `merchant_amount` should be the same as `amount`, unless `merchant_currency` and `currency` are different.*/ merchant_amount: z .number() .int() .describe( 'The total amount that was authorized or rejected. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `merchant_amount` should be the same as `amount`, unless `merchant_currency` and `currency` are different.' ), - /** The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the `currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the `currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ merchant_currency: z .string() .describe( 'The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the `currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), merchant_data: IssuingAuthorizationMerchantDataSchema, - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ), - /** Details about the authorization, such as identifiers, set by the card network. */ - network_data: IssuingAuthorizationNetworkDataSchema.nullable() - .describe( - 'Details about the authorization, such as identifiers, set by the card network.' - ) - .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**Details about the authorization, such as identifiers, set by the card network.*/ + network_data: IssuingAuthorizationNetworkDataSchema.describe( + 'Details about the authorization, such as identifiers, set by the card network.' + ).optional(), + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('issuing.authorization') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The pending authorization request. This field will only be non-null during an `issuing_authorization.request` webhook. */ - pending_request: IssuingAuthorizationPendingRequestSchema.nullable() - .describe( - 'The pending authorization request. This field will only be non-null during an `issuing_authorization.request` webhook.' - ) - .optional(), - /** History of every time a `pending_request` authorization was approved/declined, either by you directly or by Stripe (e.g. based on your spending_controls). If the merchant changes the authorization by performing an incremental authorization, you can look at this field to see the previous requests for the authorization. This field can be helpful in determining why a given authorization was approved/declined. */ + /**The pending authorization request. This field will only be non-null during an `issuing_authorization.request` webhook.*/ + pending_request: IssuingAuthorizationPendingRequestSchema.describe( + 'The pending authorization request. This field will only be non-null during an `issuing_authorization.request` webhook.' + ).optional(), + /**History of every time a `pending_request` authorization was approved/declined, either by you directly or by Stripe (e.g. based on your spending_controls). If the merchant changes the authorization by performing an incremental authorization, you can look at this field to see the previous requests for the authorization. This field can be helpful in determining why a given authorization was approved/declined.*/ request_history: z .array(IssuingAuthorizationRequestSchema) .describe( 'History of every time a `pending_request` authorization was approved/declined, either by you directly or by Stripe (e.g. based on your spending_controls). If the merchant changes the authorization by performing an incremental authorization, you can look at this field to see the previous requests for the authorization. This field can be helpful in determining why a given authorization was approved/declined.' ), - /** The current status of the authorization in its lifecycle. */ + /**The current status of the authorization in its lifecycle.*/ status: z .enum(['closed', 'pending', 'reversed']) .describe('The current status of the authorization in its lifecycle.'), - /** [Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this authorization. If a network token was not used for this authorization, this field will be null. */ + /**[Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this authorization. If a network token was not used for this authorization, this field will be null.*/ token: z .union([z.string().max(5000), IssuingTokenSchema]) - .nullable() .describe( '[Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this authorization. If a network token was not used for this authorization, this field will be null.' ) .optional(), - /** List of [transactions](https://stripe.com/docs/api/issuing/transactions) associated with this authorization. */ + /**List of [transactions](https://stripe.com/docs/api/issuing/transactions) associated with this authorization.*/ transactions: z .array(IssuingTransactionSchema) .describe( 'List of [transactions](https://stripe.com/docs/api/issuing/transactions) associated with this authorization.' ), - /** [Treasury](https://stripe.com/docs/api/treasury) details related to this authorization if it was created on a [FinancialAccount](https://stripe.com/docs/api/treasury/financial_accounts). */ - treasury: IssuingAuthorizationTreasurySchema.nullable() - .describe( - '[Treasury](https://stripe.com/docs/api/treasury) details related to this authorization if it was created on a [FinancialAccount](https://stripe.com/docs/api/treasury/financial_accounts).' - ) - .optional(), + /**[Treasury](https://stripe.com/docs/api/treasury) details related to this authorization if it was created on a [FinancialAccount](https://stripe.com/docs/api/treasury/financial_accounts).*/ + treasury: IssuingAuthorizationTreasurySchema.describe( + '[Treasury](https://stripe.com/docs/api/treasury) details related to this authorization if it was created on a [FinancialAccount](https://stripe.com/docs/api/treasury/financial_accounts).' + ).optional(), verification_data: IssuingAuthorizationVerificationDataSchema, - /** Whether the authorization bypassed fraud risk checks because the cardholder has previously completed a fraud challenge on a similar high-risk authorization from the same merchant. */ + /**Whether the authorization bypassed fraud risk checks because the cardholder has previously completed a fraud challenge on a similar high-risk authorization from the same merchant.*/ verified_by_fraud_challenge: z .boolean() - .nullable() .describe( 'Whether the authorization bypassed fraud risk checks because the cardholder has previously completed a fraud challenge on a similar high-risk authorization from the same merchant.' ) .optional(), - /** The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized. */ + /**The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized.*/ wallet: z .string() .max(5000) - .nullable() .describe( 'The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized.' ) @@ -35829,128 +33992,114 @@ export namespace stripe { */ export const IssuingTransactionSchema = z .object({ - /** The transaction amount, which will be reflected in your balance. This amount is in your currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /**The transaction amount, which will be reflected in your balance. This amount is in your currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).*/ amount: z .number() .int() .describe( 'The transaction amount, which will be reflected in your balance. This amount is in your currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).' ), - /** Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ - amount_details: IssuingTransactionAmountDetailsSchema.nullable() - .describe( - 'Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).' - ) - .optional(), - /** The `Authorization` object that led to this transaction. */ + /**Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).*/ + amount_details: IssuingTransactionAmountDetailsSchema.describe( + 'Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).' + ).optional(), + /**The `Authorization` object that led to this transaction.*/ authorization: z .union([z.string().max(5000), IssuingAuthorizationSchema]) - .nullable() .describe('The `Authorization` object that led to this transaction.') .optional(), - /** ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions) associated with this transaction. */ + /**ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions) associated with this transaction.*/ balance_transaction: z .union([z.string().max(5000), BalanceTransactionSchema]) - .nullable() .describe( 'ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions) associated with this transaction.' ) .optional(), - /** The card used to make this transaction. */ + /**The card used to make this transaction.*/ card: z .union([z.string().max(5000), IssuingCardSchema]) .describe('The card used to make this transaction.'), - /** The cardholder to whom this transaction belongs. */ + /**The cardholder to whom this transaction belongs.*/ cardholder: z .union([z.string().max(5000), IssuingCardholderSchema]) - .nullable() .describe('The cardholder to whom this transaction belongs.') .optional(), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** If you've disputed the transaction, the ID of the dispute. */ + /**If you've disputed the transaction, the ID of the dispute.*/ dispute: z .union([z.string().max(5000), IssuingDisputeSchema]) - .nullable() .describe("If you've disputed the transaction, the ID of the dispute.") .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** The amount that the merchant will receive, denominated in `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). It will be different from `amount` if the merchant is taking payment in a different currency. */ + /**The amount that the merchant will receive, denominated in `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). It will be different from `amount` if the merchant is taking payment in a different currency.*/ merchant_amount: z .number() .int() .describe( 'The amount that the merchant will receive, denominated in `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). It will be different from `amount` if the merchant is taking payment in a different currency.' ), - /** The currency with which the merchant is taking payment. */ + /**The currency with which the merchant is taking payment.*/ merchant_currency: z .string() .describe('The currency with which the merchant is taking payment.'), merchant_data: IssuingAuthorizationMerchantDataSchema, - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ), - /** Details about the transaction, such as processing dates, set by the card network. */ - network_data: IssuingTransactionNetworkDataSchema.nullable() - .describe( - 'Details about the transaction, such as processing dates, set by the card network.' - ) - .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**Details about the transaction, such as processing dates, set by the card network.*/ + network_data: IssuingTransactionNetworkDataSchema.describe( + 'Details about the transaction, such as processing dates, set by the card network.' + ).optional(), + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('issuing.transaction') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** Additional purchase information that is optionally provided by the merchant. */ - purchase_details: IssuingTransactionPurchaseDetailsSchema.nullable() - .describe( - 'Additional purchase information that is optionally provided by the merchant.' - ) - .optional(), - /** [Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this transaction. If a network token was not used for this transaction, this field will be null. */ + /**Additional purchase information that is optionally provided by the merchant.*/ + purchase_details: IssuingTransactionPurchaseDetailsSchema.describe( + 'Additional purchase information that is optionally provided by the merchant.' + ).optional(), + /**[Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this transaction. If a network token was not used for this transaction, this field will be null.*/ token: z .union([z.string().max(5000), IssuingTokenSchema]) - .nullable() .describe( '[Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this transaction. If a network token was not used for this transaction, this field will be null.' ) .optional(), - /** [Treasury](https://stripe.com/docs/api/treasury) details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts */ - treasury: IssuingTransactionTreasurySchema.nullable() - .describe( - '[Treasury](https://stripe.com/docs/api/treasury) details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts' - ) - .optional(), - /** The nature of the transaction. */ + /**[Treasury](https://stripe.com/docs/api/treasury) details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts*/ + treasury: IssuingTransactionTreasurySchema.describe( + '[Treasury](https://stripe.com/docs/api/treasury) details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts' + ).optional(), + /**The nature of the transaction.*/ type: z .enum(['capture', 'refund']) .describe('The nature of the transaction.'), - /** The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. */ + /**The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`.*/ wallet: z .enum(['apple_pay', 'google_pay', 'samsung_pay']) - .nullable() .describe( 'The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`.' ) @@ -35968,40 +34117,39 @@ export namespace stripe { */ export const IssuingDisputeSchema = z .object({ - /** Disputed amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Usually the amount of the `transaction`, but can differ (usually because of currency fluctuation). */ + /**Disputed amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Usually the amount of the `transaction`, but can differ (usually because of currency fluctuation).*/ amount: z .number() .int() .describe( "Disputed amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Usually the amount of the `transaction`, but can differ (usually because of currency fluctuation)." ), - /** List of balance transactions associated with the dispute. */ + /**List of balance transactions associated with the dispute.*/ balance_transactions: z .array(BalanceTransactionSchema) - .nullable() .describe('List of balance transactions associated with the dispute.') .optional(), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** The currency the `transaction` was made in. */ + /**The currency the `transaction` was made in.*/ currency: z .string() .describe('The currency the `transaction` was made in.'), evidence: IssuingDisputeEvidenceSchema, - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** The enum that describes the dispute loss outcome. If the dispute is not lost, this field will be absent. New enum values may be added in the future, so be sure to handle unknown values. */ + /**The enum that describes the dispute loss outcome. If the dispute is not lost, this field will be absent. New enum values may be added in the future, so be sure to handle unknown values.*/ loss_reason: z .enum([ 'cardholder_authentication_issuer_liability', @@ -36029,32 +34177,30 @@ export namespace stripe { 'The enum that describes the dispute loss outcome. If the dispute is not lost, this field will be absent. New enum values may be added in the future, so be sure to handle unknown values.' ) .optional(), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('issuing.dispute') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** Current status of the dispute. */ + /**Current status of the dispute.*/ status: z .enum(['expired', 'lost', 'submitted', 'unsubmitted', 'won']) .describe('Current status of the dispute.'), - /** The transaction being disputed. */ + /**The transaction being disputed.*/ transaction: z .union([z.string().max(5000), IssuingTransactionSchema]) .describe('The transaction being disputed.'), - /** [Treasury](https://stripe.com/docs/api/treasury) details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts */ - treasury: IssuingDisputeTreasurySchema.nullable() - .describe( - '[Treasury](https://stripe.com/docs/api/treasury) details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts' - ) - .optional() + /**[Treasury](https://stripe.com/docs/api/treasury) details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts*/ + treasury: IssuingDisputeTreasurySchema.describe( + '[Treasury](https://stripe.com/docs/api/treasury) details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts' + ).optional() }) .describe( 'As a [card issuer](https://stripe.com/docs/issuing), you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with.\n\nRelated guide: [Issuing disputes](https://stripe.com/docs/issuing/purchases/disputes)' @@ -36073,74 +34219,70 @@ export namespace stripe { */ export const PayoutSchema = z .object({ - /** The amount (in cents (or local equivalent)) that transfers to your bank account or debit card. */ + /**The amount (in cents (or local equivalent)) that transfers to your bank account or debit card.*/ amount: z .number() .int() .describe( 'The amount (in cents (or local equivalent)) that transfers to your bank account or debit card.' ), - /** The application fee (if any) for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details. */ + /**The application fee (if any) for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details.*/ application_fee: z .union([z.string().max(5000), ApplicationFeeSchema]) - .nullable() .describe( 'The application fee (if any) for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details.' ) .optional(), - /** The amount of the application fee (if any) requested for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details. */ + /**The amount of the application fee (if any) requested for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details.*/ application_fee_amount: z .number() .int() - .nullable() .describe( 'The amount of the application fee (if any) requested for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details.' ) .optional(), - /** Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays. */ + /**Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays.*/ arrival_date: z .number() .int() .describe( 'Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays.' ), - /** Returns `true` if the payout is created by an [automated payout schedule](https://stripe.com/docs/payouts#payout-schedule) and `false` if it's [requested manually](https://stripe.com/docs/payouts#manual-payouts). */ + /**Returns `true` if the payout is created by an [automated payout schedule](https://stripe.com/docs/payouts#payout-schedule) and `false` if it's [requested manually](https://stripe.com/docs/payouts#manual-payouts).*/ automatic: z .boolean() .describe( "Returns `true` if the payout is created by an [automated payout schedule](https://stripe.com/docs/payouts#payout-schedule) and `false` if it's [requested manually](https://stripe.com/docs/payouts#manual-payouts)." ), - /** ID of the balance transaction that describes the impact of this payout on your account balance. */ + /**ID of the balance transaction that describes the impact of this payout on your account balance.*/ balance_transaction: z .union([z.string().max(5000), BalanceTransactionSchema]) - .nullable() .describe( 'ID of the balance transaction that describes the impact of this payout on your account balance.' ) .optional(), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** An arbitrary string attached to the object. Often useful for displaying to users. */ + /**An arbitrary string attached to the object. Often useful for displaying to users.*/ description: z .string() .max(5000) - .nullable() .describe( 'An arbitrary string attached to the object. Often useful for displaying to users.' ) .optional(), - /** ID of the bank account or card the payout is sent to. */ + /**ID of the bank account or card the payout is sent to.*/ destination: z .union([ z.string().max(5000), @@ -36149,124 +34291,114 @@ export namespace stripe { DeletedBankAccountSchema, DeletedCardSchema ]) - .nullable() .describe('ID of the bank account or card the payout is sent to.') .optional(), - /** If the payout fails or cancels, this is the ID of the balance transaction that reverses the initial balance transaction and returns the funds from the failed payout back in your balance. */ + /**If the payout fails or cancels, this is the ID of the balance transaction that reverses the initial balance transaction and returns the funds from the failed payout back in your balance.*/ failure_balance_transaction: z .union([z.string().max(5000), BalanceTransactionSchema]) - .nullable() .describe( 'If the payout fails or cancels, this is the ID of the balance transaction that reverses the initial balance transaction and returns the funds from the failed payout back in your balance.' ) .optional(), - /** Error code that provides a reason for a payout failure, if available. View our [list of failure codes](https://stripe.com/docs/api#payout_failures). */ + /**Error code that provides a reason for a payout failure, if available. View our [list of failure codes](https://stripe.com/docs/api#payout_failures).*/ failure_code: z .string() .max(5000) - .nullable() .describe( 'Error code that provides a reason for a payout failure, if available. View our [list of failure codes](https://stripe.com/docs/api#payout_failures).' ) .optional(), - /** Message that provides the reason for a payout failure, if available. */ + /**Message that provides the reason for a payout failure, if available.*/ failure_message: z .string() .max(5000) - .nullable() .describe( 'Message that provides the reason for a payout failure, if available.' ) .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) - .nullable() .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ) .optional(), - /** The method used to send this payout, which can be `standard` or `instant`. `instant` is supported for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks). */ + /**The method used to send this payout, which can be `standard` or `instant`. `instant` is supported for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks).*/ method: z .string() .max(5000) .describe( 'The method used to send this payout, which can be `standard` or `instant`. `instant` is supported for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks).' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('payout') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** If the payout reverses another, this is the ID of the original payout. */ + /**If the payout reverses another, this is the ID of the original payout.*/ original_payout: z .union([ z.string().max(5000), // TODO: Support recursive types for `PayoutSchema`. z.any() ]) - .nullable() .describe( 'If the payout reverses another, this is the ID of the original payout.' ) .optional(), - /** If `completed`, you can use the [Balance Transactions API](https://stripe.com/docs/api/balance_transactions/list#balance_transaction_list-payout) to list all balance transactions that are paid out in this payout. */ + /**If `completed`, you can use the [Balance Transactions API](https://stripe.com/docs/api/balance_transactions/list#balance_transaction_list-payout) to list all balance transactions that are paid out in this payout.*/ reconciliation_status: z .enum(['completed', 'in_progress', 'not_applicable']) .describe( 'If `completed`, you can use the [Balance Transactions API](https://stripe.com/docs/api/balance_transactions/list#balance_transaction_list-payout) to list all balance transactions that are paid out in this payout.' ), - /** If the payout reverses, this is the ID of the payout that reverses this payout. */ + /**If the payout reverses, this is the ID of the payout that reverses this payout.*/ reversed_by: z .union([ z.string().max(5000), // TODO: Support recursive types for `PayoutSchema`. z.any() ]) - .nullable() .describe( 'If the payout reverses, this is the ID of the payout that reverses this payout.' ) .optional(), - /** The source balance this payout came from, which can be one of the following: `card`, `fpx`, or `bank_account`. */ + /**The source balance this payout came from, which can be one of the following: `card`, `fpx`, or `bank_account`.*/ source_type: z .string() .max(5000) .describe( 'The source balance this payout came from, which can be one of the following: `card`, `fpx`, or `bank_account`.' ), - /** Extra information about a payout that displays on the user's bank statement. */ + /**Extra information about a payout that displays on the user's bank statement.*/ statement_descriptor: z .string() .max(5000) - .nullable() .describe( "Extra information about a payout that displays on the user's bank statement." ) .optional(), - /** Current status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it's submitted to the bank, when it becomes `in_transit`. The status changes to `paid` if the transaction succeeds, or to `failed` or `canceled` (within 5 business days). Some payouts that fail might initially show as `paid`, then change to `failed`. */ + /**Current status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it's submitted to the bank, when it becomes `in_transit`. The status changes to `paid` if the transaction succeeds, or to `failed` or `canceled` (within 5 business days). Some payouts that fail might initially show as `paid`, then change to `failed`.*/ status: z .string() .max(5000) .describe( "Current status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it's submitted to the bank, when it becomes `in_transit`. The status changes to `paid` if the transaction succeeds, or to `failed` or `canceled` (within 5 business days). Some payouts that fail might initially show as `paid`, then change to `failed`." ), - /** A value that generates from the beneficiary's bank that allows users to track payouts with their bank. Banks might call this a "reference number" or something similar. */ - trace_id: PayoutsTraceIdSchema.nullable() - .describe( - 'A value that generates from the beneficiary\'s bank that allows users to track payouts with their bank. Banks might call this a "reference number" or something similar.' - ) - .optional(), - /** Can be `bank_account` or `card`. */ + /**A value that generates from the beneficiary's bank that allows users to track payouts with their bank. Banks might call this a "reference number" or something similar.*/ + trace_id: PayoutsTraceIdSchema.describe( + 'A value that generates from the beneficiary\'s bank that allows users to track payouts with their bank. Banks might call this a "reference number" or something similar.' + ).optional(), + /**Can be `bank_account` or `card`.*/ type: z .enum(['bank_account', 'card']) .describe('Can be `bank_account` or `card`.') @@ -36285,112 +34417,103 @@ export namespace stripe { */ export const TopupSchema = z .object({ - /** Amount transferred. */ + /**Amount transferred.*/ amount: z.number().int().describe('Amount transferred.'), - /** ID of the balance transaction that describes the impact of this top-up on your account balance. May not be specified depending on status of top-up. */ + /**ID of the balance transaction that describes the impact of this top-up on your account balance. May not be specified depending on status of top-up.*/ balance_transaction: z .union([z.string().max(5000), BalanceTransactionSchema]) - .nullable() .describe( 'ID of the balance transaction that describes the impact of this top-up on your account balance. May not be specified depending on status of top-up.' ) .optional(), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .max(5000) .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** An arbitrary string attached to the object. Often useful for displaying to users. */ + /**An arbitrary string attached to the object. Often useful for displaying to users.*/ description: z .string() .max(5000) - .nullable() .describe( 'An arbitrary string attached to the object. Often useful for displaying to users.' ) .optional(), - /** Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up. */ + /**Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up.*/ expected_availability_date: z .number() .int() - .nullable() .describe( 'Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up.' ) .optional(), - /** Error code explaining reason for top-up failure if available (see [the errors section](https://stripe.com/docs/api#errors) for a list of codes). */ + /**Error code explaining reason for top-up failure if available (see [the errors section](https://stripe.com/docs/api#errors) for a list of codes).*/ failure_code: z .string() .max(5000) - .nullable() .describe( 'Error code explaining reason for top-up failure if available (see [the errors section](https://stripe.com/docs/api#errors) for a list of codes).' ) .optional(), - /** Message to user further explaining reason for top-up failure if available. */ + /**Message to user further explaining reason for top-up failure if available.*/ failure_message: z .string() .max(5000) - .nullable() .describe( 'Message to user further explaining reason for top-up failure if available.' ) .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('topup') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The source field is deprecated. It might not always be present in the API response. */ - source: SourceSchema.nullable() - .describe( - 'The source field is deprecated. It might not always be present in the API response.' - ) - .optional(), - /** Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter. */ + /**The source field is deprecated. It might not always be present in the API response.*/ + source: SourceSchema.describe( + 'The source field is deprecated. It might not always be present in the API response.' + ).optional(), + /**Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter.*/ statement_descriptor: z .string() .max(5000) - .nullable() .describe( "Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter." ) .optional(), - /** The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`. */ + /**The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`.*/ status: z .enum(['canceled', 'failed', 'pending', 'reversed', 'succeeded']) .describe( 'The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`.' ), - /** A string that identifies this top-up as part of a group. */ + /**A string that identifies this top-up as part of a group.*/ transfer_group: z .string() .max(5000) - .nullable() .describe('A string that identifies this top-up as part of a group.') .optional() }) @@ -36465,50 +34588,44 @@ export namespace stripe { export type PaymentMethodDetails = z.infer export const PaymentMethodDetailsBancontactSchema = z.object({ - /** Bank code of bank associated with the bank account. */ + /**Bank code of bank associated with the bank account.*/ bank_code: z .string() .max(5000) - .nullable() .describe('Bank code of bank associated with the bank account.') .optional(), - /** Name of the bank associated with the bank account. */ + /**Name of the bank associated with the bank account.*/ bank_name: z .string() .max(5000) - .nullable() .describe('Name of the bank associated with the bank account.') .optional(), - /** Bank Identifier Code of the bank associated with the bank account. */ + /**Bank Identifier Code of the bank associated with the bank account.*/ bic: z .string() .max(5000) - .nullable() .describe( 'Bank Identifier Code of the bank associated with the bank account.' ) .optional(), - /** The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ + /**The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.*/ generated_sepa_debit: z .union([z.string().max(5000), PaymentMethodSchema]) - .nullable() .describe( 'The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.' ) .optional(), - /** The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ + /**The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.*/ generated_sepa_debit_mandate: z .union([z.string().max(5000), MandateSchema]) - .nullable() .describe( 'The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.' ) .optional(), - /** Last four characters of the IBAN. */ + /**Last four characters of the IBAN.*/ iban_last4: z .string() .max(5000) - .nullable() .describe('Last four characters of the IBAN.') .optional(), /** @@ -36517,7 +34634,6 @@ export namespace stripe { */ preferred_language: z .enum(['de', 'en', 'fr', 'nl']) - .nullable() .describe( 'Preferred language of the Bancontact authorization page that the customer is redirected to.\nCan be one of `en`, `de`, `fr`, or `nl`' ) @@ -36529,7 +34645,6 @@ export namespace stripe { verified_name: z .string() .max(5000) - .nullable() .describe( "Owner's verified full name. Values are verified or provided by Bancontact directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated." ) @@ -36540,7 +34655,7 @@ export namespace stripe { > export const PaymentMethodDetailsIdealSchema = z.object({ - /** The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. */ + /**The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.*/ bank: z .enum([ 'abn_amro', @@ -36560,12 +34675,11 @@ export namespace stripe { 'van_lanschot', 'yoursafe' ]) - .nullable() .describe( "The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`." ) .optional(), - /** The Bank Identifier Code of the customer's bank. */ + /**The Bank Identifier Code of the customer's bank.*/ bic: z .enum([ 'ABNANL2A', @@ -36586,30 +34700,26 @@ export namespace stripe { 'SNSBNL2A', 'TRIONL2U' ]) - .nullable() .describe("The Bank Identifier Code of the customer's bank.") .optional(), - /** The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ + /**The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.*/ generated_sepa_debit: z .union([z.string().max(5000), PaymentMethodSchema]) - .nullable() .describe( 'The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.' ) .optional(), - /** The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ + /**The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.*/ generated_sepa_debit_mandate: z .union([z.string().max(5000), MandateSchema]) - .nullable() .describe( 'The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.' ) .optional(), - /** Last four characters of the IBAN. */ + /**Last four characters of the IBAN.*/ iban_last4: z .string() .max(5000) - .nullable() .describe('Last four characters of the IBAN.') .optional(), /** @@ -36619,7 +34729,6 @@ export namespace stripe { verified_name: z .string() .max(5000) - .nullable() .describe( "Owner's verified full name. Values are verified or provided by iDEAL directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated." ) @@ -36630,59 +34739,52 @@ export namespace stripe { > export const PaymentMethodDetailsSofortSchema = z.object({ - /** Bank code of bank associated with the bank account. */ + /**Bank code of bank associated with the bank account.*/ bank_code: z .string() .max(5000) - .nullable() .describe('Bank code of bank associated with the bank account.') .optional(), - /** Name of the bank associated with the bank account. */ + /**Name of the bank associated with the bank account.*/ bank_name: z .string() .max(5000) - .nullable() .describe('Name of the bank associated with the bank account.') .optional(), - /** Bank Identifier Code of the bank associated with the bank account. */ + /**Bank Identifier Code of the bank associated with the bank account.*/ bic: z .string() .max(5000) - .nullable() .describe( 'Bank Identifier Code of the bank associated with the bank account.' ) .optional(), - /** Two-letter ISO code representing the country the bank account is located in. */ + /**Two-letter ISO code representing the country the bank account is located in.*/ country: z .string() .max(5000) - .nullable() .describe( 'Two-letter ISO code representing the country the bank account is located in.' ) .optional(), - /** The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ + /**The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.*/ generated_sepa_debit: z .union([z.string().max(5000), PaymentMethodSchema]) - .nullable() .describe( 'The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge.' ) .optional(), - /** The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ + /**The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.*/ generated_sepa_debit_mandate: z .union([z.string().max(5000), MandateSchema]) - .nullable() .describe( 'The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge.' ) .optional(), - /** Last four characters of the IBAN. */ + /**Last four characters of the IBAN.*/ iban_last4: z .string() .max(5000) - .nullable() .describe('Last four characters of the IBAN.') .optional(), /** @@ -36691,7 +34793,6 @@ export namespace stripe { */ preferred_language: z .enum(['de', 'en', 'es', 'fr', 'it', 'nl', 'pl']) - .nullable() .describe( 'Preferred language of the SOFORT authorization page that the customer is redirected to.\nCan be one of `de`, `en`, `es`, `fr`, `it`, `nl`, or `pl`' ) @@ -36703,7 +34804,6 @@ export namespace stripe { verified_name: z .string() .max(5000) - .nullable() .describe( "Owner's verified full name. Values are verified or provided by SOFORT directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated." ) @@ -36714,60 +34814,53 @@ export namespace stripe { > export const PaymentMethodDetailsUsBankAccountSchema = z.object({ - /** Account holder type: individual or company. */ + /**Account holder type: individual or company.*/ account_holder_type: z .enum(['company', 'individual']) - .nullable() .describe('Account holder type: individual or company.') .optional(), - /** Account type: checkings or savings. Defaults to checking if omitted. */ + /**Account type: checkings or savings. Defaults to checking if omitted.*/ account_type: z .enum(['checking', 'savings']) - .nullable() .describe( 'Account type: checkings or savings. Defaults to checking if omitted.' ) .optional(), - /** Name of the bank associated with the bank account. */ + /**Name of the bank associated with the bank account.*/ bank_name: z .string() .max(5000) - .nullable() .describe('Name of the bank associated with the bank account.') .optional(), - /** Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /**Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.*/ fingerprint: z .string() .max(5000) - .nullable() .describe( 'Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.' ) .optional(), - /** Last four digits of the bank account number. */ + /**Last four digits of the bank account number.*/ last4: z .string() .max(5000) - .nullable() .describe('Last four digits of the bank account number.') .optional(), - /** ID of the mandate used to make this payment. */ + /**ID of the mandate used to make this payment.*/ mandate: z .union([z.string().max(5000), MandateSchema]) .describe('ID of the mandate used to make this payment.') .optional(), - /** Reference number to locate ACH payments with customer's bank. */ + /**Reference number to locate ACH payments with customer's bank.*/ payment_reference: z .string() .max(5000) - .nullable() .describe("Reference number to locate ACH payments with customer's bank.") .optional(), - /** Routing number of the bank account. */ + /**Routing number of the bank account.*/ routing_number: z .string() .max(5000) - .nullable() .describe('Routing number of the bank account.') .optional() }) @@ -36783,20 +34876,18 @@ export namespace stripe { */ export const ReviewSchema = z .object({ - /** The ZIP or postal code of the card used, if applicable. */ + /**The ZIP or postal code of the card used, if applicable.*/ billing_zip: z .string() .max(5000) - .nullable() .describe('The ZIP or postal code of the card used, if applicable.') .optional(), - /** The charge associated with this review. */ + /**The charge associated with this review.*/ charge: z .union([z.string().max(5000), ChargeSchema]) - .nullable() .describe('The charge associated with this review.') .optional(), - /** The reason the review was closed, or null if it has not yet been closed. One of `approved`, `refunded`, `refunded_as_fraud`, `disputed`, or `redacted`. */ + /**The reason the review was closed, or null if it has not yet been closed. One of `approved`, `refunded`, `refunded_as_fraud`, `disputed`, or `redacted`.*/ closed_reason: z .enum([ 'approved', @@ -36805,73 +34896,67 @@ export namespace stripe { 'refunded', 'refunded_as_fraud' ]) - .nullable() .describe( 'The reason the review was closed, or null if it has not yet been closed. One of `approved`, `refunded`, `refunded_as_fraud`, `disputed`, or `redacted`.' ) .optional(), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** The IP address where the payment originated. */ + /**The IP address where the payment originated.*/ ip_address: z .string() .max(5000) - .nullable() .describe('The IP address where the payment originated.') .optional(), - /** Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address. */ - ip_address_location: RadarReviewResourceLocationSchema.nullable() - .describe( - 'Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address.' - ) - .optional(), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address.*/ + ip_address_location: RadarReviewResourceLocationSchema.describe( + 'Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address.' + ).optional(), + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('review') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** If `true`, the review needs action. */ + /**If `true`, the review needs action.*/ open: z.boolean().describe('If `true`, the review needs action.'), - /** The reason the review was opened. One of `rule` or `manual`. */ + /**The reason the review was opened. One of `rule` or `manual`.*/ opened_reason: z .enum(['manual', 'rule']) .describe( 'The reason the review was opened. One of `rule` or `manual`.' ), - /** The PaymentIntent ID associated with this review, if one exists. */ + /**The PaymentIntent ID associated with this review, if one exists.*/ payment_intent: z .union([z.string().max(5000), PaymentIntentSchema]) .describe( 'The PaymentIntent ID associated with this review, if one exists.' ) .optional(), - /** The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, `refunded`, `refunded_as_fraud`, `disputed`, or `redacted`. */ + /**The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, `refunded`, `refunded_as_fraud`, `disputed`, or `redacted`.*/ reason: z .string() .max(5000) .describe( 'The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, `refunded`, `refunded_as_fraud`, `disputed`, or `redacted`.' ), - /** Information related to the browsing session of the user who initiated the payment. */ - session: RadarReviewResourceSessionSchema.nullable() - .describe( - 'Information related to the browsing session of the user who initiated the payment.' - ) - .optional() + /**Information related to the browsing session of the user who initiated the payment.*/ + session: RadarReviewResourceSessionSchema.describe( + 'Information related to the browsing session of the user who initiated the payment.' + ).optional() }) .describe( 'Reviews can be used to supplement automated fraud detection with human expertise.\n\nLearn more about [Radar](/radar) and reviewing payments\n[here](https://stripe.com/docs/radar/reviews).' @@ -36879,16 +34964,15 @@ export namespace stripe { export type Review = z.infer export const ChargeTransferDataSchema = z.object({ - /** The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account. */ + /**The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.*/ amount: z .number() .int() - .nullable() .describe( 'The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.' ) .optional(), - /** ID of an existing, connected Stripe account to transfer funds to if `transfer_data` was specified in the charge request. */ + /**ID of an existing, connected Stripe account to transfer funds to if `transfer_data` was specified in the charge request.*/ destination: z .union([z.string().max(5000), AccountSchema]) .describe( @@ -36898,77 +34982,70 @@ export namespace stripe { export type ChargeTransferData = z.infer export const DeletedDiscountSchema = z.object({ - /** The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode. */ + /**The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.*/ checkout_session: z .string() .max(5000) - .nullable() .describe( 'The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.' ) .optional(), coupon: CouponSchema, - /** The ID of the customer associated with this discount. */ + /**The ID of the customer associated with this discount.*/ customer: z .union([z.string().max(5000), CustomerSchema, DeletedCustomerSchema]) - .nullable() .describe('The ID of the customer associated with this discount.') .optional(), - /** Always true for a deleted object */ + /**Always true for a deleted object*/ deleted: z.literal(true).describe('Always true for a deleted object'), - /** The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array. */ + /**The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array.*/ id: z .string() .max(5000) .describe( 'The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array.' ), - /** The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. */ + /**The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.*/ invoice: z .string() .max(5000) - .nullable() .describe( "The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice." ) .optional(), - /** The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item. */ + /**The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.*/ invoice_item: z .string() .max(5000) - .nullable() .describe( "The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item." ) .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('discount') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The promotion code applied to create this discount. */ + /**The promotion code applied to create this discount.*/ promotion_code: z .union([z.string().max(5000), PromotionCodeSchema]) - .nullable() .describe('The promotion code applied to create this discount.') .optional(), - /** Date that the coupon was applied. */ + /**Date that the coupon was applied.*/ start: z.number().int().describe('Date that the coupon was applied.'), - /** The subscription that this coupon is applied to, if it is applied to a particular subscription. */ + /**The subscription that this coupon is applied to, if it is applied to a particular subscription.*/ subscription: z .string() .max(5000) - .nullable() .describe( 'The subscription that this coupon is applied to, if it is applied to a particular subscription.' ) .optional(), - /** The subscription item that this coupon is applied to, if it is applied to a particular subscription item. */ + /**The subscription item that this coupon is applied to, if it is applied to a particular subscription item.*/ subscription_item: z .string() .max(5000) - .nullable() .describe( 'The subscription item that this coupon is applied to, if it is applied to a particular subscription item.' ) @@ -36977,12 +35054,12 @@ export namespace stripe { export type DeletedDiscount = z.infer export const InvoicesResourceFromInvoiceSchema = z.object({ - /** The relation between this invoice and the cloned invoice */ + /**The relation between this invoice and the cloned invoice*/ action: z .string() .max(5000) .describe('The relation between this invoice and the cloned invoice'), - /** The invoice that was cloned. */ + /**The invoice that was cloned.*/ invoice: z .union([z.string().max(5000), InvoiceSchema]) .describe('The invoice that was cloned.') @@ -36998,151 +35075,141 @@ export namespace stripe { */ export const LineItemSchema = z .object({ - /** The amount, in cents (or local equivalent). */ + /**The amount, in cents (or local equivalent).*/ amount: z .number() .int() .describe('The amount, in cents (or local equivalent).'), - /** The integer amount in cents (or local equivalent) representing the amount for this line item, excluding all tax and discounts. */ + /**The integer amount in cents (or local equivalent) representing the amount for this line item, excluding all tax and discounts.*/ amount_excluding_tax: z .number() .int() - .nullable() .describe( 'The integer amount in cents (or local equivalent) representing the amount for this line item, excluding all tax and discounts.' ) .optional(), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** An arbitrary string attached to the object. Often useful for displaying to users. */ + /**An arbitrary string attached to the object. Often useful for displaying to users.*/ description: z .string() .max(5000) - .nullable() .describe( 'An arbitrary string attached to the object. Often useful for displaying to users.' ) .optional(), - /** The amount of discount calculated per discount for this line item. */ + /**The amount of discount calculated per discount for this line item.*/ discount_amounts: z .array(DiscountsResourceDiscountAmountSchema) - .nullable() .describe( 'The amount of discount calculated per discount for this line item.' ) .optional(), - /** If true, discounts will apply to this line item. Always false for prorations. */ + /**If true, discounts will apply to this line item. Always false for prorations.*/ discountable: z .boolean() .describe( 'If true, discounts will apply to this line item. Always false for prorations.' ), - /** The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. */ + /**The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.*/ discounts: z .array(z.union([z.string().max(5000), DiscountSchema])) .describe( 'The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.' ), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** The ID of the invoice that contains this line item. */ + /**The ID of the invoice that contains this line item.*/ invoice: z .string() .max(5000) - .nullable() .describe('The ID of the invoice that contains this line item.') .optional(), - /** The ID of the [invoice item](https://stripe.com/docs/api/invoiceitems) associated with this line item if any. */ + /**The ID of the [invoice item](https://stripe.com/docs/api/invoiceitems) associated with this line item if any.*/ invoice_item: z .union([z.string().max(5000), InvoiceitemSchema]) .describe( 'The ID of the [invoice item](https://stripe.com/docs/api/invoiceitems) associated with this line item if any.' ) .optional(), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Note that for line items with `type=subscription`, `metadata` reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Note that for line items with `type=subscription`, `metadata` reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Note that for line items with `type=subscription`, `metadata` reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('line_item') .describe( "String representing the object's type. Objects of the same type share the same value." ), period: InvoiceLineItemPeriodSchema, - /** Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this line item. */ + /**Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this line item.*/ pretax_credit_amounts: z .array(InvoicesResourcePretaxCreditAmountSchema) - .nullable() .describe( 'Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this line item.' ) .optional(), - /** The price of the line item. */ - price: PriceSchema.nullable() - .describe('The price of the line item.') - .optional(), - /** Whether this is a proration. */ + /**The price of the line item.*/ + price: PriceSchema.describe('The price of the line item.').optional(), + /**Whether this is a proration.*/ proration: z.boolean().describe('Whether this is a proration.'), - /** Additional details for proration line items */ + /**Additional details for proration line items*/ proration_details: - InvoicesResourceLineItemsProrationDetailsSchema.nullable() - .describe('Additional details for proration line items') - .optional(), - /** The quantity of the subscription, if the line item is a subscription or a proration. */ + InvoicesResourceLineItemsProrationDetailsSchema.describe( + 'Additional details for proration line items' + ).optional(), + /**The quantity of the subscription, if the line item is a subscription or a proration.*/ quantity: z .number() .int() - .nullable() .describe( 'The quantity of the subscription, if the line item is a subscription or a proration.' ) .optional(), - /** The subscription that the invoice item pertains to, if any. */ + /**The subscription that the invoice item pertains to, if any.*/ subscription: z .union([z.string().max(5000), SubscriptionSchema]) - .nullable() .describe('The subscription that the invoice item pertains to, if any.') .optional(), - /** The subscription item that generated this line item. Left empty if the line item is not an explicit result of a subscription. */ + /**The subscription item that generated this line item. Left empty if the line item is not an explicit result of a subscription.*/ subscription_item: z .union([z.string().max(5000), SubscriptionItemSchema]) .describe( 'The subscription item that generated this line item. Left empty if the line item is not an explicit result of a subscription.' ) .optional(), - /** The amount of tax calculated per tax rate for this line item */ + /**The amount of tax calculated per tax rate for this line item*/ tax_amounts: z .array(InvoiceTaxAmountSchema) .describe( 'The amount of tax calculated per tax rate for this line item' ), - /** The tax rates which apply to the line item. */ + /**The tax rates which apply to the line item.*/ tax_rates: z .array(TaxRateSchema) .describe('The tax rates which apply to the line item.'), - /** A string identifying the type of the source of this line item, either an `invoiceitem` or a `subscription`. */ + /**A string identifying the type of the source of this line item, either an `invoiceitem` or a `subscription`.*/ type: z .enum(['invoiceitem', 'subscription']) .describe( 'A string identifying the type of the source of this line item, either an `invoiceitem` or a `subscription`.' ), - /** The amount in cents (or local equivalent) representing the unit amount for this line item, excluding all tax and discounts. */ + /**The amount in cents (or local equivalent) representing the unit amount for this line item, excluding all tax and discounts.*/ unit_amount_excluding_tax: z .string() - .nullable() .describe( 'The amount in cents (or local equivalent) representing the unit amount for this line item, excluding all tax and discounts.' ) @@ -37154,12 +35221,12 @@ export namespace stripe { export type LineItem = z.infer export const DiscountsResourceDiscountAmountSchema = z.object({ - /** The amount, in cents (or local equivalent), of the discount. */ + /**The amount, in cents (or local equivalent), of the discount.*/ amount: z .number() .int() .describe('The amount, in cents (or local equivalent), of the discount.'), - /** The discount that was applied to get this discount amount. */ + /**The discount that was applied to get this discount amount.*/ discount: z .union([z.string().max(5000), DiscountSchema, DeletedDiscountSchema]) .describe('The discount that was applied to get this discount amount.') @@ -37183,110 +35250,103 @@ export namespace stripe { */ export const InvoiceitemSchema = z .object({ - /** Amount (in the `currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`. */ + /**Amount (in the `currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`.*/ amount: z .number() .int() .describe( 'Amount (in the `currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** The ID of the customer who will be billed when this invoice item is billed. */ + /**The ID of the customer who will be billed when this invoice item is billed.*/ customer: z .union([z.string().max(5000), CustomerSchema, DeletedCustomerSchema]) .describe( 'The ID of the customer who will be billed when this invoice item is billed.' ), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ date: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** An arbitrary string attached to the object. Often useful for displaying to users. */ + /**An arbitrary string attached to the object. Often useful for displaying to users.*/ description: z .string() .max(5000) - .nullable() .describe( 'An arbitrary string attached to the object. Often useful for displaying to users.' ) .optional(), - /** If true, discounts will apply to this invoice item. Always false for prorations. */ + /**If true, discounts will apply to this invoice item. Always false for prorations.*/ discountable: z .boolean() .describe( 'If true, discounts will apply to this invoice item. Always false for prorations.' ), - /** The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. */ + /**The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.*/ discounts: z .array(z.union([z.string().max(5000), DiscountSchema])) - .nullable() .describe( 'The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.' ) .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** The ID of the invoice this invoice item belongs to. */ + /**The ID of the invoice this invoice item belongs to.*/ invoice: z .union([z.string().max(5000), InvoiceSchema]) - .nullable() .describe('The ID of the invoice this invoice item belongs to.') .optional(), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) - .nullable() .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ) .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('invoiceitem') .describe( "String representing the object's type. Objects of the same type share the same value." ), period: InvoiceLineItemPeriodSchema, - /** The price of the invoice item. */ - price: PriceSchema.nullable() - .describe('The price of the invoice item.') - .optional(), - /** Whether the invoice item was created automatically as a proration adjustment when the customer switched plans. */ + /**The price of the invoice item.*/ + price: PriceSchema.describe('The price of the invoice item.').optional(), + /**Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.*/ proration: z .boolean() .describe( 'Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.' ), - /** Quantity of units for the invoice item. If the invoice item is a proration, the quantity of the subscription that the proration was computed for. */ + /**Quantity of units for the invoice item. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.*/ quantity: z .number() .int() .describe( 'Quantity of units for the invoice item. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.' ), - /** The subscription that this invoice item has been created for, if any. */ + /**The subscription that this invoice item has been created for, if any.*/ subscription: z .union([z.string().max(5000), SubscriptionSchema]) - .nullable() .describe( 'The subscription that this invoice item has been created for, if any.' ) .optional(), - /** The subscription item that this invoice item has been created for, if any. */ + /**The subscription item that this invoice item has been created for, if any.*/ subscription_item: z .string() .max(5000) @@ -37294,33 +35354,29 @@ export namespace stripe { 'The subscription item that this invoice item has been created for, if any.' ) .optional(), - /** The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item. */ + /**The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item.*/ tax_rates: z .array(TaxRateSchema) - .nullable() .describe( 'The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item.' ) .optional(), - /** ID of the test clock this invoice item belongs to. */ + /**ID of the test clock this invoice item belongs to.*/ test_clock: z .union([z.string().max(5000), TestHelpersTestClockSchema]) - .nullable() .describe('ID of the test clock this invoice item belongs to.') .optional(), - /** Unit amount (in the `currency` specified) of the invoice item. */ + /**Unit amount (in the `currency` specified) of the invoice item.*/ unit_amount: z .number() .int() - .nullable() .describe( 'Unit amount (in the `currency` specified) of the invoice item.' ) .optional(), - /** Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. */ + /**Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.*/ unit_amount_decimal: z .string() - .nullable() .describe( 'Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.' ) @@ -37338,130 +35394,120 @@ export namespace stripe { */ export const SubscriptionSchema = z .object({ - /** ID of the Connect Application that created the subscription. */ + /**ID of the Connect Application that created the subscription.*/ application: z .union([ z.string().max(5000), ApplicationSchema, DeletedApplicationSchema ]) - .nullable() .describe( 'ID of the Connect Application that created the subscription.' ) .optional(), - /** A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. */ + /**A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.*/ application_fee_percent: z .number() - .nullable() .describe( "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account." ) .optional(), automatic_tax: SubscriptionAutomaticTaxSchema, - /** The reference point that aligns future [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle) dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. The timestamp is in UTC format. */ + /**The reference point that aligns future [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle) dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. The timestamp is in UTC format.*/ billing_cycle_anchor: z .number() .int() .describe( 'The reference point that aligns future [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle) dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. The timestamp is in UTC format.' ), - /** The fixed values used to calculate the `billing_cycle_anchor`. */ + /**The fixed values used to calculate the `billing_cycle_anchor`.*/ billing_cycle_anchor_config: - SubscriptionsResourceBillingCycleAnchorConfigSchema.nullable() - .describe( - 'The fixed values used to calculate the `billing_cycle_anchor`.' - ) - .optional(), - /** Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period */ - billing_thresholds: SubscriptionBillingThresholdsSchema.nullable() - .describe( - 'Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period' - ) - .optional(), - /** A date in the future at which the subscription will automatically get canceled */ + SubscriptionsResourceBillingCycleAnchorConfigSchema.describe( + 'The fixed values used to calculate the `billing_cycle_anchor`.' + ).optional(), + /**Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period*/ + billing_thresholds: SubscriptionBillingThresholdsSchema.describe( + 'Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period' + ).optional(), + /**A date in the future at which the subscription will automatically get canceled*/ cancel_at: z .number() .int() - .nullable() .describe( 'A date in the future at which the subscription will automatically get canceled' ) .optional(), - /** Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period. */ + /**Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period.*/ cancel_at_period_end: z .boolean() .describe( 'Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period.' ), - /** If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state. */ + /**If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.*/ canceled_at: z .number() .int() - .nullable() .describe( 'If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.' ) .optional(), - /** Details about why this subscription was cancelled */ - cancellation_details: CancellationDetailsSchema.nullable() - .describe('Details about why this subscription was cancelled') - .optional(), - /** Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. */ + /**Details about why this subscription was cancelled*/ + cancellation_details: CancellationDetailsSchema.describe( + 'Details about why this subscription was cancelled' + ).optional(), + /**Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.*/ collection_method: z .enum(['charge_automatically', 'send_invoice']) .describe( 'Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.' ), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created. */ + /**End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.*/ current_period_end: z .number() .int() .describe( 'End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.' ), - /** Start of the current period that the subscription has been invoiced for. */ + /**Start of the current period that the subscription has been invoiced for.*/ current_period_start: z .number() .int() .describe( 'Start of the current period that the subscription has been invoiced for.' ), - /** ID of the customer who owns the subscription. */ + /**ID of the customer who owns the subscription.*/ customer: z .union([z.string().max(5000), CustomerSchema, DeletedCustomerSchema]) .describe('ID of the customer who owns the subscription.'), - /** Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`. */ + /**Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`.*/ days_until_due: z .number() .int() - .nullable() .describe( 'Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`.' ) .optional(), - /** ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). */ + /**ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).*/ default_payment_method: z .union([z.string().max(5000), PaymentMethodSchema]) - .nullable() .describe( "ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source)." ) .optional(), - /** ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). */ + /**ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).*/ default_source: z .union([ z.string().max(5000), @@ -37469,159 +35515,140 @@ export namespace stripe { CardSchema, SourceSchema ]) - .nullable() .describe( "ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source)." ) .optional(), - /** The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. */ + /**The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription.*/ default_tax_rates: z .array(TaxRateSchema) - .nullable() .describe( 'The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription.' ) .optional(), - /** The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. */ + /**The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.*/ description: z .string() .max(500) - .nullable() .describe( "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs." ) .optional(), - /** Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ - discount: DiscountSchema.nullable() - .describe( - 'Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.' - ) - .optional(), - /** The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount. */ + /**Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.*/ + discount: DiscountSchema.describe( + 'Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.' + ).optional(), + /**The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.*/ discounts: z .array(z.union([z.string().max(5000), DiscountSchema])) .describe( 'The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.' ), - /** If the subscription has ended, the date the subscription ended. */ + /**If the subscription has ended, the date the subscription ended.*/ ended_at: z .number() .int() - .nullable() .describe( 'If the subscription has ended, the date the subscription ended.' ) .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), invoice_settings: SubscriptionsResourceSubscriptionInvoiceSettingsSchema, - /** List of subscription items, each with an attached price. */ + /**List of subscription items, each with an attached price.*/ items: z .object({ - /** Details about each object. */ + /**Details about each object.*/ data: z .array(SubscriptionItemSchema) .describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) .describe('The URL where this list can be accessed.') }) .describe('List of subscription items, each with an attached price.'), - /** The most recent invoice this subscription has generated. */ + /**The most recent invoice this subscription has generated.*/ latest_invoice: z .union([z.string().max(5000), InvoiceSchema]) - .nullable() .describe('The most recent invoice this subscription has generated.') .optional(), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ), - /** Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`. */ + /**Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`.*/ next_pending_invoice_item_invoice: z .number() .int() - .nullable() .describe( 'Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`.' ) .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('subscription') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details. */ + /**The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details.*/ on_behalf_of: z .union([z.string().max(5000), AccountSchema]) - .nullable() .describe( 'The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details.' ) .optional(), - /** If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment). */ - pause_collection: SubscriptionsResourcePauseCollectionSchema.nullable() - .describe( - 'If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).' - ) - .optional(), - /** Payment settings passed on to invoices created by the subscription. */ - payment_settings: SubscriptionsResourcePaymentSettingsSchema.nullable() - .describe( - 'Payment settings passed on to invoices created by the subscription.' - ) - .optional(), - /** Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval. */ + /**If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).*/ + pause_collection: SubscriptionsResourcePauseCollectionSchema.describe( + 'If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).' + ).optional(), + /**Payment settings passed on to invoices created by the subscription.*/ + payment_settings: SubscriptionsResourcePaymentSettingsSchema.describe( + 'Payment settings passed on to invoices created by the subscription.' + ).optional(), + /**Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.*/ pending_invoice_item_interval: - SubscriptionPendingInvoiceItemIntervalSchema.nullable() - .describe( - 'Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.' - ) - .optional(), - /** You can use this [SetupIntent](https://stripe.com/docs/api/setup_intents) to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication#scenario-2). */ + SubscriptionPendingInvoiceItemIntervalSchema.describe( + 'Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.' + ).optional(), + /**You can use this [SetupIntent](https://stripe.com/docs/api/setup_intents) to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication#scenario-2).*/ pending_setup_intent: z .union([z.string().max(5000), SetupIntentSchema]) - .nullable() .describe( "You can use this [SetupIntent](https://stripe.com/docs/api/setup_intents) to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication#scenario-2)." ) .optional(), - /** If specified, [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid. */ - pending_update: SubscriptionsResourcePendingUpdateSchema.nullable() - .describe( - 'If specified, [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid.' - ) - .optional(), - /** The schedule attached to the subscription */ + /**If specified, [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid.*/ + pending_update: SubscriptionsResourcePendingUpdateSchema.describe( + 'If specified, [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid.' + ).optional(), + /**The schedule attached to the subscription*/ schedule: z .union([z.string().max(5000), SubscriptionScheduleSchema]) - .nullable() .describe('The schedule attached to the subscription') .optional(), - /** Date when the subscription was first created. The date might differ from the `created` date due to backdating. */ + /**Date when the subscription was first created. The date might differ from the `created` date due to backdating.*/ start_date: z .number() .int() @@ -37655,34 +35682,29 @@ export namespace stripe { .describe( "Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, `unpaid`, or `paused`. \n\nFor `collection_method=charge_automatically` a subscription moves into `incomplete` if the initial payment attempt fails. A subscription in this status can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an `active` status. If the first invoice is not paid within 23 hours, the subscription transitions to `incomplete_expired`. This is a terminal status, the open invoice will be voided and no further invoices will be generated. \n\nA subscription that is currently in a trial period is `trialing` and moves to `active` when the trial period is over. \n\nA subscription can only enter a `paused` status [when a trial ends without a payment method](https://stripe.com/docs/billing/subscriptions/trials#create-free-trials-without-payment). A `paused` subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The `paused` status is different from [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment), which still generates invoices and leaves the subscription's status unchanged. \n\nIf subscription `collection_method=charge_automatically`, it becomes `past_due` when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become `canceled` or `unpaid` (depending on your subscriptions settings). \n\nIf subscription `collection_method=send_invoice` it becomes `past_due` when its invoice is not paid by the due date, and `canceled` or `unpaid` if it is still not paid by an additional deadline after that. Note that when a subscription has a status of `unpaid`, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices." ), - /** ID of the test clock this subscription belongs to. */ + /**ID of the test clock this subscription belongs to.*/ test_clock: z .union([z.string().max(5000), TestHelpersTestClockSchema]) - .nullable() .describe('ID of the test clock this subscription belongs to.') .optional(), - /** The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices. */ - transfer_data: SubscriptionTransferDataSchema.nullable() - .describe( - "The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices." - ) - .optional(), - /** If the subscription has a trial, the end of that trial. */ + /**The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.*/ + transfer_data: SubscriptionTransferDataSchema.describe( + "The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices." + ).optional(), + /**If the subscription has a trial, the end of that trial.*/ trial_end: z .number() .int() - .nullable() .describe('If the subscription has a trial, the end of that trial.') .optional(), - /** Settings related to subscription trials. */ - trial_settings: SubscriptionsTrialsResourceTrialSettingsSchema.nullable() - .describe('Settings related to subscription trials.') - .optional(), - /** If the subscription has a trial, the beginning of that trial. */ + /**Settings related to subscription trials.*/ + trial_settings: SubscriptionsTrialsResourceTrialSettingsSchema.describe( + 'Settings related to subscription trials.' + ).optional(), + /**If the subscription has a trial, the beginning of that trial.*/ trial_start: z .number() .int() - .nullable() .describe( 'If the subscription has a trial, the beginning of that trial.' ) @@ -37694,24 +35716,21 @@ export namespace stripe { export type Subscription = z.infer export const SubscriptionAutomaticTaxSchema = z.object({ - /** If Stripe disabled automatic tax, this enum describes why. */ + /**If Stripe disabled automatic tax, this enum describes why.*/ disabled_reason: z .literal('requires_location_inputs') - .nullable() .describe('If Stripe disabled automatic tax, this enum describes why.') .optional(), - /** Whether Stripe automatically computes tax on this subscription. */ + /**Whether Stripe automatically computes tax on this subscription.*/ enabled: z .boolean() .describe( 'Whether Stripe automatically computes tax on this subscription.' ), - /** The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. */ - liability: ConnectAccountReferenceSchema.nullable() - .describe( - "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account." - ) - .optional() + /**The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.*/ + liability: ConnectAccountReferenceSchema.describe( + "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account." + ).optional() }) export type SubscriptionAutomaticTax = z.infer< typeof SubscriptionAutomaticTaxSchema @@ -37719,10 +35738,9 @@ export namespace stripe { export const SubscriptionsResourceSubscriptionInvoiceSettingsSchema = z.object({ - /** The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription. */ + /**The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.*/ account_tax_ids: z .array(z.union([z.string().max(5000), TaxIdSchema, DeletedTaxIdSchema])) - .nullable() .describe( 'The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.' ) @@ -37739,41 +35757,39 @@ export namespace stripe { */ export const SubscriptionItemSchema = z .object({ - /** Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period */ - billing_thresholds: SubscriptionItemBillingThresholdsSchema.nullable() - .describe( - 'Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period' - ) - .optional(), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period*/ + billing_thresholds: SubscriptionItemBillingThresholdsSchema.describe( + 'Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period' + ).optional(), + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount. */ + /**The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.*/ discounts: z .array(z.union([z.string().max(5000), DiscountSchema])) .describe( 'The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.' ), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('subscription_item') .describe( "String representing the object's type. Objects of the same type share the same value." ), price: PriceSchema, - /** The [quantity](https://stripe.com/docs/subscriptions/quantities) of the plan to which the customer should be subscribed. */ + /**The [quantity](https://stripe.com/docs/subscriptions/quantities) of the plan to which the customer should be subscribed.*/ quantity: z .number() .int() @@ -37781,15 +35797,14 @@ export namespace stripe { 'The [quantity](https://stripe.com/docs/subscriptions/quantities) of the plan to which the customer should be subscribed.' ) .optional(), - /** The `subscription` this `subscription_item` belongs to. */ + /**The `subscription` this `subscription_item` belongs to.*/ subscription: z .string() .max(5000) .describe('The `subscription` this `subscription_item` belongs to.'), - /** The tax rates which apply to this `subscription_item`. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`. */ + /**The tax rates which apply to this `subscription_item`. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.*/ tax_rates: z .array(TaxRateSchema) - .nullable() .describe( 'The tax rates which apply to this `subscription_item`. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.' ) @@ -37825,10 +35840,9 @@ export namespace stripe { */ export const SetupIntentSchema = z .object({ - /** ID of the Connect application that created the SetupIntent. */ + /**ID of the Connect application that created the SetupIntent.*/ application: z .union([z.string().max(5000), ApplicationSchema]) - .nullable() .describe('ID of the Connect application that created the SetupIntent.') .optional(), /** @@ -37842,17 +35856,14 @@ export namespace stripe { "If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.\n\nIt can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer." ) .optional(), - /** Settings for dynamic payment methods compatible with this Setup Intent */ + /**Settings for dynamic payment methods compatible with this Setup Intent*/ automatic_payment_methods: - PaymentFlowsAutomaticPaymentMethodsSetupIntentSchema.nullable() - .describe( - 'Settings for dynamic payment methods compatible with this Setup Intent' - ) - .optional(), - /** Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`. */ + PaymentFlowsAutomaticPaymentMethodsSetupIntentSchema.describe( + 'Settings for dynamic payment methods compatible with this Setup Intent' + ).optional(), + /**Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`.*/ cancellation_reason: z .enum(['abandoned', 'duplicate', 'requested_by_customer']) - .nullable() .describe( 'Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`.' ) @@ -37865,12 +35876,11 @@ export namespace stripe { client_secret: z .string() .max(5000) - .nullable() .describe( 'The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.\n\nThe client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.' ) .optional(), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() @@ -37884,16 +35894,14 @@ export namespace stripe { */ customer: z .union([z.string().max(5000), CustomerSchema, DeletedCustomerSchema]) - .nullable() .describe( "ID of the Customer this SetupIntent belongs to, if one exists.\n\nIf present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent." ) .optional(), - /** An arbitrary string attached to the object. Often useful for displaying to users. */ + /**An arbitrary string attached to the object. Often useful for displaying to users.*/ description: z .string() .max(5000) - .nullable() .describe( 'An arbitrary string attached to the object. Often useful for displaying to users.' ) @@ -37905,95 +35913,82 @@ export namespace stripe { */ flow_directions: z .array(z.enum(['inbound', 'outbound'])) - .nullable() .describe( 'Indicates the directions of money movement for which this payment method is intended to be used.\n\nInclude `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.' ) .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** The error encountered in the previous SetupIntent confirmation. */ - last_setup_error: ApiErrorsSchema.nullable() - .describe( - 'The error encountered in the previous SetupIntent confirmation.' - ) - .optional(), - /** The most recent SetupAttempt for this SetupIntent. */ + /**The error encountered in the previous SetupIntent confirmation.*/ + last_setup_error: ApiErrorsSchema.describe( + 'The error encountered in the previous SetupIntent confirmation.' + ).optional(), + /**The most recent SetupAttempt for this SetupIntent.*/ latest_attempt: z .union([z.string().max(5000), SetupAttemptSchema]) - .nullable() .describe('The most recent SetupAttempt for this SetupIntent.') .optional(), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** ID of the multi use Mandate generated by the SetupIntent. */ + /**ID of the multi use Mandate generated by the SetupIntent.*/ mandate: z .union([z.string().max(5000), MandateSchema]) - .nullable() .describe('ID of the multi use Mandate generated by the SetupIntent.') .optional(), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) - .nullable() .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ) .optional(), - /** If present, this property tells you what actions you need to take in order for your customer to continue payment setup. */ - next_action: SetupIntentNextActionSchema.nullable() - .describe( - 'If present, this property tells you what actions you need to take in order for your customer to continue payment setup.' - ) - .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**If present, this property tells you what actions you need to take in order for your customer to continue payment setup.*/ + next_action: SetupIntentNextActionSchema.describe( + 'If present, this property tells you what actions you need to take in order for your customer to continue payment setup.' + ).optional(), + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('setup_intent') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The account (if any) for which the setup is intended. */ + /**The account (if any) for which the setup is intended.*/ on_behalf_of: z .union([z.string().max(5000), AccountSchema]) - .nullable() .describe('The account (if any) for which the setup is intended.') .optional(), - /** ID of the payment method used with this SetupIntent. If the payment method is `card_present` and isn't a digital wallet, then the [generated_card](https://docs.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card) associated with the `latest_attempt` is attached to the Customer instead. */ + /**ID of the payment method used with this SetupIntent. If the payment method is `card_present` and isn't a digital wallet, then the [generated_card](https://docs.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card) associated with the `latest_attempt` is attached to the Customer instead.*/ payment_method: z .union([z.string().max(5000), PaymentMethodSchema]) - .nullable() .describe( "ID of the payment method used with this SetupIntent. If the payment method is `card_present` and isn't a digital wallet, then the [generated_card](https://docs.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card) associated with the `latest_attempt` is attached to the Customer instead." ) .optional(), - /** Information about the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) used for this Setup Intent. */ + /**Information about the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) used for this Setup Intent.*/ payment_method_configuration_details: - PaymentMethodConfigBizPaymentMethodConfigurationDetailsSchema.nullable() - .describe( - 'Information about the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) used for this Setup Intent.' - ) - .optional(), - /** Payment method-specific configuration for this SetupIntent. */ - payment_method_options: SetupIntentPaymentMethodOptionsSchema.nullable() - .describe('Payment method-specific configuration for this SetupIntent.') - .optional(), - /** The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. */ + PaymentMethodConfigBizPaymentMethodConfigurationDetailsSchema.describe( + 'Information about the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) used for this Setup Intent.' + ).optional(), + /**Payment method-specific configuration for this SetupIntent.*/ + payment_method_options: SetupIntentPaymentMethodOptionsSchema.describe( + 'Payment method-specific configuration for this SetupIntent.' + ).optional(), + /**The list of payment method types (e.g. card) that this SetupIntent is allowed to set up.*/ payment_method_types: z .array(z.string().max(5000)) .describe( 'The list of payment method types (e.g. card) that this SetupIntent is allowed to set up.' ), - /** ID of the single_use Mandate generated by the SetupIntent. */ + /**ID of the single_use Mandate generated by the SetupIntent.*/ single_use_mandate: z .union([z.string().max(5000), MandateSchema]) - .nullable() .describe('ID of the single_use Mandate generated by the SetupIntent.') .optional(), - /** [Status](https://stripe.com/docs/payments/intents#intent-statuses) of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`. */ + /**[Status](https://stripe.com/docs/payments/intents#intent-statuses) of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`.*/ status: z .enum([ 'canceled', @@ -38029,43 +36024,39 @@ export namespace stripe { */ export const SubscriptionsResourcePendingUpdateSchema = z .object({ - /** If the update is applied, determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. The timestamp is in UTC format. */ + /**If the update is applied, determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. The timestamp is in UTC format.*/ billing_cycle_anchor: z .number() .int() - .nullable() .describe( 'If the update is applied, determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. The timestamp is in UTC format.' ) .optional(), - /** The point after which the changes reflected by this update will be discarded and no longer applied. */ + /**The point after which the changes reflected by this update will be discarded and no longer applied.*/ expires_at: z .number() .int() .describe( 'The point after which the changes reflected by this update will be discarded and no longer applied.' ), - /** List of subscription items, each with an attached plan, that will be set if the update is applied. */ + /**List of subscription items, each with an attached plan, that will be set if the update is applied.*/ subscription_items: z .array(SubscriptionItemSchema) - .nullable() .describe( 'List of subscription items, each with an attached plan, that will be set if the update is applied.' ) .optional(), - /** Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied. */ + /**Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied.*/ trial_end: z .number() .int() - .nullable() .describe( 'Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied.' ) .optional(), - /** Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ + /**Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.*/ trial_from_plan: z .boolean() - .nullable() .describe( "Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more." ) @@ -38085,120 +36076,110 @@ export namespace stripe { */ export const SubscriptionScheduleSchema = z .object({ - /** ID of the Connect Application that created the schedule. */ + /**ID of the Connect Application that created the schedule.*/ application: z .union([ z.string().max(5000), ApplicationSchema, DeletedApplicationSchema ]) - .nullable() .describe('ID of the Connect Application that created the schedule.') .optional(), - /** Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch. */ + /**Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.*/ canceled_at: z .number() .int() - .nullable() .describe( 'Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.' ) .optional(), - /** Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch. */ + /**Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.*/ completed_at: z .number() .int() - .nullable() .describe( 'Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.' ) .optional(), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`. */ - current_phase: SubscriptionScheduleCurrentPhaseSchema.nullable() - .describe( - 'Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`.' - ) - .optional(), - /** ID of the customer who owns the subscription schedule. */ + /**Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`.*/ + current_phase: SubscriptionScheduleCurrentPhaseSchema.describe( + 'Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`.' + ).optional(), + /**ID of the customer who owns the subscription schedule.*/ customer: z .union([z.string().max(5000), CustomerSchema, DeletedCustomerSchema]) .describe('ID of the customer who owns the subscription schedule.'), default_settings: SubscriptionSchedulesResourceDefaultSettingsSchema, - /** Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription. */ + /**Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.*/ end_behavior: z .enum(['cancel', 'none', 'release', 'renew']) .describe( 'Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.' ), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) - .nullable() .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ) .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('subscription_schedule') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** Configuration for the subscription schedule's phases. */ + /**Configuration for the subscription schedule's phases.*/ phases: z .array(SubscriptionSchedulePhaseConfigurationSchema) .describe("Configuration for the subscription schedule's phases."), - /** Time at which the subscription schedule was released. Measured in seconds since the Unix epoch. */ + /**Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.*/ released_at: z .number() .int() - .nullable() .describe( 'Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.' ) .optional(), - /** ID of the subscription once managed by the subscription schedule (if it is released). */ + /**ID of the subscription once managed by the subscription schedule (if it is released).*/ released_subscription: z .string() .max(5000) - .nullable() .describe( 'ID of the subscription once managed by the subscription schedule (if it is released).' ) .optional(), - /** The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior guide](https://stripe.com/docs/billing/subscriptions/subscription-schedules). */ + /**The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior guide](https://stripe.com/docs/billing/subscriptions/subscription-schedules).*/ status: z .enum(['active', 'canceled', 'completed', 'not_started', 'released']) .describe( 'The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior guide](https://stripe.com/docs/billing/subscriptions/subscription-schedules).' ), - /** ID of the subscription managed by the subscription schedule. */ + /**ID of the subscription managed by the subscription schedule.*/ subscription: z .union([z.string().max(5000), SubscriptionSchema]) - .nullable() .describe( 'ID of the subscription managed by the subscription schedule.' ) .optional(), - /** ID of the test clock this subscription schedule belongs to. */ + /**ID of the test clock this subscription schedule belongs to.*/ test_clock: z .union([z.string().max(5000), TestHelpersTestClockSchema]) - .nullable() .describe('ID of the test clock this subscription schedule belongs to.') .optional() }) @@ -38208,68 +36189,59 @@ export namespace stripe { export type SubscriptionSchedule = z.infer export const SubscriptionSchedulesResourceDefaultSettingsSchema = z.object({ - /** A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account during this phase of the schedule. */ + /**A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account during this phase of the schedule.*/ application_fee_percent: z .number() - .nullable() .describe( "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account during this phase of the schedule." ) .optional(), automatic_tax: SubscriptionSchedulesResourceDefaultSettingsAutomaticTaxSchema.optional(), - /** Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). */ + /**Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).*/ billing_cycle_anchor: z .enum(['automatic', 'phase_start']) .describe( 'Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).' ), - /** Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period */ - billing_thresholds: SubscriptionBillingThresholdsSchema.nullable() - .describe( - 'Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period' - ) - .optional(), - /** Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. */ + /**Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period*/ + billing_thresholds: SubscriptionBillingThresholdsSchema.describe( + 'Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period' + ).optional(), + /**Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.*/ collection_method: z .enum(['charge_automatically', 'send_invoice']) - .nullable() .describe( 'Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.' ) .optional(), - /** ID of the default payment method for the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings. */ + /**ID of the default payment method for the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.*/ default_payment_method: z .union([z.string().max(5000), PaymentMethodSchema]) - .nullable() .describe( "ID of the default payment method for the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings." ) .optional(), - /** Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. */ + /**Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.*/ description: z .string() .max(5000) - .nullable() .describe( 'Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.' ) .optional(), invoice_settings: InvoiceSettingSubscriptionScheduleSettingSchema, - /** The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details. */ + /**The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.*/ on_behalf_of: z .union([z.string().max(5000), AccountSchema]) - .nullable() .describe( "The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details." ) .optional(), - /** The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices. */ - transfer_data: SubscriptionTransferDataSchema.nullable() - .describe( - "The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices." - ) - .optional() + /**The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.*/ + transfer_data: SubscriptionTransferDataSchema.describe( + "The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices." + ).optional() }) export type SubscriptionSchedulesResourceDefaultSettings = z.infer< typeof SubscriptionSchedulesResourceDefaultSettingsSchema @@ -38277,24 +36249,21 @@ export namespace stripe { export const SubscriptionSchedulesResourceDefaultSettingsAutomaticTaxSchema = z.object({ - /** If Stripe disabled automatic tax, this enum describes why. */ + /**If Stripe disabled automatic tax, this enum describes why.*/ disabled_reason: z .literal('requires_location_inputs') - .nullable() .describe('If Stripe disabled automatic tax, this enum describes why.') .optional(), - /** Whether Stripe automatically computes tax on invoices created during this phase. */ + /**Whether Stripe automatically computes tax on invoices created during this phase.*/ enabled: z .boolean() .describe( 'Whether Stripe automatically computes tax on invoices created during this phase.' ), - /** The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. */ - liability: ConnectAccountReferenceSchema.nullable() - .describe( - "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account." - ) - .optional() + /**The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.*/ + liability: ConnectAccountReferenceSchema.describe( + "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account." + ).optional() }) export type SubscriptionSchedulesResourceDefaultSettingsAutomaticTax = z.infer< @@ -38302,19 +36271,17 @@ export namespace stripe { > export const InvoiceSettingSubscriptionScheduleSettingSchema = z.object({ - /** The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule. */ + /**The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.*/ account_tax_ids: z .array(z.union([z.string().max(5000), TaxIdSchema, DeletedTaxIdSchema])) - .nullable() .describe( 'The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule.' ) .optional(), - /** Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`. */ + /**Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.*/ days_until_due: z .number() .int() - .nullable() .describe( 'Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.' ) @@ -38326,15 +36293,14 @@ export namespace stripe { > export const SubscriptionTransferDataSchema = z.object({ - /** A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. */ + /**A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.*/ amount_percent: z .number() - .nullable() .describe( 'A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.' ) .optional(), - /** The account where funds from the payment will be transferred to upon payment success. */ + /**The account where funds from the payment will be transferred to upon payment success.*/ destination: z .union([z.string().max(5000), AccountSchema]) .describe( @@ -38345,145 +36311,131 @@ export namespace stripe { typeof SubscriptionTransferDataSchema > - /** A phase describes the plans, coupon, and trialing status of a subscription for a predefined time period. */ + /**A phase describes the plans, coupon, and trialing status of a subscription for a predefined time period.*/ export const SubscriptionSchedulePhaseConfigurationSchema = z .object({ - /** A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. */ + /**A list of prices and quantities that will generate invoice items appended to the next invoice for this phase.*/ add_invoice_items: z .array(SubscriptionScheduleAddInvoiceItemSchema) .describe( 'A list of prices and quantities that will generate invoice items appended to the next invoice for this phase.' ), - /** A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account during this phase of the schedule. */ + /**A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account during this phase of the schedule.*/ application_fee_percent: z .number() - .nullable() .describe( "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account during this phase of the schedule." ) .optional(), automatic_tax: SchedulesPhaseAutomaticTaxSchema.optional(), - /** Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). */ + /**Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).*/ billing_cycle_anchor: z .enum(['automatic', 'phase_start']) - .nullable() .describe( 'Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).' ) .optional(), - /** Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period */ - billing_thresholds: SubscriptionBillingThresholdsSchema.nullable() - .describe( - 'Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period' - ) - .optional(), - /** Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. */ + /**Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period*/ + billing_thresholds: SubscriptionBillingThresholdsSchema.describe( + 'Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period' + ).optional(), + /**Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.*/ collection_method: z .enum(['charge_automatically', 'send_invoice']) - .nullable() .describe( 'Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.' ) .optional(), - /** ID of the coupon to use during this phase of the subscription schedule. */ + /**ID of the coupon to use during this phase of the subscription schedule.*/ coupon: z .union([z.string().max(5000), CouponSchema, DeletedCouponSchema]) - .nullable() .describe( 'ID of the coupon to use during this phase of the subscription schedule.' ) .optional(), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings. */ + /**ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.*/ default_payment_method: z .union([z.string().max(5000), PaymentMethodSchema]) - .nullable() .describe( "ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings." ) .optional(), - /** The default tax rates to apply to the subscription during this phase of the subscription schedule. */ + /**The default tax rates to apply to the subscription during this phase of the subscription schedule.*/ default_tax_rates: z .array(TaxRateSchema) - .nullable() .describe( 'The default tax rates to apply to the subscription during this phase of the subscription schedule.' ) .optional(), - /** Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. */ + /**Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.*/ description: z .string() .max(5000) - .nullable() .describe( 'Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.' ) .optional(), - /** The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts. */ + /**The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts.*/ discounts: z .array(DiscountsResourceStackableDiscountSchema) .describe( 'The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts.' ), - /** The end of this phase of the subscription schedule. */ + /**The end of this phase of the subscription schedule.*/ end_date: z .number() .int() .describe('The end of this phase of the subscription schedule.'), - /** The invoice settings applicable during this phase. */ + /**The invoice settings applicable during this phase.*/ invoice_settings: - InvoiceSettingSubscriptionSchedulePhaseSettingSchema.nullable() - .describe('The invoice settings applicable during this phase.') - .optional(), - /** Subscription items to configure the subscription to during this phase of the subscription schedule. */ + InvoiceSettingSubscriptionSchedulePhaseSettingSchema.describe( + 'The invoice settings applicable during this phase.' + ).optional(), + /**Subscription items to configure the subscription to during this phase of the subscription schedule.*/ items: z .array(SubscriptionScheduleConfigurationItemSchema) .describe( 'Subscription items to configure the subscription to during this phase of the subscription schedule.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered. Updating the underlying subscription's `metadata` directly will not affect the current phase's `metadata`. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered. Updating the underlying subscription's `metadata` directly will not affect the current phase's `metadata`.*/ metadata: z .record(z.string().max(500)) - .nullable() .describe( "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered. Updating the underlying subscription's `metadata` directly will not affect the current phase's `metadata`." ) .optional(), - /** The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details. */ + /**The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.*/ on_behalf_of: z .union([z.string().max(5000), AccountSchema]) - .nullable() .describe( "The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details." ) .optional(), - /** If the subscription schedule will prorate when transitioning to this phase. Possible values are `create_prorations` and `none`. */ + /**If the subscription schedule will prorate when transitioning to this phase. Possible values are `create_prorations` and `none`.*/ proration_behavior: z .enum(['always_invoice', 'create_prorations', 'none']) .describe( 'If the subscription schedule will prorate when transitioning to this phase. Possible values are `create_prorations` and `none`.' ), - /** The start of this phase of the subscription schedule. */ + /**The start of this phase of the subscription schedule.*/ start_date: z .number() .int() .describe('The start of this phase of the subscription schedule.'), - /** The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices. */ - transfer_data: SubscriptionTransferDataSchema.nullable() - .describe( - "The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices." - ) - .optional(), - /** When the trial ends within the phase. */ + /**The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.*/ + transfer_data: SubscriptionTransferDataSchema.describe( + "The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices." + ).optional(), + /**When the trial ends within the phase.*/ trial_end: z .number() .int() - .nullable() .describe('When the trial ends within the phase.') .optional() }) @@ -38494,28 +36446,26 @@ export namespace stripe { typeof SubscriptionSchedulePhaseConfigurationSchema > - /** An Add Invoice Item describes the prices and quantities that will be added as pending invoice items when entering a phase. */ + /**An Add Invoice Item describes the prices and quantities that will be added as pending invoice items when entering a phase.*/ export const SubscriptionScheduleAddInvoiceItemSchema = z .object({ - /** The stackable discounts that will be applied to the item. */ + /**The stackable discounts that will be applied to the item.*/ discounts: z .array(DiscountsResourceStackableDiscountSchema) .describe('The stackable discounts that will be applied to the item.'), - /** ID of the price used to generate the invoice item. */ + /**ID of the price used to generate the invoice item.*/ price: z .union([z.string().max(5000), PriceSchema, DeletedPriceSchema]) .describe('ID of the price used to generate the invoice item.'), - /** The quantity of the invoice item. */ + /**The quantity of the invoice item.*/ quantity: z .number() .int() - .nullable() .describe('The quantity of the invoice item.') .optional(), - /** The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item. */ + /**The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.*/ tax_rates: z .array(TaxRateSchema) - .nullable() .describe( 'The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.' ) @@ -38529,24 +36479,21 @@ export namespace stripe { > export const DiscountsResourceStackableDiscountSchema = z.object({ - /** ID of the coupon to create a new discount for. */ + /**ID of the coupon to create a new discount for.*/ coupon: z .union([z.string().max(5000), CouponSchema]) - .nullable() .describe('ID of the coupon to create a new discount for.') .optional(), - /** ID of an existing discount on the object (or one of its ancestors) to reuse. */ + /**ID of an existing discount on the object (or one of its ancestors) to reuse.*/ discount: z .union([z.string().max(5000), DiscountSchema]) - .nullable() .describe( 'ID of an existing discount on the object (or one of its ancestors) to reuse.' ) .optional(), - /** ID of the promotion code to create a new discount for. */ + /**ID of the promotion code to create a new discount for.*/ promotion_code: z .union([z.string().max(5000), PromotionCodeSchema]) - .nullable() .describe('ID of the promotion code to create a new discount for.') .optional() }) @@ -38555,88 +36502,78 @@ export namespace stripe { > export const SchedulesPhaseAutomaticTaxSchema = z.object({ - /** If Stripe disabled automatic tax, this enum describes why. */ + /**If Stripe disabled automatic tax, this enum describes why.*/ disabled_reason: z .literal('requires_location_inputs') - .nullable() .describe('If Stripe disabled automatic tax, this enum describes why.') .optional(), - /** Whether Stripe automatically computes tax on invoices created during this phase. */ + /**Whether Stripe automatically computes tax on invoices created during this phase.*/ enabled: z .boolean() .describe( 'Whether Stripe automatically computes tax on invoices created during this phase.' ), - /** The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. */ - liability: ConnectAccountReferenceSchema.nullable() - .describe( - "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account." - ) - .optional() + /**The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.*/ + liability: ConnectAccountReferenceSchema.describe( + "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account." + ).optional() }) export type SchedulesPhaseAutomaticTax = z.infer< typeof SchedulesPhaseAutomaticTaxSchema > export const InvoiceSettingSubscriptionSchedulePhaseSettingSchema = z.object({ - /** The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule. */ + /**The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.*/ account_tax_ids: z .array(z.union([z.string().max(5000), TaxIdSchema, DeletedTaxIdSchema])) - .nullable() .describe( 'The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.' ) .optional(), - /** Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`. */ + /**Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.*/ days_until_due: z .number() .int() - .nullable() .describe( 'Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.' ) .optional(), - /** The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. */ - issuer: ConnectAccountReferenceSchema.nullable() - .describe( - 'The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.' - ) - .optional() + /**The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.*/ + issuer: ConnectAccountReferenceSchema.describe( + 'The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.' + ).optional() }) export type InvoiceSettingSubscriptionSchedulePhaseSetting = z.infer< typeof InvoiceSettingSubscriptionSchedulePhaseSettingSchema > - /** A phase item describes the price and quantity of a phase. */ + /**A phase item describes the price and quantity of a phase.*/ export const SubscriptionScheduleConfigurationItemSchema = z .object({ - /** Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period */ - billing_thresholds: SubscriptionItemBillingThresholdsSchema.nullable() - .describe( - 'Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period' - ) - .optional(), - /** The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount. */ + /**Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period*/ + billing_thresholds: SubscriptionItemBillingThresholdsSchema.describe( + 'Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period' + ).optional(), + /**The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.*/ discounts: z .array(DiscountsResourceStackableDiscountSchema) .describe( 'The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered.*/ metadata: z .record(z.string().max(500)) - .nullable() .describe( "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered." ) .optional(), - /** ID of the price to which the customer should be subscribed. */ + /**ID of the price to which the customer should be subscribed.*/ price: z .union([z.string().max(5000), PriceSchema, DeletedPriceSchema]) .describe( 'ID of the price to which the customer should be subscribed.' ), - /** Quantity of the plan to which the customer should be subscribed. */ + /**Quantity of the plan to which the customer should be subscribed.*/ quantity: z .number() .int() @@ -38644,10 +36581,9 @@ export namespace stripe { 'Quantity of the plan to which the customer should be subscribed.' ) .optional(), - /** The tax rates which apply to this `phase_item`. When set, the `default_tax_rates` on the phase do not apply to this `phase_item`. */ + /**The tax rates which apply to this `phase_item`. When set, the `default_tax_rates` on the phase do not apply to this `phase_item`.*/ tax_rates: z .array(TaxRateSchema) - .nullable() .describe( 'The tax rates which apply to this `phase_item`. When set, the `default_tax_rates` on the phase do not apply to this `phase_item`.' ) @@ -38659,29 +36595,28 @@ export namespace stripe { > export const InvoicesResourcePretaxCreditAmountSchema = z.object({ - /** The amount, in cents (or local equivalent), of the pretax credit amount. */ + /**The amount, in cents (or local equivalent), of the pretax credit amount.*/ amount: z .number() .int() .describe( 'The amount, in cents (or local equivalent), of the pretax credit amount.' ), - /** The credit balance transaction that was applied to get this pretax credit amount. */ + /**The credit balance transaction that was applied to get this pretax credit amount.*/ credit_balance_transaction: z .union([z.string().max(5000), BillingCreditBalanceTransactionSchema]) - .nullable() .describe( 'The credit balance transaction that was applied to get this pretax credit amount.' ) .optional(), - /** The discount that was applied to get this pretax credit amount. */ + /**The discount that was applied to get this pretax credit amount.*/ discount: z .union([z.string().max(5000), DiscountSchema, DeletedDiscountSchema]) .describe( 'The discount that was applied to get this pretax credit amount.' ) .optional(), - /** Type of the pretax credit amount referenced. */ + /**Type of the pretax credit amount referenced.*/ type: z .enum(['credit_balance_transaction', 'discount']) .describe('Type of the pretax credit amount referenced.') @@ -38690,65 +36625,59 @@ export namespace stripe { typeof InvoicesResourcePretaxCreditAmountSchema > - /** A credit balance transaction is a resource representing a transaction (either a credit or a debit) against an existing credit grant. */ + /**A credit balance transaction is a resource representing a transaction (either a credit or a debit) against an existing credit grant.*/ export const BillingCreditBalanceTransactionSchema = z .object({ - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Credit details for this credit balance transaction. Only present if type is `credit`. */ - credit: BillingCreditGrantsResourceBalanceCreditSchema.nullable() - .describe( - 'Credit details for this credit balance transaction. Only present if type is `credit`.' - ) - .optional(), - /** The credit grant associated with this credit balance transaction. */ + /**Credit details for this credit balance transaction. Only present if type is `credit`.*/ + credit: BillingCreditGrantsResourceBalanceCreditSchema.describe( + 'Credit details for this credit balance transaction. Only present if type is `credit`.' + ).optional(), + /**The credit grant associated with this credit balance transaction.*/ credit_grant: z .union([z.string().max(5000), BillingCreditGrantSchema]) .describe( 'The credit grant associated with this credit balance transaction.' ), - /** Debit details for this credit balance transaction. Only present if type is `debit`. */ - debit: BillingCreditGrantsResourceBalanceDebitSchema.nullable() - .describe( - 'Debit details for this credit balance transaction. Only present if type is `debit`.' - ) - .optional(), - /** The effective time of this credit balance transaction. */ + /**Debit details for this credit balance transaction. Only present if type is `debit`.*/ + debit: BillingCreditGrantsResourceBalanceDebitSchema.describe( + 'Debit details for this credit balance transaction. Only present if type is `debit`.' + ).optional(), + /**The effective time of this credit balance transaction.*/ effective_at: z .number() .int() .describe('The effective time of this credit balance transaction.'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('billing.credit_balance_transaction') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** ID of the test clock this credit balance transaction belongs to. */ + /**ID of the test clock this credit balance transaction belongs to.*/ test_clock: z .union([z.string().max(5000), TestHelpersTestClockSchema]) - .nullable() .describe( 'ID of the test clock this credit balance transaction belongs to.' ) .optional(), - /** The type of credit balance transaction (credit or debit). */ + /**The type of credit balance transaction (credit or debit).*/ type: z .enum(['credit', 'debit']) - .nullable() .describe('The type of credit balance transaction (credit or debit).') .optional() }) @@ -38761,14 +36690,12 @@ export namespace stripe { export const BillingCreditGrantsResourceBalanceCreditSchema = z.object({ amount: BillingCreditGrantsResourceAmountSchema, - /** Details of the invoice to which the reinstated credits were originally applied. Only present if `type` is `credits_application_invoice_voided`. */ + /**Details of the invoice to which the reinstated credits were originally applied. Only present if `type` is `credits_application_invoice_voided`.*/ credits_application_invoice_voided: - BillingCreditGrantsResourceBalanceCreditsApplicationInvoiceVoidedSchema.nullable() - .describe( - 'Details of the invoice to which the reinstated credits were originally applied. Only present if `type` is `credits_application_invoice_voided`.' - ) - .optional(), - /** The type of credit transaction. */ + BillingCreditGrantsResourceBalanceCreditsApplicationInvoiceVoidedSchema.describe( + 'Details of the invoice to which the reinstated credits were originally applied. Only present if `type` is `credits_application_invoice_voided`.' + ).optional(), + /**The type of credit transaction.*/ type: z .enum(['credits_application_invoice_voided', 'credits_granted']) .describe('The type of credit transaction.') @@ -38779,13 +36706,13 @@ export namespace stripe { export const BillingCreditGrantsResourceBalanceCreditsApplicationInvoiceVoidedSchema = z.object({ - /** The invoice to which the reinstated billing credits were originally applied. */ + /**The invoice to which the reinstated billing credits were originally applied.*/ invoice: z .union([z.string().max(5000), InvoiceSchema]) .describe( 'The invoice to which the reinstated billing credits were originally applied.' ), - /** The invoice line item to which the reinstated billing credits were originally applied. */ + /**The invoice line item to which the reinstated billing credits were originally applied.*/ invoice_line_item: z .string() .max(5000) @@ -38808,95 +36735,89 @@ export namespace stripe { amount: BillingCreditGrantsResourceAmountSchema, applicability_config: BillingCreditGrantsResourceApplicabilityConfigSchema, - /** The category of this credit grant. This is for tracking purposes and isn't displayed to the customer. */ + /**The category of this credit grant. This is for tracking purposes and isn't displayed to the customer.*/ category: z .enum(['paid', 'promotional']) .describe( "The category of this credit grant. This is for tracking purposes and isn't displayed to the customer." ), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** ID of the customer receiving the billing credits. */ + /**ID of the customer receiving the billing credits.*/ customer: z .union([z.string().max(5000), CustomerSchema, DeletedCustomerSchema]) .describe('ID of the customer receiving the billing credits.'), - /** The time when the billing credits become effective-when they're eligible for use. */ + /**The time when the billing credits become effective-when they're eligible for use.*/ effective_at: z .number() .int() - .nullable() .describe( "The time when the billing credits become effective-when they're eligible for use." ) .optional(), - /** The time when the billing credits expire. If not present, the billing credits don't expire. */ + /**The time when the billing credits expire. If not present, the billing credits don't expire.*/ expires_at: z .number() .int() - .nullable() .describe( "The time when the billing credits expire. If not present, the billing credits don't expire." ) .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ), - /** A descriptive name shown in dashboard. */ + /**A descriptive name shown in dashboard.*/ name: z .string() .max(5000) - .nullable() .describe('A descriptive name shown in dashboard.') .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('billing.credit_grant') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The priority for applying this credit grant. The highest priority is 0 and the lowest is 100. */ + /**The priority for applying this credit grant. The highest priority is 0 and the lowest is 100.*/ priority: z .number() .int() - .nullable() .describe( 'The priority for applying this credit grant. The highest priority is 0 and the lowest is 100.' ) .optional(), - /** ID of the test clock this credit grant belongs to. */ + /**ID of the test clock this credit grant belongs to.*/ test_clock: z .union([z.string().max(5000), TestHelpersTestClockSchema]) - .nullable() .describe('ID of the test clock this credit grant belongs to.') .optional(), - /** Time at which the object was last updated. Measured in seconds since the Unix epoch. */ + /**Time at which the object was last updated. Measured in seconds since the Unix epoch.*/ updated: z .number() .int() .describe( 'Time at which the object was last updated. Measured in seconds since the Unix epoch.' ), - /** The time when this credit grant was voided. If not present, the credit grant hasn't been voided. */ + /**The time when this credit grant was voided. If not present, the credit grant hasn't been voided.*/ voided_at: z .number() .int() - .nullable() .describe( "The time when this credit grant was voided. If not present, the credit grant hasn't been voided." ) @@ -38909,14 +36830,12 @@ export namespace stripe { export const BillingCreditGrantsResourceBalanceDebitSchema = z.object({ amount: BillingCreditGrantsResourceAmountSchema, - /** Details of how the billing credits were applied to an invoice. Only present if `type` is `credits_applied`. */ + /**Details of how the billing credits were applied to an invoice. Only present if `type` is `credits_applied`.*/ credits_applied: - BillingCreditGrantsResourceBalanceCreditsAppliedSchema.nullable() - .describe( - 'Details of how the billing credits were applied to an invoice. Only present if `type` is `credits_applied`.' - ) - .optional(), - /** The type of debit transaction. */ + BillingCreditGrantsResourceBalanceCreditsAppliedSchema.describe( + 'Details of how the billing credits were applied to an invoice. Only present if `type` is `credits_applied`.' + ).optional(), + /**The type of debit transaction.*/ type: z .enum(['credits_applied', 'credits_expired', 'credits_voided']) .describe('The type of debit transaction.') @@ -38927,11 +36846,11 @@ export namespace stripe { export const BillingCreditGrantsResourceBalanceCreditsAppliedSchema = z.object({ - /** The invoice to which the billing credits were applied. */ + /**The invoice to which the billing credits were applied.*/ invoice: z .union([z.string().max(5000), InvoiceSchema]) .describe('The invoice to which the billing credits were applied.'), - /** The invoice line item to which the billing credits were applied. */ + /**The invoice line item to which the billing credits were applied.*/ invoice_line_item: z .string() .max(5000) @@ -38949,145 +36868,134 @@ export namespace stripe { */ export const QuoteSchema = z .object({ - /** Total before any discounts or taxes are applied. */ + /**Total before any discounts or taxes are applied.*/ amount_subtotal: z .number() .int() .describe('Total before any discounts or taxes are applied.'), - /** Total after discounts and taxes are applied. */ + /**Total after discounts and taxes are applied.*/ amount_total: z .number() .int() .describe('Total after discounts and taxes are applied.'), - /** ID of the Connect Application that created the quote. */ + /**ID of the Connect Application that created the quote.*/ application: z .union([ z.string().max(5000), ApplicationSchema, DeletedApplicationSchema ]) - .nullable() .describe('ID of the Connect Application that created the quote.') .optional(), - /** The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Only applicable if there are no line items with recurring prices on the quote. */ + /**The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Only applicable if there are no line items with recurring prices on the quote.*/ application_fee_amount: z .number() .int() - .nullable() .describe( "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Only applicable if there are no line items with recurring prices on the quote." ) .optional(), - /** A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. Only applicable if there are line items with recurring prices on the quote. */ + /**A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. Only applicable if there are line items with recurring prices on the quote.*/ application_fee_percent: z .number() - .nullable() .describe( "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. Only applicable if there are line items with recurring prices on the quote." ) .optional(), automatic_tax: QuotesResourceAutomaticTaxSchema, - /** Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or on finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`. */ + /**Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or on finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.*/ collection_method: z .enum(['charge_automatically', 'send_invoice']) .describe( 'Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or on finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.' ), computed: QuotesResourceComputedSchema, - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .max(5000) - .nullable() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ) .optional(), - /** The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. */ + /**The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.*/ customer: z .union([z.string().max(5000), CustomerSchema, DeletedCustomerSchema]) - .nullable() .describe( 'The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.' ) .optional(), - /** The tax rates applied to this quote. */ + /**The tax rates applied to this quote.*/ default_tax_rates: z .array(z.union([z.string().max(5000), TaxRateSchema])) .describe('The tax rates applied to this quote.') .optional(), - /** A description that will be displayed on the quote PDF. */ + /**A description that will be displayed on the quote PDF.*/ description: z .string() .max(5000) - .nullable() .describe('A description that will be displayed on the quote PDF.') .optional(), - /** The discounts applied to this quote. */ + /**The discounts applied to this quote.*/ discounts: z .array(z.union([z.string().max(5000), DiscountSchema])) .describe('The discounts applied to this quote.'), - /** The date on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch. */ + /**The date on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch.*/ expires_at: z .number() .int() .describe( 'The date on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch.' ), - /** A footer that will be displayed on the quote PDF. */ + /**A footer that will be displayed on the quote PDF.*/ footer: z .string() .max(5000) - .nullable() .describe('A footer that will be displayed on the quote PDF.') .optional(), - /** Details of the quote that was cloned. See the [cloning documentation](https://stripe.com/docs/quotes/clone) for more details. */ - from_quote: QuotesResourceFromQuoteSchema.nullable() - .describe( - 'Details of the quote that was cloned. See the [cloning documentation](https://stripe.com/docs/quotes/clone) for more details.' - ) - .optional(), - /** A header that will be displayed on the quote PDF. */ + /**Details of the quote that was cloned. See the [cloning documentation](https://stripe.com/docs/quotes/clone) for more details.*/ + from_quote: QuotesResourceFromQuoteSchema.describe( + 'Details of the quote that was cloned. See the [cloning documentation](https://stripe.com/docs/quotes/clone) for more details.' + ).optional(), + /**A header that will be displayed on the quote PDF.*/ header: z .string() .max(5000) - .nullable() .describe('A header that will be displayed on the quote PDF.') .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** The invoice that was created from this quote. */ + /**The invoice that was created from this quote.*/ invoice: z .union([z.string().max(5000), InvoiceSchema, DeletedInvoiceSchema]) - .nullable() .describe('The invoice that was created from this quote.') .optional(), invoice_settings: InvoiceSettingQuoteSettingSchema, - /** A list of items the customer is being quoted for. */ + /**A list of items the customer is being quoted for.*/ line_items: z .object({ - /** Details about each object. */ + /**Details about each object.*/ data: z.array(ItemSchema).describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -39095,76 +37003,69 @@ export namespace stripe { }) .describe('A list of items the customer is being quoted for.') .optional(), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ), - /** A unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://stripe.com/docs/quotes/overview#finalize). */ + /**A unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://stripe.com/docs/quotes/overview#finalize).*/ number: z .string() .max(5000) - .nullable() .describe( 'A unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://stripe.com/docs/quotes/overview#finalize).' ) .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('quote') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details. */ + /**The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details.*/ on_behalf_of: z .union([z.string().max(5000), AccountSchema]) - .nullable() .describe( 'The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details.' ) .optional(), - /** The status of the quote. */ + /**The status of the quote.*/ status: z .enum(['accepted', 'canceled', 'draft', 'open']) .describe('The status of the quote.'), status_transitions: QuotesResourceStatusTransitionsSchema, - /** The subscription that was created or updated from this quote. */ + /**The subscription that was created or updated from this quote.*/ subscription: z .union([z.string().max(5000), SubscriptionSchema]) - .nullable() .describe( 'The subscription that was created or updated from this quote.' ) .optional(), subscription_data: QuotesResourceSubscriptionDataSubscriptionDataSchema, - /** The subscription schedule that was created or updated from this quote. */ + /**The subscription schedule that was created or updated from this quote.*/ subscription_schedule: z .union([z.string().max(5000), SubscriptionScheduleSchema]) - .nullable() .describe( 'The subscription schedule that was created or updated from this quote.' ) .optional(), - /** ID of the test clock this quote belongs to. */ + /**ID of the test clock this quote belongs to.*/ test_clock: z .union([z.string().max(5000), TestHelpersTestClockSchema]) - .nullable() .describe('ID of the test clock this quote belongs to.') .optional(), total_details: QuotesResourceTotalDetailsSchema, - /** The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices. */ - transfer_data: QuotesResourceTransferDataSchema.nullable() - .describe( - 'The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices.' - ) - .optional() + /**The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices.*/ + transfer_data: QuotesResourceTransferDataSchema.describe( + 'The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices.' + ).optional() }) .describe( "A Quote is a way to model prices that you'd like to provide to a customer.\nOnce accepted, it will automatically create an invoice, subscription or subscription schedule." @@ -39172,18 +37073,15 @@ export namespace stripe { export type Quote = z.infer export const QuotesResourceAutomaticTaxSchema = z.object({ - /** Automatically calculate taxes */ + /**Automatically calculate taxes*/ enabled: z.boolean().describe('Automatically calculate taxes'), - /** The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. */ - liability: ConnectAccountReferenceSchema.nullable() - .describe( - "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account." - ) - .optional(), - /** The status of the most recent automated tax calculation for this quote. */ + /**The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.*/ + liability: ConnectAccountReferenceSchema.describe( + "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account." + ).optional(), + /**The status of the most recent automated tax calculation for this quote.*/ status: z .enum(['complete', 'failed', 'requires_location_inputs']) - .nullable() .describe( 'The status of the most recent automated tax calculation for this quote.' ) @@ -39194,12 +37092,10 @@ export namespace stripe { > export const QuotesResourceComputedSchema = z.object({ - /** The definitive totals and line items the customer will be charged on a recurring basis. Takes into account the line items with recurring prices and discounts with `duration=forever` coupons only. Defaults to `null` if no inputted line items with recurring prices. */ - recurring: QuotesResourceRecurringSchema.nullable() - .describe( - 'The definitive totals and line items the customer will be charged on a recurring basis. Takes into account the line items with recurring prices and discounts with `duration=forever` coupons only. Defaults to `null` if no inputted line items with recurring prices.' - ) - .optional(), + /**The definitive totals and line items the customer will be charged on a recurring basis. Takes into account the line items with recurring prices and discounts with `duration=forever` coupons only. Defaults to `null` if no inputted line items with recurring prices.*/ + recurring: QuotesResourceRecurringSchema.describe( + 'The definitive totals and line items the customer will be charged on a recurring basis. Takes into account the line items with recurring prices and discounts with `duration=forever` coupons only. Defaults to `null` if no inputted line items with recurring prices.' + ).optional(), upfront: QuotesResourceUpfrontSchema }) export type QuotesResourceComputed = z.infer< @@ -39207,23 +37103,23 @@ export namespace stripe { > export const QuotesResourceRecurringSchema = z.object({ - /** Total before any discounts or taxes are applied. */ + /**Total before any discounts or taxes are applied.*/ amount_subtotal: z .number() .int() .describe('Total before any discounts or taxes are applied.'), - /** Total after discounts and taxes are applied. */ + /**Total after discounts and taxes are applied.*/ amount_total: z .number() .int() .describe('Total after discounts and taxes are applied.'), - /** The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`. */ + /**The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.*/ interval: z .enum(['day', 'month', 'week', 'year']) .describe( 'The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.' ), - /** The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. */ + /**The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.*/ interval_count: z .number() .int() @@ -39237,19 +37133,18 @@ export namespace stripe { > export const QuotesResourceTotalDetailsSchema = z.object({ - /** This is the sum of all the discounts. */ + /**This is the sum of all the discounts.*/ amount_discount: z .number() .int() .describe('This is the sum of all the discounts.'), - /** This is the sum of all the shipping amounts. */ + /**This is the sum of all the shipping amounts.*/ amount_shipping: z .number() .int() - .nullable() .describe('This is the sum of all the shipping amounts.') .optional(), - /** This is the sum of all the tax amounts. */ + /**This is the sum of all the tax amounts.*/ amount_tax: z .number() .int() @@ -39261,11 +37156,11 @@ export namespace stripe { > export const QuotesResourceTotalDetailsResourceBreakdownSchema = z.object({ - /** The aggregated discounts. */ + /**The aggregated discounts.*/ discounts: z .array(LineItemsDiscountAmountSchema) .describe('The aggregated discounts.'), - /** The aggregated tax amounts by rate. */ + /**The aggregated tax amounts by rate.*/ taxes: z .array(LineItemsTaxAmountSchema) .describe('The aggregated tax amounts by rate.') @@ -39275,7 +37170,7 @@ export namespace stripe { > export const LineItemsDiscountAmountSchema = z.object({ - /** The amount discounted. */ + /**The amount discounted.*/ amount: z.number().int().describe('The amount discounted.'), discount: DiscountSchema }) @@ -39284,34 +37179,34 @@ export namespace stripe { > export const QuotesResourceUpfrontSchema = z.object({ - /** Total before any discounts or taxes are applied. */ + /**Total before any discounts or taxes are applied.*/ amount_subtotal: z .number() .int() .describe('Total before any discounts or taxes are applied.'), - /** Total after discounts and taxes are applied. */ + /**Total after discounts and taxes are applied.*/ amount_total: z .number() .int() .describe('Total after discounts and taxes are applied.'), - /** The line items that will appear on the next invoice after this quote is accepted. This does not include pending invoice items that exist on the customer but may still be included in the next invoice. */ + /**The line items that will appear on the next invoice after this quote is accepted. This does not include pending invoice items that exist on the customer but may still be included in the next invoice.*/ line_items: z .object({ - /** Details about each object. */ + /**Details about each object.*/ data: z.array(ItemSchema).describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -39327,73 +37222,71 @@ export namespace stripe { typeof QuotesResourceUpfrontSchema > - /** A line item. */ + /**A line item.*/ export const ItemSchema = z .object({ - /** Total discount amount applied. If no discounts were applied, defaults to 0. */ + /**Total discount amount applied. If no discounts were applied, defaults to 0.*/ amount_discount: z .number() .int() .describe( 'Total discount amount applied. If no discounts were applied, defaults to 0.' ), - /** Total before any discounts or taxes are applied. */ + /**Total before any discounts or taxes are applied.*/ amount_subtotal: z .number() .int() .describe('Total before any discounts or taxes are applied.'), - /** Total tax amount applied. If no tax was applied, defaults to 0. */ + /**Total tax amount applied. If no tax was applied, defaults to 0.*/ amount_tax: z .number() .int() .describe( 'Total tax amount applied. If no tax was applied, defaults to 0.' ), - /** Total after discounts and taxes. */ + /**Total after discounts and taxes.*/ amount_total: z .number() .int() .describe('Total after discounts and taxes.'), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name. */ + /**An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name.*/ description: z .string() .max(5000) - .nullable() .describe( 'An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name.' ) .optional(), - /** The discounts applied to the line item. */ + /**The discounts applied to the line item.*/ discounts: z .array(LineItemsDiscountAmountSchema) .describe('The discounts applied to the line item.') .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('item') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The price used to generate the line item. */ - price: PriceSchema.nullable() - .describe('The price used to generate the line item.') - .optional(), - /** The quantity of products being purchased. */ + /**The price used to generate the line item.*/ + price: PriceSchema.describe( + 'The price used to generate the line item.' + ).optional(), + /**The quantity of products being purchased.*/ quantity: z .number() .int() - .nullable() .describe('The quantity of products being purchased.') .optional(), - /** The taxes applied to the line item. */ + /**The taxes applied to the line item.*/ taxes: z .array(LineItemsTaxAmountSchema) .describe('The taxes applied to the line item.') @@ -39403,11 +37296,11 @@ export namespace stripe { export type Item = z.infer export const QuotesResourceFromQuoteSchema = z.object({ - /** Whether this quote is a revision of a different quote. */ + /**Whether this quote is a revision of a different quote.*/ is_revision: z .boolean() .describe('Whether this quote is a revision of a different quote.'), - /** The quote that was cloned. */ + /**The quote that was cloned.*/ quote: z .union([z.string().max(5000), QuoteSchema]) .describe('The quote that was cloned.') @@ -39417,11 +37310,10 @@ export namespace stripe { > export const InvoiceSettingQuoteSettingSchema = z.object({ - /** Number of days within which a customer must pay invoices generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`. */ + /**Number of days within which a customer must pay invoices generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`.*/ days_until_due: z .number() .int() - .nullable() .describe( 'Number of days within which a customer must pay invoices generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`.' ) @@ -39433,24 +37325,22 @@ export namespace stripe { > export const QuotesResourceTransferDataSchema = z.object({ - /** The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination. */ + /**The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination.*/ amount: z .number() .int() - .nullable() .describe( 'The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination.' ) .optional(), - /** A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount will be transferred to the destination. */ + /**A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount will be transferred to the destination.*/ amount_percent: z .number() - .nullable() .describe( 'A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount will be transferred to the destination.' ) .optional(), - /** The account where funds from the payment will be transferred to upon payment success. */ + /**The account where funds from the payment will be transferred to upon payment success.*/ destination: z .union([z.string().max(5000), AccountSchema]) .describe( @@ -39462,16 +37352,15 @@ export namespace stripe { > export const InvoiceTransferDataSchema = z.object({ - /** The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination. */ + /**The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination.*/ amount: z .number() .int() - .nullable() .describe( 'The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination.' ) .optional(), - /** The account where funds from the payment will be transferred to upon payment success. */ + /**The account where funds from the payment will be transferred to upon payment success.*/ destination: z .union([z.string().max(5000), AccountSchema]) .describe( @@ -39493,7 +37382,7 @@ export namespace stripe { 'The amount transferred to the destination account. This transfer will occur automatically after the payment succeeds. If no amount is specified, by default the entire payment amount is transferred to the destination account.\n The amount must be less than or equal to the [amount](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-amount), and must be a positive integer\n representing how much to transfer in the smallest currency unit (e.g., 100 cents to charge $1.00).' ) .optional(), - /** The account (if any) that the payment is attributed to for tax reporting, and where funds from the payment are transferred to after payment success. */ + /**The account (if any) that the payment is attributed to for tax reporting, and where funds from the payment are transferred to after payment success.*/ destination: z .union([z.string().max(5000), AccountSchema]) .describe( @@ -39503,49 +37392,42 @@ export namespace stripe { export type TransferData = z.infer export const PaymentMethodSepaDebitSchema = z.object({ - /** Bank code of bank associated with the bank account. */ + /**Bank code of bank associated with the bank account.*/ bank_code: z .string() .max(5000) - .nullable() .describe('Bank code of bank associated with the bank account.') .optional(), - /** Branch code of bank associated with the bank account. */ + /**Branch code of bank associated with the bank account.*/ branch_code: z .string() .max(5000) - .nullable() .describe('Branch code of bank associated with the bank account.') .optional(), - /** Two-letter ISO code representing the country the bank account is located in. */ + /**Two-letter ISO code representing the country the bank account is located in.*/ country: z .string() .max(5000) - .nullable() .describe( 'Two-letter ISO code representing the country the bank account is located in.' ) .optional(), - /** Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /**Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.*/ fingerprint: z .string() .max(5000) - .nullable() .describe( 'Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.' ) .optional(), - /** Information about the object that generated this PaymentMethod. */ - generated_from: SepaDebitGeneratedFromSchema.nullable() - .describe( - 'Information about the object that generated this PaymentMethod.' - ) - .optional(), - /** Last four characters of the IBAN. */ + /**Information about the object that generated this PaymentMethod.*/ + generated_from: SepaDebitGeneratedFromSchema.describe( + 'Information about the object that generated this PaymentMethod.' + ).optional(), + /**Last four characters of the IBAN.*/ last4: z .string() .max(5000) - .nullable() .describe('Last four characters of the IBAN.') .optional() }) @@ -39554,18 +37436,16 @@ export namespace stripe { > export const SepaDebitGeneratedFromSchema = z.object({ - /** The ID of the Charge that generated this PaymentMethod, if any. */ + /**The ID of the Charge that generated this PaymentMethod, if any.*/ charge: z .union([z.string().max(5000), ChargeSchema]) - .nullable() .describe( 'The ID of the Charge that generated this PaymentMethod, if any.' ) .optional(), - /** The ID of the SetupAttempt that generated this PaymentMethod, if any. */ + /**The ID of the SetupAttempt that generated this PaymentMethod, if any.*/ setup_attempt: z .union([z.string().max(5000), SetupAttemptSchema]) - .nullable() .describe( 'The ID of the SetupAttempt that generated this PaymentMethod, if any.' ) @@ -39590,10 +37470,9 @@ export namespace stripe { export type AccountSettings = z.infer export const AccountInvoicesSettingsSchema = z.object({ - /** The list of default Account Tax IDs to automatically include on invoices. Account Tax IDs get added when an invoice is finalized. */ + /**The list of default Account Tax IDs to automatically include on invoices. Account Tax IDs get added when an invoice is finalized.*/ default_account_tax_ids: z .array(z.union([z.string().max(5000), TaxIdSchema])) - .nullable() .describe( 'The list of default Account Tax IDs to automatically include on invoices. Account Tax IDs get added when an invoice is finalized.' ) @@ -39607,10 +37486,9 @@ export namespace stripe { export type ExternalAccount = z.infer export const ThresholdsResourceUsageAlertFilterSchema = z.object({ - /** Limit the scope of the alert to this customer ID */ + /**Limit the scope of the alert to this customer ID*/ customer: z .union([z.string().max(5000), CustomerSchema]) - .nullable() .describe('Limit the scope of the alert to this customer ID') .optional(), type: z.literal('customer') @@ -39620,20 +37498,17 @@ export namespace stripe { > export const PaymentPagesCheckoutSessionAutomaticTaxSchema = z.object({ - /** Indicates whether automatic tax is enabled for the session */ + /**Indicates whether automatic tax is enabled for the session*/ enabled: z .boolean() .describe('Indicates whether automatic tax is enabled for the session'), - /** The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. */ - liability: ConnectAccountReferenceSchema.nullable() - .describe( - "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account." - ) - .optional(), - /** The status of the most recent automated tax calculation for this session. */ + /**The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.*/ + liability: ConnectAccountReferenceSchema.describe( + "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account." + ).optional(), + /**The status of the most recent automated tax calculation for this session.*/ status: z .enum(['complete', 'failed', 'requires_location_inputs']) - .nullable() .describe( 'The status of the most recent automated tax calculation for this session.' ) @@ -39644,16 +37519,14 @@ export namespace stripe { > export const PaymentPagesCheckoutSessionDiscountSchema = z.object({ - /** Coupon attached to the Checkout Session. */ + /**Coupon attached to the Checkout Session.*/ coupon: z .union([z.string().max(5000), CouponSchema]) - .nullable() .describe('Coupon attached to the Checkout Session.') .optional(), - /** Promotion code attached to the Checkout Session. */ + /**Promotion code attached to the Checkout Session.*/ promotion_code: z .union([z.string().max(5000), PromotionCodeSchema]) - .nullable() .describe('Promotion code attached to the Checkout Session.') .optional() }) @@ -39662,18 +37535,16 @@ export namespace stripe { > export const PaymentLinksResourceAutomaticTaxSchema = z.object({ - /** If `true`, tax will be calculated automatically using the customer's location. */ + /**If `true`, tax will be calculated automatically using the customer's location.*/ enabled: z .boolean() .describe( "If `true`, tax will be calculated automatically using the customer's location." ), - /** The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. */ - liability: ConnectAccountReferenceSchema.nullable() - .describe( - "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account." - ) - .optional() + /**The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.*/ + liability: ConnectAccountReferenceSchema.describe( + "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account." + ).optional() }) export type PaymentLinksResourceAutomaticTax = z.infer< typeof PaymentLinksResourceAutomaticTaxSchema @@ -39686,16 +37557,15 @@ export namespace stripe { > export const PaymentLinksResourceTransferDataSchema = z.object({ - /** The amount in cents (or local equivalent) that will be transferred to the destination account. By default, the entire amount is transferred to the destination. */ + /**The amount in cents (or local equivalent) that will be transferred to the destination account. By default, the entire amount is transferred to the destination.*/ amount: z .number() .int() - .nullable() .describe( 'The amount in cents (or local equivalent) that will be transferred to the destination account. By default, the entire amount is transferred to the destination.' ) .optional(), - /** The connected account receiving the transfer. */ + /**The connected account receiving the transfer.*/ destination: z .union([z.string().max(5000), AccountSchema]) .describe('The connected account receiving the transfer.') @@ -39706,11 +37576,11 @@ export namespace stripe { export const PaymentPagesCheckoutSessionTotalDetailsResourceBreakdownSchema = z.object({ - /** The aggregated discounts. */ + /**The aggregated discounts.*/ discounts: z .array(LineItemsDiscountAmountSchema) .describe('The aggregated discounts.'), - /** The aggregated tax amounts by rate. */ + /**The aggregated tax amounts by rate.*/ taxes: z .array(LineItemsTaxAmountSchema) .describe('The aggregated tax amounts by rate.') @@ -39720,14 +37590,14 @@ export namespace stripe { typeof PaymentPagesCheckoutSessionTotalDetailsResourceBreakdownSchema > - /** Details of the PaymentMethod collected by Payment Element */ + /**Details of the PaymentMethod collected by Payment Element*/ export const ConfirmationTokensResourcePaymentMethodPreviewSchema = z .object({ acss_debit: PaymentMethodAcssDebitSchema.optional(), affirm: PaymentMethodAffirmSchema.optional(), afterpay_clearpay: PaymentMethodAfterpayClearpaySchema.optional(), alipay: PaymentFlowsPrivatePaymentMethodsAlipaySchema.optional(), - /** This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”. */ + /**This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.*/ allow_redisplay: z .enum(['always', 'limited', 'unspecified']) .describe( @@ -39745,10 +37615,9 @@ export namespace stripe { card: PaymentMethodCardSchema.optional(), card_present: PaymentMethodCardPresentSchema.optional(), cashapp: PaymentMethodCashappSchema.optional(), - /** The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer. */ + /**The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.*/ customer: z .union([z.string().max(5000), CustomerSchema]) - .nullable() .describe( 'The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.' ) @@ -39782,7 +37651,7 @@ export namespace stripe { sofort: PaymentMethodSofortSchema.optional(), swish: PaymentMethodSwishSchema.optional(), twint: PaymentMethodTwintSchema.optional(), - /** The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type. */ + /**The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.*/ type: z .enum([ 'acss_debit', @@ -39845,28 +37714,28 @@ export namespace stripe { > export const CreditNotesPretaxCreditAmountSchema = z.object({ - /** The amount, in cents (or local equivalent), of the pretax credit amount. */ + /**The amount, in cents (or local equivalent), of the pretax credit amount.*/ amount: z .number() .int() .describe( 'The amount, in cents (or local equivalent), of the pretax credit amount.' ), - /** The credit balance transaction that was applied to get this pretax credit amount. */ + /**The credit balance transaction that was applied to get this pretax credit amount.*/ credit_balance_transaction: z .union([z.string().max(5000), BillingCreditBalanceTransactionSchema]) .describe( 'The credit balance transaction that was applied to get this pretax credit amount.' ) .optional(), - /** The discount that was applied to get this pretax credit amount. */ + /**The discount that was applied to get this pretax credit amount.*/ discount: z .union([z.string().max(5000), DiscountSchema, DeletedDiscountSchema]) .describe( 'The discount that was applied to get this pretax credit amount.' ) .optional(), - /** Type of the pretax credit amount referenced. */ + /**Type of the pretax credit amount referenced.*/ type: z .enum(['credit_balance_transaction', 'discount']) .describe('Type of the pretax credit amount referenced.') @@ -39884,21 +37753,21 @@ export namespace stripe { export type PaymentSource = z.infer export const BankConnectionsResourceAccountholderSchema = z.object({ - /** The ID of the Stripe account this account belongs to. Should only be present if `account_holder.type` is `account`. */ + /**The ID of the Stripe account this account belongs to. Should only be present if `account_holder.type` is `account`.*/ account: z .union([z.string().max(5000), AccountSchema]) .describe( 'The ID of the Stripe account this account belongs to. Should only be present if `account_holder.type` is `account`.' ) .optional(), - /** ID of the Stripe customer this account belongs to. Present if and only if `account_holder.type` is `customer`. */ + /**ID of the Stripe customer this account belongs to. Present if and only if `account_holder.type` is `customer`.*/ customer: z .union([z.string().max(5000), CustomerSchema]) .describe( 'ID of the Stripe customer this account belongs to. Present if and only if `account_holder.type` is `customer`.' ) .optional(), - /** Type of account holder that this account belongs to. */ + /**Type of account holder that this account belongs to.*/ type: z .enum(['account', 'customer']) .describe('Type of account holder that this account belongs to.') @@ -39915,47 +37784,47 @@ export namespace stripe { */ export const RadarEarlyFraudWarningSchema = z .object({ - /** An EFW is actionable if it has not received a dispute and has not been fully refunded. You may wish to proactively refund a charge that receives an EFW, in order to avoid receiving a dispute later. */ + /**An EFW is actionable if it has not received a dispute and has not been fully refunded. You may wish to proactively refund a charge that receives an EFW, in order to avoid receiving a dispute later.*/ actionable: z .boolean() .describe( 'An EFW is actionable if it has not received a dispute and has not been fully refunded. You may wish to proactively refund a charge that receives an EFW, in order to avoid receiving a dispute later.' ), - /** ID of the charge this early fraud warning is for, optionally expanded. */ + /**ID of the charge this early fraud warning is for, optionally expanded.*/ charge: z .union([z.string().max(5000), ChargeSchema]) .describe( 'ID of the charge this early fraud warning is for, optionally expanded.' ), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** The type of fraud labelled by the issuer. One of `card_never_received`, `fraudulent_card_application`, `made_with_counterfeit_card`, `made_with_lost_card`, `made_with_stolen_card`, `misc`, `unauthorized_use_of_card`. */ + /**The type of fraud labelled by the issuer. One of `card_never_received`, `fraudulent_card_application`, `made_with_counterfeit_card`, `made_with_lost_card`, `made_with_stolen_card`, `misc`, `unauthorized_use_of_card`.*/ fraud_type: z .string() .max(5000) .describe( 'The type of fraud labelled by the issuer. One of `card_never_received`, `fraudulent_card_application`, `made_with_counterfeit_card`, `made_with_lost_card`, `made_with_stolen_card`, `misc`, `unauthorized_use_of_card`.' ), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('radar.early_fraud_warning') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** ID of the Payment Intent this early fraud warning is for, optionally expanded. */ + /**ID of the Payment Intent this early fraud warning is for, optionally expanded.*/ payment_intent: z .union([z.string().max(5000), PaymentIntentSchema]) .describe( @@ -39972,59 +37841,53 @@ export namespace stripe { export const InboundTransfersPaymentMethodDetailsUsBankAccountSchema = z.object({ - /** Account holder type: individual or company. */ + /**Account holder type: individual or company.*/ account_holder_type: z .enum(['company', 'individual']) - .nullable() .describe('Account holder type: individual or company.') .optional(), - /** Account type: checkings or savings. Defaults to checking if omitted. */ + /**Account type: checkings or savings. Defaults to checking if omitted.*/ account_type: z .enum(['checking', 'savings']) - .nullable() .describe( 'Account type: checkings or savings. Defaults to checking if omitted.' ) .optional(), - /** Name of the bank associated with the bank account. */ + /**Name of the bank associated with the bank account.*/ bank_name: z .string() .max(5000) - .nullable() .describe('Name of the bank associated with the bank account.') .optional(), - /** Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /**Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.*/ fingerprint: z .string() .max(5000) - .nullable() .describe( 'Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.' ) .optional(), - /** Last four digits of the bank account number. */ + /**Last four digits of the bank account number.*/ last4: z .string() .max(5000) - .nullable() .describe('Last four digits of the bank account number.') .optional(), - /** ID of the mandate used to make this payment. */ + /**ID of the mandate used to make this payment.*/ mandate: z .union([z.string().max(5000), MandateSchema]) .describe('ID of the mandate used to make this payment.') .optional(), - /** The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. */ + /**The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.*/ network: z .literal('ach') .describe( 'The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.' ), - /** Routing number of the bank account. */ + /**Routing number of the bank account.*/ routing_number: z .string() .max(5000) - .nullable() .describe('Routing number of the bank account.') .optional() }) @@ -40034,59 +37897,53 @@ export namespace stripe { export const OutboundPaymentsPaymentMethodDetailsUsBankAccountSchema = z.object({ - /** Account holder type: individual or company. */ + /**Account holder type: individual or company.*/ account_holder_type: z .enum(['company', 'individual']) - .nullable() .describe('Account holder type: individual or company.') .optional(), - /** Account type: checkings or savings. Defaults to checking if omitted. */ + /**Account type: checkings or savings. Defaults to checking if omitted.*/ account_type: z .enum(['checking', 'savings']) - .nullable() .describe( 'Account type: checkings or savings. Defaults to checking if omitted.' ) .optional(), - /** Name of the bank associated with the bank account. */ + /**Name of the bank associated with the bank account.*/ bank_name: z .string() .max(5000) - .nullable() .describe('Name of the bank associated with the bank account.') .optional(), - /** Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /**Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.*/ fingerprint: z .string() .max(5000) - .nullable() .describe( 'Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.' ) .optional(), - /** Last four digits of the bank account number. */ + /**Last four digits of the bank account number.*/ last4: z .string() .max(5000) - .nullable() .describe('Last four digits of the bank account number.') .optional(), - /** ID of the mandate used to make this payment. */ + /**ID of the mandate used to make this payment.*/ mandate: z .union([z.string().max(5000), MandateSchema]) .describe('ID of the mandate used to make this payment.') .optional(), - /** The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. */ + /**The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.*/ network: z .enum(['ach', 'us_domestic_wire']) .describe( 'The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.' ), - /** Routing number of the bank account. */ + /**Routing number of the bank account.*/ routing_number: z .string() .max(5000) - .nullable() .describe('Routing number of the bank account.') .optional() }) @@ -40096,59 +37953,53 @@ export namespace stripe { export const OutboundTransfersPaymentMethodDetailsUsBankAccountSchema = z.object({ - /** Account holder type: individual or company. */ + /**Account holder type: individual or company.*/ account_holder_type: z .enum(['company', 'individual']) - .nullable() .describe('Account holder type: individual or company.') .optional(), - /** Account type: checkings or savings. Defaults to checking if omitted. */ + /**Account type: checkings or savings. Defaults to checking if omitted.*/ account_type: z .enum(['checking', 'savings']) - .nullable() .describe( 'Account type: checkings or savings. Defaults to checking if omitted.' ) .optional(), - /** Name of the bank associated with the bank account. */ + /**Name of the bank associated with the bank account.*/ bank_name: z .string() .max(5000) - .nullable() .describe('Name of the bank associated with the bank account.') .optional(), - /** Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + /**Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.*/ fingerprint: z .string() .max(5000) - .nullable() .describe( 'Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.' ) .optional(), - /** Last four digits of the bank account number. */ + /**Last four digits of the bank account number.*/ last4: z .string() .max(5000) - .nullable() .describe('Last four digits of the bank account number.') .optional(), - /** ID of the mandate used to make this payment. */ + /**ID of the mandate used to make this payment.*/ mandate: z .union([z.string().max(5000), MandateSchema]) .describe('ID of the mandate used to make this payment.') .optional(), - /** The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. */ + /**The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.*/ network: z .enum(['ach', 'us_domestic_wire']) .describe( 'The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.' ), - /** Routing number of the bank account. */ + /**Routing number of the bank account.*/ routing_number: z .string() .max(5000) - .nullable() .describe('Routing number of the bank account.') .optional() }) @@ -40182,42 +38033,41 @@ export namespace stripe { .object({ bank_account: BankAccountSchema.optional(), card: CardSchema.optional(), - /** IP address of the client that generates the token. */ + /**IP address of the client that generates the token.*/ client_ip: z .string() .max(5000) - .nullable() .describe('IP address of the client that generates the token.') .optional(), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('token') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** Type of the token: `account`, `bank_account`, `card`, or `pii`. */ + /**Type of the token: `account`, `bank_account`, `card`, or `pii`.*/ type: z .string() .max(5000) .describe( 'Type of the token: `account`, `bank_account`, `card`, or `pii`.' ), - /** Determines if you have already used this token (you can only use tokens once). */ + /**Determines if you have already used this token (you can only use tokens once).*/ used: z .boolean() .describe( @@ -40229,26 +38079,26 @@ export namespace stripe { ) export type Token = z.infer - /** Indicates the billing credit balance for billing credits granted to a customer. */ + /**Indicates the billing credit balance for billing credits granted to a customer.*/ export const BillingCreditBalanceSummarySchema = z .object({ - /** The billing credit balances. One entry per credit grant currency. If a customer only has credit grants in a single currency, then this will have a single balance entry. */ + /**The billing credit balances. One entry per credit grant currency. If a customer only has credit grants in a single currency, then this will have a single balance entry.*/ balances: z .array(CreditBalanceSchema) .describe( 'The billing credit balances. One entry per credit grant currency. If a customer only has credit grants in a single currency, then this will have a single balance entry.' ), - /** The customer the balance is for. */ + /**The customer the balance is for.*/ customer: z .union([z.string().max(5000), CustomerSchema, DeletedCustomerSchema]) .describe('The customer the balance is for.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('billing.credit_balance_summary') .describe( @@ -40263,160 +38113,143 @@ export namespace stripe { > export const PaymentPagesCheckoutSessionInvoiceSettingsSchema = z.object({ - /** The account tax IDs associated with the invoice. */ + /**The account tax IDs associated with the invoice.*/ account_tax_ids: z .array(z.union([z.string().max(5000), TaxIdSchema, DeletedTaxIdSchema])) - .nullable() .describe('The account tax IDs associated with the invoice.') .optional(), - /** Custom fields displayed on the invoice. */ + /**Custom fields displayed on the invoice.*/ custom_fields: z .array(InvoiceSettingCustomFieldSchema) - .nullable() .describe('Custom fields displayed on the invoice.') .optional(), - /** An arbitrary string attached to the object. Often useful for displaying to users. */ + /**An arbitrary string attached to the object. Often useful for displaying to users.*/ description: z .string() .max(5000) - .nullable() .describe( 'An arbitrary string attached to the object. Often useful for displaying to users.' ) .optional(), - /** Footer displayed on the invoice. */ + /**Footer displayed on the invoice.*/ footer: z .string() .max(5000) - .nullable() .describe('Footer displayed on the invoice.') .optional(), - /** The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. */ - issuer: ConnectAccountReferenceSchema.nullable() - .describe( - 'The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.' - ) - .optional(), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.*/ + issuer: ConnectAccountReferenceSchema.describe( + 'The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.' + ).optional(), + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) - .nullable() .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ) .optional(), - /** Options for invoice PDF rendering. */ - rendering_options: InvoiceSettingCheckoutRenderingOptionsSchema.nullable() - .describe('Options for invoice PDF rendering.') - .optional() + /**Options for invoice PDF rendering.*/ + rendering_options: InvoiceSettingCheckoutRenderingOptionsSchema.describe( + 'Options for invoice PDF rendering.' + ).optional() }) export type PaymentPagesCheckoutSessionInvoiceSettings = z.infer< typeof PaymentPagesCheckoutSessionInvoiceSettingsSchema > export const PaymentLinksResourceInvoiceSettingsSchema = z.object({ - /** The account tax IDs associated with the invoice. */ + /**The account tax IDs associated with the invoice.*/ account_tax_ids: z .array(z.union([z.string().max(5000), TaxIdSchema, DeletedTaxIdSchema])) - .nullable() .describe('The account tax IDs associated with the invoice.') .optional(), - /** A list of up to 4 custom fields to be displayed on the invoice. */ + /**A list of up to 4 custom fields to be displayed on the invoice.*/ custom_fields: z .array(InvoiceSettingCustomFieldSchema) - .nullable() .describe( 'A list of up to 4 custom fields to be displayed on the invoice.' ) .optional(), - /** An arbitrary string attached to the object. Often useful for displaying to users. */ + /**An arbitrary string attached to the object. Often useful for displaying to users.*/ description: z .string() .max(5000) - .nullable() .describe( 'An arbitrary string attached to the object. Often useful for displaying to users.' ) .optional(), - /** Footer to be displayed on the invoice. */ + /**Footer to be displayed on the invoice.*/ footer: z .string() .max(5000) - .nullable() .describe('Footer to be displayed on the invoice.') .optional(), - /** The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. */ - issuer: ConnectAccountReferenceSchema.nullable() - .describe( - 'The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.' - ) - .optional(), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.*/ + issuer: ConnectAccountReferenceSchema.describe( + 'The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.' + ).optional(), + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) - .nullable() .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ) .optional(), - /** Options for invoice PDF rendering. */ - rendering_options: InvoiceSettingCheckoutRenderingOptionsSchema.nullable() - .describe('Options for invoice PDF rendering.') - .optional() + /**Options for invoice PDF rendering.*/ + rendering_options: InvoiceSettingCheckoutRenderingOptionsSchema.describe( + 'Options for invoice PDF rendering.' + ).optional() }) export type PaymentLinksResourceInvoiceSettings = z.infer< typeof PaymentLinksResourceInvoiceSettingsSchema > export const PaymentLinksResourceSubscriptionDataSchema = z.object({ - /** The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. */ + /**The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.*/ description: z .string() .max(5000) - .nullable() .describe( "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs." ) .optional(), invoice_settings: PaymentLinksResourceSubscriptionDataInvoiceSettingsSchema, - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link.' ), - /** Integer representing the number of trial period days before the customer is charged for the first time. */ + /**Integer representing the number of trial period days before the customer is charged for the first time.*/ trial_period_days: z .number() .int() - .nullable() .describe( 'Integer representing the number of trial period days before the customer is charged for the first time.' ) .optional(), - /** Settings related to subscription trials. */ - trial_settings: SubscriptionsTrialsResourceTrialSettingsSchema.nullable() - .describe('Settings related to subscription trials.') - .optional() + /**Settings related to subscription trials.*/ + trial_settings: SubscriptionsTrialsResourceTrialSettingsSchema.describe( + 'Settings related to subscription trials.' + ).optional() }) export type PaymentLinksResourceSubscriptionData = z.infer< typeof PaymentLinksResourceSubscriptionDataSchema > export const PaymentPagesCheckoutSessionTotalDetailsSchema = z.object({ - /** This is the sum of all the discounts. */ + /**This is the sum of all the discounts.*/ amount_discount: z .number() .int() .describe('This is the sum of all the discounts.'), - /** This is the sum of all the shipping amounts. */ + /**This is the sum of all the shipping amounts.*/ amount_shipping: z .number() .int() - .nullable() .describe('This is the sum of all the shipping amounts.') .optional(), - /** This is the sum of all the tax amounts. */ + /**This is the sum of all the tax amounts.*/ amount_tax: z .number() .int() @@ -40428,10 +38261,10 @@ export namespace stripe { typeof PaymentPagesCheckoutSessionTotalDetailsSchema > - /** Represents a reader action to process a setup intent */ + /**Represents a reader action to process a setup intent*/ export const TerminalReaderReaderResourceProcessSetupIntentActionSchema = z .object({ - /** ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod. */ + /**ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.*/ generated_card: z .string() .max(5000) @@ -40441,7 +38274,7 @@ export namespace stripe { .optional(), process_config: TerminalReaderReaderResourceProcessSetupConfigSchema.optional(), - /** Most recent SetupIntent processed by the reader. */ + /**Most recent SetupIntent processed by the reader.*/ setup_intent: z .union([z.string().max(5000), SetupIntentSchema]) .describe('Most recent SetupIntent processed by the reader.') @@ -40451,43 +38284,43 @@ export namespace stripe { typeof TerminalReaderReaderResourceProcessSetupIntentActionSchema > - /** Represents a reader action to refund a payment */ + /**Represents a reader action to refund a payment*/ export const TerminalReaderReaderResourceRefundPaymentActionSchema = z .object({ - /** The amount being refunded. */ + /**The amount being refunded.*/ amount: z .number() .int() .describe('The amount being refunded.') .optional(), - /** Charge that is being refunded. */ + /**Charge that is being refunded.*/ charge: z .union([z.string().max(5000), ChargeSchema]) .describe('Charge that is being refunded.') .optional(), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ) .optional(), - /** Payment intent that is being refunded. */ + /**Payment intent that is being refunded.*/ payment_intent: z .union([z.string().max(5000), PaymentIntentSchema]) .describe('Payment intent that is being refunded.') .optional(), - /** The reason for the refund. */ + /**The reason for the refund.*/ reason: z .enum(['duplicate', 'fraudulent', 'requested_by_customer']) .describe('The reason for the refund.') .optional(), - /** Unique identifier for the refund object. */ + /**Unique identifier for the refund object.*/ refund: z .union([z.string().max(5000), RefundSchema]) .describe('Unique identifier for the refund object.') .optional(), - /** Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge. */ + /**Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.*/ refund_application_fee: z .boolean() .describe( @@ -40496,7 +38329,7 @@ export namespace stripe { .optional(), refund_payment_config: TerminalReaderReaderResourceRefundPaymentConfigSchema.optional(), - /** Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). A transfer can be reversed only by the application that created the charge. */ + /**Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). A transfer can be reversed only by the application that created the charge.*/ reverse_transfer: z .boolean() .describe( @@ -40516,36 +38349,35 @@ export namespace stripe { */ export const CapabilitySchema = z .object({ - /** The account for which the capability enables functionality. */ + /**The account for which the capability enables functionality.*/ account: z .union([z.string().max(5000), AccountSchema]) .describe( 'The account for which the capability enables functionality.' ), future_requirements: AccountCapabilityFutureRequirementsSchema.optional(), - /** The identifier for the capability. */ + /**The identifier for the capability.*/ id: z.string().max(5000).describe('The identifier for the capability.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('capability') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** Whether the capability has been requested. */ + /**Whether the capability has been requested.*/ requested: z .boolean() .describe('Whether the capability has been requested.'), - /** Time at which the capability was requested. Measured in seconds since the Unix epoch. */ + /**Time at which the capability was requested. Measured in seconds since the Unix epoch.*/ requested_at: z .number() .int() - .nullable() .describe( 'Time at which the capability was requested. Measured in seconds since the Unix epoch.' ) .optional(), requirements: AccountCapabilityRequirementsSchema.optional(), - /** The status of the capability. */ + /**The status of the capability.*/ status: z .enum(['active', 'disabled', 'inactive', 'pending', 'unrequested']) .describe('The status of the capability.') @@ -40556,7 +38388,7 @@ export namespace stripe { export type Capability = z.infer export const PaymentPagesCheckoutSessionInvoiceCreationSchema = z.object({ - /** Indicates whether invoice creation is enabled for the Checkout Session. */ + /**Indicates whether invoice creation is enabled for the Checkout Session.*/ enabled: z .boolean() .describe( @@ -40569,128 +38401,120 @@ export namespace stripe { > export const PaymentLinksResourceInvoiceCreationSchema = z.object({ - /** Enable creating an invoice on successful payment. */ + /**Enable creating an invoice on successful payment.*/ enabled: z .boolean() .describe('Enable creating an invoice on successful payment.'), - /** Configuration for the invoice. Default invoice values will be used if unspecified. */ - invoice_data: PaymentLinksResourceInvoiceSettingsSchema.nullable() - .describe( - 'Configuration for the invoice. Default invoice values will be used if unspecified.' - ) - .optional() + /**Configuration for the invoice. Default invoice values will be used if unspecified.*/ + invoice_data: PaymentLinksResourceInvoiceSettingsSchema.describe( + 'Configuration for the invoice. Default invoice values will be used if unspecified.' + ).optional() }) export type PaymentLinksResourceInvoiceCreation = z.infer< typeof PaymentLinksResourceInvoiceCreationSchema > - /** The credit note line item object */ + /**The credit note line item object*/ export const CreditNoteLineItemSchema = z .object({ - /** The integer amount in cents (or local equivalent) representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts. */ + /**The integer amount in cents (or local equivalent) representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts.*/ amount: z .number() .int() .describe( 'The integer amount in cents (or local equivalent) representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts.' ), - /** The integer amount in cents (or local equivalent) representing the amount being credited for this line item, excluding all tax and discounts. */ + /**The integer amount in cents (or local equivalent) representing the amount being credited for this line item, excluding all tax and discounts.*/ amount_excluding_tax: z .number() .int() - .nullable() .describe( 'The integer amount in cents (or local equivalent) representing the amount being credited for this line item, excluding all tax and discounts.' ) .optional(), - /** Description of the item being credited. */ + /**Description of the item being credited.*/ description: z .string() .max(5000) - .nullable() .describe('Description of the item being credited.') .optional(), - /** The integer amount in cents (or local equivalent) representing the discount being credited for this line item. */ + /**The integer amount in cents (or local equivalent) representing the discount being credited for this line item.*/ discount_amount: z .number() .int() .describe( 'The integer amount in cents (or local equivalent) representing the discount being credited for this line item.' ), - /** The amount of discount calculated per discount for this line item */ + /**The amount of discount calculated per discount for this line item*/ discount_amounts: z .array(DiscountsResourceDiscountAmountSchema) .describe( 'The amount of discount calculated per discount for this line item' ), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** ID of the invoice line item being credited */ + /**ID of the invoice line item being credited*/ invoice_line_item: z .string() .max(5000) .describe('ID of the invoice line item being credited') .optional(), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('credit_note_line_item') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The pretax credit amounts (ex: discount, credit grants, etc) for this line item. */ + /**The pretax credit amounts (ex: discount, credit grants, etc) for this line item.*/ pretax_credit_amounts: z .array(CreditNotesPretaxCreditAmountSchema) .describe( 'The pretax credit amounts (ex: discount, credit grants, etc) for this line item.' ), - /** The number of units of product being credited. */ + /**The number of units of product being credited.*/ quantity: z .number() .int() - .nullable() .describe('The number of units of product being credited.') .optional(), - /** The amount of tax calculated per tax rate for this line item */ + /**The amount of tax calculated per tax rate for this line item*/ tax_amounts: z .array(CreditNoteTaxAmountSchema) .describe( 'The amount of tax calculated per tax rate for this line item' ), - /** The tax rates which apply to the line item. */ + /**The tax rates which apply to the line item.*/ tax_rates: z .array(TaxRateSchema) .describe('The tax rates which apply to the line item.'), - /** The type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. When the type is `invoice_line_item` there is an additional `invoice_line_item` property on the resource the value of which is the id of the credited line item on the invoice. */ + /**The type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. When the type is `invoice_line_item` there is an additional `invoice_line_item` property on the resource the value of which is the id of the credited line item on the invoice.*/ type: z .enum(['custom_line_item', 'invoice_line_item']) .describe( 'The type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. When the type is `invoice_line_item` there is an additional `invoice_line_item` property on the resource the value of which is the id of the credited line item on the invoice.' ), - /** The cost of each unit of product being credited. */ + /**The cost of each unit of product being credited.*/ unit_amount: z .number() .int() - .nullable() .describe('The cost of each unit of product being credited.') .optional(), - /** Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. */ + /**Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.*/ unit_amount_decimal: z .string() - .nullable() .describe( 'Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.' ) .optional(), - /** The amount in cents (or local equivalent) representing the unit amount being credited for this line item, excluding all tax and discounts. */ + /**The amount in cents (or local equivalent) representing the unit amount being credited for this line item, excluding all tax and discounts.*/ unit_amount_excluding_tax: z .string() - .nullable() .describe( 'The amount in cents (or local equivalent) representing the unit amount being credited for this line item, excluding all tax and discounts.' ) @@ -40699,10 +38523,10 @@ export namespace stripe { .describe('The credit note line item object') export type CreditNoteLineItem = z.infer - /** Represents a reader action to process a payment intent */ + /**Represents a reader action to process a payment intent*/ export const TerminalReaderReaderResourceProcessPaymentIntentActionSchema = z .object({ - /** Most recent PaymentIntent processed by the reader. */ + /**Most recent PaymentIntent processed by the reader.*/ payment_intent: z .union([z.string().max(5000), PaymentIntentSchema]) .describe('Most recent PaymentIntent processed by the reader.'), @@ -40715,7 +38539,7 @@ export namespace stripe { export const InboundTransfersSchema = z.object({ billing_details: TreasurySharedResourceBillingDetailsSchema, - /** The type of the payment method used in the InboundTransfer. */ + /**The type of the payment method used in the InboundTransfer.*/ type: z .literal('us_bank_account') .describe('The type of the payment method used in the InboundTransfer.'), @@ -40728,7 +38552,7 @@ export namespace stripe { billing_details: TreasurySharedResourceBillingDetailsSchema, financial_account: OutboundPaymentsPaymentMethodDetailsFinancialAccountSchema.optional(), - /** The type of the payment method used in the OutboundPayment. */ + /**The type of the payment method used in the OutboundPayment.*/ type: z .enum(['financial_account', 'us_bank_account']) .describe('The type of the payment method used in the OutboundPayment.'), @@ -40743,7 +38567,7 @@ export namespace stripe { billing_details: TreasurySharedResourceBillingDetailsSchema, financial_account: OutboundTransfersPaymentMethodDetailsFinancialAccountSchema.optional(), - /** The type of the payment method used in the OutboundTransfer. */ + /**The type of the payment method used in the OutboundTransfer.*/ type: z .enum(['financial_account', 'us_bank_account']) .describe('The type of the payment method used in the OutboundTransfer.'), @@ -40761,148 +38585,143 @@ export namespace stripe { */ export const CreditNoteSchema = z .object({ - /** The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax. */ + /**The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax.*/ amount: z .number() .int() .describe( 'The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax.' ), - /** This is the sum of all the shipping amounts. */ + /**This is the sum of all the shipping amounts.*/ amount_shipping: z .number() .int() .describe('This is the sum of all the shipping amounts.'), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** ID of the customer. */ + /**ID of the customer.*/ customer: z .union([z.string().max(5000), CustomerSchema, DeletedCustomerSchema]) .describe('ID of the customer.'), - /** Customer balance transaction related to this credit note. */ + /**Customer balance transaction related to this credit note.*/ customer_balance_transaction: z .union([z.string().max(5000), CustomerBalanceTransactionSchema]) - .nullable() .describe('Customer balance transaction related to this credit note.') .optional(), - /** The integer amount in cents (or local equivalent) representing the total amount of discount that was credited. */ + /**The integer amount in cents (or local equivalent) representing the total amount of discount that was credited.*/ discount_amount: z .number() .int() .describe( 'The integer amount in cents (or local equivalent) representing the total amount of discount that was credited.' ), - /** The aggregate amounts calculated per discount for all line items. */ + /**The aggregate amounts calculated per discount for all line items.*/ discount_amounts: z .array(DiscountsResourceDiscountAmountSchema) .describe( 'The aggregate amounts calculated per discount for all line items.' ), - /** The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF. */ + /**The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.*/ effective_at: z .number() .int() - .nullable() .describe( "The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF." ) .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** ID of the invoice. */ + /**ID of the invoice.*/ invoice: z .union([z.string().max(5000), InvoiceSchema]) .describe('ID of the invoice.'), - /** Line items that make up the credit note */ + /**Line items that make up the credit note*/ lines: z .object({ - /** Details about each object. */ + /**Details about each object.*/ data: z .array(CreditNoteLineItemSchema) .describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) .describe('The URL where this list can be accessed.') }) .describe('Line items that make up the credit note'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Customer-facing text that appears on the credit note PDF. */ + /**Customer-facing text that appears on the credit note PDF.*/ memo: z .string() .max(5000) - .nullable() .describe('Customer-facing text that appears on the credit note PDF.') .optional(), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) - .nullable() .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ) .optional(), - /** A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice. */ + /**A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.*/ number: z .string() .max(5000) .describe( 'A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('credit_note') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** Amount that was credited outside of Stripe. */ + /**Amount that was credited outside of Stripe.*/ out_of_band_amount: z .number() .int() - .nullable() .describe('Amount that was credited outside of Stripe.') .optional(), - /** The link to download the PDF of the credit note. */ + /**The link to download the PDF of the credit note.*/ pdf: z .string() .max(5000) .describe('The link to download the PDF of the credit note.'), - /** The pretax credit amounts (ex: discount, credit grants, etc) for all line items. */ + /**The pretax credit amounts (ex: discount, credit grants, etc) for all line items.*/ pretax_credit_amounts: z .array(CreditNotesPretaxCreditAmountSchema) .describe( 'The pretax credit amounts (ex: discount, credit grants, etc) for all line items.' ), - /** Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` */ + /**Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`*/ reason: z .enum([ 'duplicate', @@ -40910,78 +38729,71 @@ export namespace stripe { 'order_change', 'product_unsatisfactory' ]) - .nullable() .describe( 'Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`' ) .optional(), - /** Refund related to this credit note. */ + /**Refund related to this credit note.*/ refund: z .union([z.string().max(5000), RefundSchema]) - .nullable() .describe('Refund related to this credit note.') .optional(), - /** The details of the cost of shipping, including the ShippingRate applied to the invoice. */ - shipping_cost: InvoicesResourceShippingCostSchema.nullable() - .describe( - 'The details of the cost of shipping, including the ShippingRate applied to the invoice.' - ) - .optional(), - /** Status of this credit note, one of `issued` or `void`. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding). */ + /**The details of the cost of shipping, including the ShippingRate applied to the invoice.*/ + shipping_cost: InvoicesResourceShippingCostSchema.describe( + 'The details of the cost of shipping, including the ShippingRate applied to the invoice.' + ).optional(), + /**Status of this credit note, one of `issued` or `void`. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding).*/ status: z .enum(['issued', 'void']) .describe( 'Status of this credit note, one of `issued` or `void`. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding).' ), - /** The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts. */ + /**The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts.*/ subtotal: z .number() .int() .describe( 'The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts.' ), - /** The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts. */ + /**The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts.*/ subtotal_excluding_tax: z .number() .int() - .nullable() .describe( 'The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts.' ) .optional(), - /** The aggregate amounts calculated per tax rate for all line items. */ + /**The aggregate amounts calculated per tax rate for all line items.*/ tax_amounts: z .array(CreditNoteTaxAmountSchema) .describe( 'The aggregate amounts calculated per tax rate for all line items.' ), - /** The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount. */ + /**The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount.*/ total: z .number() .int() .describe( 'The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount.' ), - /** The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts. */ + /**The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts.*/ total_excluding_tax: z .number() .int() - .nullable() .describe( 'The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts.' ) .optional(), - /** Type of this credit note, one of `pre_payment` or `post_payment`. A `pre_payment` credit note means it was issued when the invoice was open. A `post_payment` credit note means it was issued when the invoice was paid. */ + /**Type of this credit note, one of `pre_payment` or `post_payment`. A `pre_payment` credit note means it was issued when the invoice was open. A `post_payment` credit note means it was issued when the invoice was paid.*/ type: z .enum(['post_payment', 'pre_payment']) .describe( 'Type of this credit note, one of `pre_payment` or `post_payment`. A `pre_payment` credit note means it was issued when the invoice was open. A `post_payment` credit note means it was issued when the invoice was paid.' ), - /** The time that the credit note was voided. */ + /**The time that the credit note was voided.*/ voided_at: z .number() .int() - .nullable() .describe('The time that the credit note was voided.') .optional() }) @@ -41000,83 +38812,79 @@ export namespace stripe { */ export const CustomerBalanceTransactionSchema = z .object({ - /** The amount of the transaction. A negative value is a credit for the customer's balance, and a positive value is a debit to the customer's `balance`. */ + /**The amount of the transaction. A negative value is a credit for the customer's balance, and a positive value is a debit to the customer's `balance`.*/ amount: z .number() .int() .describe( "The amount of the transaction. A negative value is a credit for the customer's balance, and a positive value is a debit to the customer's `balance`." ), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** The ID of the credit note (if any) related to the transaction. */ + /**The ID of the credit note (if any) related to the transaction.*/ credit_note: z .union([z.string().max(5000), CreditNoteSchema]) - .nullable() .describe( 'The ID of the credit note (if any) related to the transaction.' ) .optional(), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** The ID of the customer the transaction belongs to. */ + /**The ID of the customer the transaction belongs to.*/ customer: z .union([z.string().max(5000), CustomerSchema]) .describe('The ID of the customer the transaction belongs to.'), - /** An arbitrary string attached to the object. Often useful for displaying to users. */ + /**An arbitrary string attached to the object. Often useful for displaying to users.*/ description: z .string() .max(5000) - .nullable() .describe( 'An arbitrary string attached to the object. Often useful for displaying to users.' ) .optional(), - /** The customer's `balance` after the transaction was applied. A negative value decreases the amount due on the customer's next invoice. A positive value increases the amount due on the customer's next invoice. */ + /**The customer's `balance` after the transaction was applied. A negative value decreases the amount due on the customer's next invoice. A positive value increases the amount due on the customer's next invoice.*/ ending_balance: z .number() .int() .describe( "The customer's `balance` after the transaction was applied. A negative value decreases the amount due on the customer's next invoice. A positive value increases the amount due on the customer's next invoice." ), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** The ID of the invoice (if any) related to the transaction. */ + /**The ID of the invoice (if any) related to the transaction.*/ invoice: z .union([z.string().max(5000), InvoiceSchema]) - .nullable() .describe('The ID of the invoice (if any) related to the transaction.') .optional(), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) - .nullable() .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ) .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('customer_balance_transaction') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `invoice_overpaid`, `invoice_too_large`, `invoice_too_small`, `unspent_receiver_credit`, or `unapplied_from_invoice`. See the [Customer Balance page](https://stripe.com/docs/billing/customer/balance#types) to learn more about transaction types. */ + /**Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `invoice_overpaid`, `invoice_too_large`, `invoice_too_small`, `unspent_receiver_credit`, or `unapplied_from_invoice`. See the [Customer Balance page](https://stripe.com/docs/billing/customer/balance#types) to learn more about transaction types.*/ type: z .enum([ 'adjustment', @@ -41123,29 +38931,29 @@ export namespace stripe { 'The client secret of this Customer Session. Used on the client to set up secure access to the given `customer`.\n\nThe client secret can be used to provide access to `customer` from your frontend. It should not be stored, logged, or exposed to anyone other than the relevant customer. Make sure that you have TLS enabled on any page that includes the client secret.' ), components: CustomerSessionResourceComponentsSchema.optional(), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** The Customer the Customer Session was created for. */ + /**The Customer the Customer Session was created for.*/ customer: z .union([z.string().max(5000), CustomerSchema]) .describe('The Customer the Customer Session was created for.'), - /** The timestamp at which this Customer Session will expire. */ + /**The timestamp at which this Customer Session will expire.*/ expires_at: z .number() .int() .describe('The timestamp at which this Customer Session will expire.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('customer_session') .describe( @@ -41157,29 +38965,28 @@ export namespace stripe { ) export type CustomerSession = z.infer - /** The usage threshold alert configuration enables setting up alerts for when a certain usage threshold on a specific meter is crossed. */ + /**The usage threshold alert configuration enables setting up alerts for when a certain usage threshold on a specific meter is crossed.*/ export const ThresholdsResourceUsageThresholdConfigSchema = z .object({ - /** The filters allow limiting the scope of this usage alert. You can only specify up to one filter at this time. */ + /**The filters allow limiting the scope of this usage alert. You can only specify up to one filter at this time.*/ filters: z .array(ThresholdsResourceUsageAlertFilterSchema) - .nullable() .describe( 'The filters allow limiting the scope of this usage alert. You can only specify up to one filter at this time.' ) .optional(), - /** The value at which this alert will trigger. */ + /**The value at which this alert will trigger.*/ gte: z .number() .int() .describe('The value at which this alert will trigger.'), - /** The [Billing Meter](/api/billing/meter) ID whose usage is monitored. */ + /**The [Billing Meter](/api/billing/meter) ID whose usage is monitored.*/ meter: z .union([z.string().max(5000), BillingMeterSchema]) .describe( 'The [Billing Meter](/api/billing/meter) ID whose usage is monitored.' ), - /** Defines how the alert will behave. */ + /**Defines how the alert will behave.*/ recurrence: z .literal('one_time') .describe('Defines how the alert will behave.') @@ -41191,43 +38998,40 @@ export namespace stripe { typeof ThresholdsResourceUsageThresholdConfigSchema > - /** A billing alert is a resource that notifies you when a certain usage threshold on a meter is crossed. For example, you might create a billing alert to notify you when a certain user made 100 API requests. */ + /**A billing alert is a resource that notifies you when a certain usage threshold on a meter is crossed. For example, you might create a billing alert to notify you when a certain user made 100 API requests.*/ export const BillingAlertSchema = z .object({ - /** Defines the type of the alert. */ + /**Defines the type of the alert.*/ alert_type: z .literal('usage_threshold') .describe('Defines the type of the alert.'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('billing.alert') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** Status of the alert. This can be active, inactive or archived. */ + /**Status of the alert. This can be active, inactive or archived.*/ status: z .enum(['active', 'archived', 'inactive']) - .nullable() .describe( 'Status of the alert. This can be active, inactive or archived.' ) .optional(), - /** Title of the alert. */ + /**Title of the alert.*/ title: z.string().max(5000).describe('Title of the alert.'), - /** Encapsulates configuration of the alert to monitor usage on a specific [Billing Meter](https://stripe.com/docs/api/billing/meter). */ - usage_threshold: ThresholdsResourceUsageThresholdConfigSchema.nullable() - .describe( - 'Encapsulates configuration of the alert to monitor usage on a specific [Billing Meter](https://stripe.com/docs/api/billing/meter).' - ) - .optional() + /**Encapsulates configuration of the alert to monitor usage on a specific [Billing Meter](https://stripe.com/docs/api/billing/meter).*/ + usage_threshold: ThresholdsResourceUsageThresholdConfigSchema.describe( + 'Encapsulates configuration of the alert to monitor usage on a specific [Billing Meter](https://stripe.com/docs/api/billing/meter).' + ).optional() }) .describe( 'A billing alert is a resource that notifies you when a certain usage threshold on a meter is crossed. For example, you might create a billing alert to notify you when a certain user made 100 API requests.' @@ -41245,68 +39049,61 @@ export namespace stripe { */ export const ConfirmationTokenSchema = z .object({ - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Time at which this ConfirmationToken expires and can no longer be used to confirm a PaymentIntent or SetupIntent. */ + /**Time at which this ConfirmationToken expires and can no longer be used to confirm a PaymentIntent or SetupIntent.*/ expires_at: z .number() .int() - .nullable() .describe( 'Time at which this ConfirmationToken expires and can no longer be used to confirm a PaymentIntent or SetupIntent.' ) .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Data used for generating a Mandate. */ - mandate_data: ConfirmationTokensResourceMandateDataSchema.nullable() - .describe('Data used for generating a Mandate.') - .optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + /**Data used for generating a Mandate.*/ + mandate_data: ConfirmationTokensResourceMandateDataSchema.describe( + 'Data used for generating a Mandate.' + ).optional(), + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('confirmation_token') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** ID of the PaymentIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used. */ + /**ID of the PaymentIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.*/ payment_intent: z .string() .max(5000) - .nullable() .describe( 'ID of the PaymentIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.' ) .optional(), - /** Payment-method-specific configuration for this ConfirmationToken. */ + /**Payment-method-specific configuration for this ConfirmationToken.*/ payment_method_options: - ConfirmationTokensResourcePaymentMethodOptionsSchema.nullable() - .describe( - 'Payment-method-specific configuration for this ConfirmationToken.' - ) - .optional(), - /** Payment details collected by the Payment Element, used to create a PaymentMethod when a PaymentIntent or SetupIntent is confirmed with this ConfirmationToken. */ + ConfirmationTokensResourcePaymentMethodOptionsSchema.describe( + 'Payment-method-specific configuration for this ConfirmationToken.' + ).optional(), + /**Payment details collected by the Payment Element, used to create a PaymentMethod when a PaymentIntent or SetupIntent is confirmed with this ConfirmationToken.*/ payment_method_preview: - ConfirmationTokensResourcePaymentMethodPreviewSchema.nullable() - .describe( - 'Payment details collected by the Payment Element, used to create a PaymentMethod when a PaymentIntent or SetupIntent is confirmed with this ConfirmationToken.' - ) - .optional(), - /** Return URL used to confirm the Intent. */ + ConfirmationTokensResourcePaymentMethodPreviewSchema.describe( + 'Payment details collected by the Payment Element, used to create a PaymentMethod when a PaymentIntent or SetupIntent is confirmed with this ConfirmationToken.' + ).optional(), + /**Return URL used to confirm the Intent.*/ return_url: z .string() .max(5000) - .nullable() .describe('Return URL used to confirm the Intent.') .optional(), /** @@ -41316,25 +39113,23 @@ export namespace stripe { */ setup_future_usage: z .enum(['off_session', 'on_session']) - .nullable() .describe( "Indicates that you intend to make future payments with this ConfirmationToken's payment method.\n\nThe presence of this property will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete." ) .optional(), - /** ID of the SetupIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used. */ + /**ID of the SetupIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.*/ setup_intent: z .string() .max(5000) - .nullable() .describe( 'ID of the SetupIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.' ) .optional(), - /** Shipping information collected on this ConfirmationToken. */ - shipping: ConfirmationTokensResourceShippingSchema.nullable() - .describe('Shipping information collected on this ConfirmationToken.') - .optional(), - /** Indicates whether the Stripe SDK is used to handle confirmation flow. Defaults to `true` on ConfirmationToken. */ + /**Shipping information collected on this ConfirmationToken.*/ + shipping: ConfirmationTokensResourceShippingSchema.describe( + 'Shipping information collected on this ConfirmationToken.' + ).optional(), + /**Indicates whether the Stripe SDK is used to handle confirmation flow. Defaults to `true` on ConfirmationToken.*/ use_stripe_sdk: z .boolean() .describe( @@ -41346,98 +39141,89 @@ export namespace stripe { ) export type ConfirmationToken = z.infer - /** A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access. */ + /**A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access.*/ export const FinancialConnectionsAccountSchema = z .object({ - /** The account holder that this account belongs to. */ - account_holder: BankConnectionsResourceAccountholderSchema.nullable() - .describe('The account holder that this account belongs to.') - .optional(), - /** The most recent information about the account's balance. */ - balance: BankConnectionsResourceBalanceSchema.nullable() - .describe("The most recent information about the account's balance.") - .optional(), - /** The state of the most recent attempt to refresh the account balance. */ - balance_refresh: BankConnectionsResourceBalanceRefreshSchema.nullable() - .describe( - 'The state of the most recent attempt to refresh the account balance.' - ) - .optional(), - /** The type of the account. Account category is further divided in `subcategory`. */ + /**The account holder that this account belongs to.*/ + account_holder: BankConnectionsResourceAccountholderSchema.describe( + 'The account holder that this account belongs to.' + ).optional(), + /**The most recent information about the account's balance.*/ + balance: BankConnectionsResourceBalanceSchema.describe( + "The most recent information about the account's balance." + ).optional(), + /**The state of the most recent attempt to refresh the account balance.*/ + balance_refresh: BankConnectionsResourceBalanceRefreshSchema.describe( + 'The state of the most recent attempt to refresh the account balance.' + ).optional(), + /**The type of the account. Account category is further divided in `subcategory`.*/ category: z .enum(['cash', 'credit', 'investment', 'other']) .describe( 'The type of the account. Account category is further divided in `subcategory`.' ), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** A human-readable name that has been assigned to this account, either by the account holder or by the institution. */ + /**A human-readable name that has been assigned to this account, either by the account holder or by the institution.*/ display_name: z .string() .max(5000) - .nullable() .describe( 'A human-readable name that has been assigned to this account, either by the account holder or by the institution.' ) .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** The name of the institution that holds this account. */ + /**The name of the institution that holds this account.*/ institution_name: z .string() .max(5000) .describe('The name of the institution that holds this account.'), - /** The last 4 digits of the account number. If present, this will be 4 numeric characters. */ + /**The last 4 digits of the account number. If present, this will be 4 numeric characters.*/ last4: z .string() .max(5000) - .nullable() .describe( 'The last 4 digits of the account number. If present, this will be 4 numeric characters.' ) .optional(), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('financial_connections.account') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The most recent information about the account's owners. */ + /**The most recent information about the account's owners.*/ ownership: z .union([ z.string().max(5000), FinancialConnectionsAccountOwnershipSchema ]) - .nullable() .describe("The most recent information about the account's owners.") .optional(), - /** The state of the most recent attempt to refresh the account owners. */ - ownership_refresh: - BankConnectionsResourceOwnershipRefreshSchema.nullable() - .describe( - 'The state of the most recent attempt to refresh the account owners.' - ) - .optional(), - /** The list of permissions granted by this account. */ + /**The state of the most recent attempt to refresh the account owners.*/ + ownership_refresh: BankConnectionsResourceOwnershipRefreshSchema.describe( + 'The state of the most recent attempt to refresh the account owners.' + ).optional(), + /**The list of permissions granted by this account.*/ permissions: z .array( z.enum(['balances', 'ownership', 'payment_method', 'transactions']) ) - .nullable() .describe('The list of permissions granted by this account.') .optional(), - /** The status of the link to the account. */ + /**The status of the link to the account.*/ status: z .enum(['active', 'disconnected', 'inactive']) .describe('The status of the link to the account.'), @@ -41469,27 +39255,24 @@ export namespace stripe { .describe( 'If `category` is `cash`, one of:\n\n - `checking`\n - `savings`\n - `other`\n\nIf `category` is `credit`, one of:\n\n - `mortgage`\n - `line_of_credit`\n - `credit_card`\n - `other`\n\nIf `category` is `investment` or `other`, this will be `other`.' ), - /** The list of data refresh subscriptions requested on this account. */ + /**The list of data refresh subscriptions requested on this account.*/ subscriptions: z .array(z.literal('transactions')) - .nullable() .describe( 'The list of data refresh subscriptions requested on this account.' ) .optional(), - /** The [PaymentMethod type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type)(s) that can be created from this account. */ + /**The [PaymentMethod type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type)(s) that can be created from this account.*/ supported_payment_method_types: z .array(z.enum(['link', 'us_bank_account'])) .describe( 'The [PaymentMethod type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type)(s) that can be created from this account.' ), - /** The state of the most recent attempt to refresh the account transactions. */ + /**The state of the most recent attempt to refresh the account transactions.*/ transaction_refresh: - BankConnectionsResourceTransactionRefreshSchema.nullable() - .describe( - 'The state of the most recent attempt to refresh the account transactions.' - ) - .optional() + BankConnectionsResourceTransactionRefreshSchema.describe( + 'The state of the most recent attempt to refresh the account transactions.' + ).optional() }) .describe( 'A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access.' @@ -41498,21 +39281,19 @@ export namespace stripe { typeof FinancialConnectionsAccountSchema > - /** Represents an action performed by the reader */ + /**Represents an action performed by the reader*/ export const TerminalReaderReaderResourceReaderActionSchema = z .object({ - /** Failure code, only set if status is `failed`. */ + /**Failure code, only set if status is `failed`.*/ failure_code: z .string() .max(5000) - .nullable() .describe('Failure code, only set if status is `failed`.') .optional(), - /** Detailed failure message, only set if status is `failed`. */ + /**Detailed failure message, only set if status is `failed`.*/ failure_message: z .string() .max(5000) - .nullable() .describe('Detailed failure message, only set if status is `failed`.') .optional(), process_payment_intent: @@ -41523,11 +39304,11 @@ export namespace stripe { TerminalReaderReaderResourceRefundPaymentActionSchema.optional(), set_reader_display: TerminalReaderReaderResourceSetReaderDisplayActionSchema.optional(), - /** Status of the action performed by the reader. */ + /**Status of the action performed by the reader.*/ status: z .enum(['failed', 'in_progress', 'succeeded']) .describe('Status of the action performed by the reader.'), - /** Type of action performed by the reader. */ + /**Type of action performed by the reader.*/ type: z .enum([ 'process_payment_intent', @@ -41542,35 +39323,33 @@ export namespace stripe { typeof TerminalReaderReaderResourceReaderActionSchema > - /** A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts. */ + /**A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts.*/ export const FinancialConnectionsSessionSchema = z .object({ - /** The account holder for whom accounts are collected in this session. */ - account_holder: BankConnectionsResourceAccountholderSchema.nullable() - .describe( - 'The account holder for whom accounts are collected in this session.' - ) - .optional(), - /** The accounts that were collected as part of this Session. */ + /**The account holder for whom accounts are collected in this session.*/ + account_holder: BankConnectionsResourceAccountholderSchema.describe( + 'The account holder for whom accounts are collected in this session.' + ).optional(), + /**The accounts that were collected as part of this Session.*/ accounts: z .object({ - /** Details about each object. */ + /**Details about each object.*/ data: z .array(FinancialConnectionsAccountSchema) .describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/financial_connections/accounts')) @@ -41578,7 +39357,7 @@ export namespace stripe { .describe('The URL where this list can be accessed.') }) .describe('The accounts that were collected as part of this Session.'), - /** A value that will be passed to the client to launch the authentication flow. */ + /**A value that will be passed to the client to launch the authentication flow.*/ client_secret: z .string() .max(5000) @@ -41587,21 +39366,21 @@ export namespace stripe { ), filters: BankConnectionsResourceLinkAccountSessionFiltersSchema.optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('financial_connections.session') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** Permissions requested for accounts collected during this session. */ + /**Permissions requested for accounts collected during this session.*/ permissions: z .array( z.enum(['balances', 'ownership', 'payment_method', 'transactions']) @@ -41609,15 +39388,14 @@ export namespace stripe { .describe( 'Permissions requested for accounts collected during this session.' ), - /** Data features requested to be retrieved upon account creation. */ + /**Data features requested to be retrieved upon account creation.*/ prefetch: z .array(z.enum(['balances', 'ownership', 'transactions'])) - .nullable() .describe( 'Data features requested to be retrieved upon account creation.' ) .optional(), - /** For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. */ + /**For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.*/ return_url: z .string() .max(5000) @@ -41640,18 +39418,17 @@ export namespace stripe { */ export const TerminalReaderSchema = z .object({ - /** The most recent action performed by the reader. */ - action: TerminalReaderReaderResourceReaderActionSchema.nullable() - .describe('The most recent action performed by the reader.') - .optional(), - /** The current software version of the reader. */ + /**The most recent action performed by the reader.*/ + action: TerminalReaderReaderResourceReaderActionSchema.describe( + 'The most recent action performed by the reader.' + ).optional(), + /**The current software version of the reader.*/ device_sw_version: z .string() .max(5000) - .nullable() .describe('The current software version of the reader.') .optional(), - /** Type of reader, one of `bbpos_wisepad3`, `stripe_m2`, `stripe_s700`, `bbpos_chipper2x`, `bbpos_wisepos_e`, `verifone_P400`, `simulated_wisepos_e`, or `mobile_phone_reader`. */ + /**Type of reader, one of `bbpos_wisepad3`, `stripe_m2`, `stripe_s700`, `bbpos_chipper2x`, `bbpos_wisepos_e`, `verifone_P400`, `simulated_wisepos_e`, or `mobile_phone_reader`.*/ device_type: z .enum([ 'bbpos_chipper2x', @@ -41666,55 +39443,52 @@ export namespace stripe { .describe( 'Type of reader, one of `bbpos_wisepad3`, `stripe_m2`, `stripe_s700`, `bbpos_chipper2x`, `bbpos_wisepos_e`, `verifone_P400`, `simulated_wisepos_e`, or `mobile_phone_reader`.' ), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** The local IP address of the reader. */ + /**The local IP address of the reader.*/ ip_address: z .string() .max(5000) - .nullable() .describe('The local IP address of the reader.') .optional(), - /** Custom label given to the reader for easier identification. */ + /**Custom label given to the reader for easier identification.*/ label: z .string() .max(5000) .describe( 'Custom label given to the reader for easier identification.' ), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** The location identifier of the reader. */ + /**The location identifier of the reader.*/ location: z .union([z.string().max(5000), TerminalLocationSchema]) - .nullable() .describe('The location identifier of the reader.') .optional(), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('terminal.reader') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** Serial number of the reader. */ + /**Serial number of the reader.*/ serial_number: z .string() .max(5000) .describe('Serial number of the reader.'), - /** The networking status of the reader. We do not recommend using this field in flows that may block taking payments. */ + /**The networking status of the reader. We do not recommend using this field in flows that may block taking payments.*/ status: z .enum(['offline', 'online']) - .nullable() .describe( 'The networking status of the reader. We do not recommend using this field in flows that may block taking payments.' ) @@ -41734,111 +39508,103 @@ export namespace stripe { */ export const PaymentLinkSchema = z .object({ - /** Whether the payment link's `url` is active. If `false`, customers visiting the URL will be shown a page saying that the link has been deactivated. */ + /**Whether the payment link's `url` is active. If `false`, customers visiting the URL will be shown a page saying that the link has been deactivated.*/ active: z .boolean() .describe( "Whether the payment link's `url` is active. If `false`, customers visiting the URL will be shown a page saying that the link has been deactivated." ), after_completion: PaymentLinksResourceAfterCompletionSchema, - /** Whether user redeemable promotion codes are enabled. */ + /**Whether user redeemable promotion codes are enabled.*/ allow_promotion_codes: z .boolean() .describe('Whether user redeemable promotion codes are enabled.'), - /** The ID of the Connect application that created the Payment Link. */ + /**The ID of the Connect application that created the Payment Link.*/ application: z .union([ z.string().max(5000), ApplicationSchema, DeletedApplicationSchema ]) - .nullable() .describe( 'The ID of the Connect application that created the Payment Link.' ) .optional(), - /** The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. */ + /**The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account.*/ application_fee_amount: z .number() .int() - .nullable() .describe( "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account." ) .optional(), - /** This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. */ + /**This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.*/ application_fee_percent: z .number() - .nullable() .describe( "This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account." ) .optional(), automatic_tax: PaymentLinksResourceAutomaticTaxSchema, - /** Configuration for collecting the customer's billing address. Defaults to `auto`. */ + /**Configuration for collecting the customer's billing address. Defaults to `auto`.*/ billing_address_collection: z .enum(['auto', 'required']) .describe( "Configuration for collecting the customer's billing address. Defaults to `auto`." ), - /** When set, provides configuration to gather active consent from customers. */ - consent_collection: PaymentLinksResourceConsentCollectionSchema.nullable() - .describe( - 'When set, provides configuration to gather active consent from customers.' - ) - .optional(), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**When set, provides configuration to gather active consent from customers.*/ + consent_collection: PaymentLinksResourceConsentCollectionSchema.describe( + 'When set, provides configuration to gather active consent from customers.' + ).optional(), + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** Collect additional information from your customer using custom fields. Up to 3 fields are supported. */ + /**Collect additional information from your customer using custom fields. Up to 3 fields are supported.*/ custom_fields: z .array(PaymentLinksResourceCustomFieldsSchema) .describe( 'Collect additional information from your customer using custom fields. Up to 3 fields are supported.' ), custom_text: PaymentLinksResourceCustomTextSchema, - /** Configuration for Customer creation during checkout. */ + /**Configuration for Customer creation during checkout.*/ customer_creation: z .enum(['always', 'if_required']) .describe('Configuration for Customer creation during checkout.'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** The custom message to be displayed to a customer when a payment link is no longer active. */ + /**The custom message to be displayed to a customer when a payment link is no longer active.*/ inactive_message: z .string() .max(5000) - .nullable() .describe( 'The custom message to be displayed to a customer when a payment link is no longer active.' ) .optional(), - /** Configuration for creating invoice for payment mode payment links. */ - invoice_creation: PaymentLinksResourceInvoiceCreationSchema.nullable() - .describe( - 'Configuration for creating invoice for payment mode payment links.' - ) - .optional(), - /** The line items representing what is being sold. */ + /**Configuration for creating invoice for payment mode payment links.*/ + invoice_creation: PaymentLinksResourceInvoiceCreationSchema.describe( + 'Configuration for creating invoice for payment mode payment links.' + ).optional(), + /**The line items representing what is being sold.*/ line_items: z .object({ - /** Details about each object. */ + /**Details about each object.*/ data: z.array(ItemSchema).describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -41846,46 +39612,42 @@ export namespace stripe { }) .describe('The line items representing what is being sold.') .optional(), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('payment_link') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details. */ + /**The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details.*/ on_behalf_of: z .union([z.string().max(5000), AccountSchema]) - .nullable() .describe( 'The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details.' ) .optional(), - /** Indicates the parameters to be passed to PaymentIntent creation during checkout. */ - payment_intent_data: - PaymentLinksResourcePaymentIntentDataSchema.nullable() - .describe( - 'Indicates the parameters to be passed to PaymentIntent creation during checkout.' - ) - .optional(), - /** Configuration for collecting a payment method during checkout. Defaults to `always`. */ + /**Indicates the parameters to be passed to PaymentIntent creation during checkout.*/ + payment_intent_data: PaymentLinksResourcePaymentIntentDataSchema.describe( + 'Indicates the parameters to be passed to PaymentIntent creation during checkout.' + ).optional(), + /**Configuration for collecting a payment method during checkout. Defaults to `always`.*/ payment_method_collection: z .enum(['always', 'if_required']) .describe( 'Configuration for collecting a payment method during checkout. Defaults to `always`.' ), - /** The list of payment method types that customers can use. When `null`, Stripe will dynamically show relevant payment methods you've enabled in your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). */ + /**The list of payment method types that customers can use. When `null`, Stripe will dynamically show relevant payment methods you've enabled in your [payment method settings](https://dashboard.stripe.com/settings/payment_methods).*/ payment_method_types: z .array( z.enum([ @@ -41926,47 +39688,40 @@ export namespace stripe { 'zip' ]) ) - .nullable() .describe( "The list of payment method types that customers can use. When `null`, Stripe will dynamically show relevant payment methods you've enabled in your [payment method settings](https://dashboard.stripe.com/settings/payment_methods)." ) .optional(), phone_number_collection: PaymentLinksResourcePhoneNumberCollectionSchema, - /** Settings that restrict the usage of a payment link. */ - restrictions: PaymentLinksResourceRestrictionsSchema.nullable() - .describe('Settings that restrict the usage of a payment link.') - .optional(), - /** Configuration for collecting the customer's shipping address. */ + /**Settings that restrict the usage of a payment link.*/ + restrictions: PaymentLinksResourceRestrictionsSchema.describe( + 'Settings that restrict the usage of a payment link.' + ).optional(), + /**Configuration for collecting the customer's shipping address.*/ shipping_address_collection: - PaymentLinksResourceShippingAddressCollectionSchema.nullable() - .describe( - "Configuration for collecting the customer's shipping address." - ) - .optional(), - /** The shipping rate options applied to the session. */ + PaymentLinksResourceShippingAddressCollectionSchema.describe( + "Configuration for collecting the customer's shipping address." + ).optional(), + /**The shipping rate options applied to the session.*/ shipping_options: z .array(PaymentLinksResourceShippingOptionSchema) .describe('The shipping rate options applied to the session.'), - /** Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button. */ + /**Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.*/ submit_type: z .enum(['auto', 'book', 'donate', 'pay', 'subscribe']) .describe( 'Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.' ), - /** When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`. */ - subscription_data: PaymentLinksResourceSubscriptionDataSchema.nullable() - .describe( - 'When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.' - ) - .optional(), + /**When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.*/ + subscription_data: PaymentLinksResourceSubscriptionDataSchema.describe( + 'When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.' + ).optional(), tax_id_collection: PaymentLinksResourceTaxIdCollectionSchema, - /** The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to. */ - transfer_data: PaymentLinksResourceTransferDataSchema.nullable() - .describe( - 'The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.' - ) - .optional(), - /** The public URL that can be shared with customers. */ + /**The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.*/ + transfer_data: PaymentLinksResourceTransferDataSchema.describe( + 'The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.' + ).optional(), + /**The public URL that can be shared with customers.*/ url: z .string() .max(5000) @@ -41984,108 +39739,102 @@ export namespace stripe { */ export const TreasuryInboundTransferSchema = z .object({ - /** Amount (in cents) transferred. */ + /**Amount (in cents) transferred.*/ amount: z.number().int().describe('Amount (in cents) transferred.'), - /** Returns `true` if the InboundTransfer is able to be canceled. */ + /**Returns `true` if the InboundTransfer is able to be canceled.*/ cancelable: z .boolean() .describe( 'Returns `true` if the InboundTransfer is able to be canceled.' ), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** An arbitrary string attached to the object. Often useful for displaying to users. */ + /**An arbitrary string attached to the object. Often useful for displaying to users.*/ description: z .string() .max(5000) - .nullable() .describe( 'An arbitrary string attached to the object. Often useful for displaying to users.' ) .optional(), - /** Details about this InboundTransfer's failure. Only set when status is `failed`. */ + /**Details about this InboundTransfer's failure. Only set when status is `failed`.*/ failure_details: - TreasuryInboundTransfersResourceFailureDetailsSchema.nullable() - .describe( - "Details about this InboundTransfer's failure. Only set when status is `failed`." - ) - .optional(), - /** The FinancialAccount that received the funds. */ + TreasuryInboundTransfersResourceFailureDetailsSchema.describe( + "Details about this InboundTransfer's failure. Only set when status is `failed`." + ).optional(), + /**The FinancialAccount that received the funds.*/ financial_account: z .string() .max(5000) .describe('The FinancialAccount that received the funds.'), - /** A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. */ + /**A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.*/ hosted_regulatory_receipt_url: z .string() .max(5000) - .nullable() .describe( "A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses." ) .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), linked_flows: TreasuryInboundTransfersResourceInboundTransferResourceLinkedFlowsSchema, - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('treasury.inbound_transfer') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The origin payment method to be debited for an InboundTransfer. */ + /**The origin payment method to be debited for an InboundTransfer.*/ origin_payment_method: z .string() .max(5000) - .nullable() .describe( 'The origin payment method to be debited for an InboundTransfer.' ) .optional(), - /** Details about the PaymentMethod for an InboundTransfer. */ - origin_payment_method_details: InboundTransfersSchema.nullable() - .describe('Details about the PaymentMethod for an InboundTransfer.') - .optional(), - /** Returns `true` if the funds for an InboundTransfer were returned after the InboundTransfer went to the `succeeded` state. */ + /**Details about the PaymentMethod for an InboundTransfer.*/ + origin_payment_method_details: InboundTransfersSchema.describe( + 'Details about the PaymentMethod for an InboundTransfer.' + ).optional(), + /**Returns `true` if the funds for an InboundTransfer were returned after the InboundTransfer went to the `succeeded` state.*/ returned: z .boolean() - .nullable() .describe( 'Returns `true` if the funds for an InboundTransfer were returned after the InboundTransfer went to the `succeeded` state.' ) .optional(), - /** Statement descriptor shown when funds are debited from the source. Not all payment networks support `statement_descriptor`. */ + /**Statement descriptor shown when funds are debited from the source. Not all payment networks support `statement_descriptor`.*/ statement_descriptor: z .string() .max(5000) .describe( 'Statement descriptor shown when funds are debited from the source. Not all payment networks support `statement_descriptor`.' ), - /** Status of the InboundTransfer: `processing`, `succeeded`, `failed`, and `canceled`. An InboundTransfer is `processing` if it is created and pending. The status changes to `succeeded` once the funds have been "confirmed" and a `transaction` is created and posted. The status changes to `failed` if the transfer fails. */ + /**Status of the InboundTransfer: `processing`, `succeeded`, `failed`, and `canceled`. An InboundTransfer is `processing` if it is created and pending. The status changes to `succeeded` once the funds have been "confirmed" and a `transaction` is created and posted. The status changes to `failed` if the transfer fails.*/ status: z .enum(['canceled', 'failed', 'processing', 'succeeded']) .describe( @@ -42093,10 +39842,9 @@ export namespace stripe { ), status_transitions: TreasuryInboundTransfersResourceInboundTransferResourceStatusTransitionsSchema, - /** The Transaction associated with this object. */ + /**The Transaction associated with this object.*/ transaction: z .union([z.string().max(5000), TreasuryTransactionSchema]) - .nullable() .describe('The Transaction associated with this object.') .optional() }) @@ -42107,80 +39855,78 @@ export namespace stripe { typeof TreasuryInboundTransferSchema > - /** Transactions represent changes to a [FinancialAccount's](https://stripe.com/docs/api#financial_accounts) balance. */ + /**Transactions represent changes to a [FinancialAccount's](https://stripe.com/docs/api#financial_accounts) balance.*/ export const TreasuryTransactionSchema = z .object({ - /** Amount (in cents) transferred. */ + /**Amount (in cents) transferred.*/ amount: z.number().int().describe('Amount (in cents) transferred.'), balance_impact: TreasuryTransactionsResourceBalanceImpactSchema, - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** An arbitrary string attached to the object. Often useful for displaying to users. */ + /**An arbitrary string attached to the object. Often useful for displaying to users.*/ description: z .string() .max(5000) .describe( 'An arbitrary string attached to the object. Often useful for displaying to users.' ), - /** A list of TransactionEntries that are part of this Transaction. This cannot be expanded in any list endpoints. */ + /**A list of TransactionEntries that are part of this Transaction. This cannot be expanded in any list endpoints.*/ entries: z .object({ - /** Details about each object. */ + /**Details about each object.*/ data: z .array(TreasuryTransactionEntrySchema) .describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/treasury/transaction_entries')) .max(5000) .describe('The URL where this list can be accessed.') }) - .nullable() .describe( 'A list of TransactionEntries that are part of this Transaction. This cannot be expanded in any list endpoints.' ) .optional(), - /** The FinancialAccount associated with this object. */ + /**The FinancialAccount associated with this object.*/ financial_account: z .string() .max(5000) .describe('The FinancialAccount associated with this object.'), - /** ID of the flow that created the Transaction. */ + /**ID of the flow that created the Transaction.*/ flow: z .string() .max(5000) - .nullable() .describe('ID of the flow that created the Transaction.') .optional(), - /** Details of the flow that created the Transaction. */ - flow_details: TreasuryTransactionsResourceFlowDetailsSchema.nullable() - .describe('Details of the flow that created the Transaction.') - .optional(), - /** Type of the flow that created the Transaction. */ + /**Details of the flow that created the Transaction.*/ + flow_details: TreasuryTransactionsResourceFlowDetailsSchema.describe( + 'Details of the flow that created the Transaction.' + ).optional(), + /**Type of the flow that created the Transaction.*/ flow_type: z .enum([ 'credit_reversal', @@ -42194,21 +39940,21 @@ export namespace stripe { 'received_debit' ]) .describe('Type of the flow that created the Transaction.'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('treasury.transaction') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** Status of the Transaction. */ + /**Status of the Transaction.*/ status: z .enum(['open', 'posted', 'void']) .describe('Status of the Transaction.'), @@ -42220,47 +39966,46 @@ export namespace stripe { ) export type TreasuryTransaction = z.infer - /** TransactionEntries represent individual units of money movements within a single [Transaction](https://stripe.com/docs/api#transactions). */ + /**TransactionEntries represent individual units of money movements within a single [Transaction](https://stripe.com/docs/api#transactions).*/ export const TreasuryTransactionEntrySchema = z .object({ balance_impact: TreasuryTransactionsResourceBalanceImpactSchema, - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** When the TransactionEntry will impact the FinancialAccount's balance. */ + /**When the TransactionEntry will impact the FinancialAccount's balance.*/ effective_at: z .number() .int() .describe( "When the TransactionEntry will impact the FinancialAccount's balance." ), - /** The FinancialAccount associated with this object. */ + /**The FinancialAccount associated with this object.*/ financial_account: z .string() .max(5000) .describe('The FinancialAccount associated with this object.'), - /** Token of the flow associated with the TransactionEntry. */ + /**Token of the flow associated with the TransactionEntry.*/ flow: z .string() .max(5000) - .nullable() .describe('Token of the flow associated with the TransactionEntry.') .optional(), - /** Details of the flow associated with the TransactionEntry. */ - flow_details: TreasuryTransactionsResourceFlowDetailsSchema.nullable() - .describe('Details of the flow associated with the TransactionEntry.') - .optional(), - /** Type of the flow associated with the TransactionEntry. */ + /**Details of the flow associated with the TransactionEntry.*/ + flow_details: TreasuryTransactionsResourceFlowDetailsSchema.describe( + 'Details of the flow associated with the TransactionEntry.' + ).optional(), + /**Type of the flow associated with the TransactionEntry.*/ flow_type: z .enum([ 'credit_reversal', @@ -42274,25 +40019,25 @@ export namespace stripe { 'received_debit' ]) .describe('Type of the flow associated with the TransactionEntry.'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('treasury.transaction_entry') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The Transaction associated with this object. */ + /**The Transaction associated with this object.*/ transaction: z .union([z.string().max(5000), TreasuryTransactionSchema]) .describe('The Transaction associated with this object.'), - /** The specific money movement that generated the TransactionEntry. */ + /**The specific money movement that generated the TransactionEntry.*/ type: z .enum([ 'credit_reversal', @@ -42336,7 +40081,7 @@ export namespace stripe { outbound_transfer: TreasuryOutboundTransferSchema.optional(), received_credit: TreasuryReceivedCreditSchema.optional(), received_debit: TreasuryReceivedDebitSchema.optional(), - /** Type of the flow that created the Transaction. Set to the same value as `flow_type`. */ + /**Type of the flow that created the Transaction. Set to the same value as `flow_type`.*/ type: z .enum([ 'credit_reversal', @@ -42357,77 +40102,75 @@ export namespace stripe { typeof TreasuryTransactionsResourceFlowDetailsSchema > - /** You can reverse some [ReceivedCredits](https://stripe.com/docs/api#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal. */ + /**You can reverse some [ReceivedCredits](https://stripe.com/docs/api#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.*/ export const TreasuryCreditReversalSchema = z .object({ - /** Amount (in cents) transferred. */ + /**Amount (in cents) transferred.*/ amount: z.number().int().describe('Amount (in cents) transferred.'), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** The FinancialAccount to reverse funds from. */ + /**The FinancialAccount to reverse funds from.*/ financial_account: z .string() .max(5000) .describe('The FinancialAccount to reverse funds from.'), - /** A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. */ + /**A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.*/ hosted_regulatory_receipt_url: z .string() .max(5000) - .nullable() .describe( "A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses." ) .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ), - /** The rails used to reverse the funds. */ + /**The rails used to reverse the funds.*/ network: z .enum(['ach', 'stripe']) .describe('The rails used to reverse the funds.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('treasury.credit_reversal') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The ReceivedCredit being reversed. */ + /**The ReceivedCredit being reversed.*/ received_credit: z .string() .max(5000) .describe('The ReceivedCredit being reversed.'), - /** Status of the CreditReversal */ + /**Status of the CreditReversal*/ status: z .enum(['canceled', 'posted', 'processing']) .describe('Status of the CreditReversal'), status_transitions: TreasuryReceivedCreditsResourceStatusTransitionsSchema, - /** The Transaction associated with this object. */ + /**The Transaction associated with this object.*/ transaction: z .union([z.string().max(5000), TreasuryTransactionSchema]) - .nullable() .describe('The Transaction associated with this object.') .optional() }) @@ -42438,83 +40181,80 @@ export namespace stripe { typeof TreasuryCreditReversalSchema > - /** You can reverse some [ReceivedDebits](https://stripe.com/docs/api#received_debits) depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal. */ + /**You can reverse some [ReceivedDebits](https://stripe.com/docs/api#received_debits) depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal.*/ export const TreasuryDebitReversalSchema = z .object({ - /** Amount (in cents) transferred. */ + /**Amount (in cents) transferred.*/ amount: z.number().int().describe('Amount (in cents) transferred.'), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** The FinancialAccount to reverse funds from. */ + /**The FinancialAccount to reverse funds from.*/ financial_account: z .string() .max(5000) - .nullable() .describe('The FinancialAccount to reverse funds from.') .optional(), - /** A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. */ + /**A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.*/ hosted_regulatory_receipt_url: z .string() .max(5000) - .nullable() .describe( "A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses." ) .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Other flows linked to a DebitReversal. */ + /**Other flows linked to a DebitReversal.*/ linked_flows: - TreasuryReceivedDebitsResourceDebitReversalLinkedFlowsSchema.nullable() - .describe('Other flows linked to a DebitReversal.') - .optional(), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + TreasuryReceivedDebitsResourceDebitReversalLinkedFlowsSchema.describe( + 'Other flows linked to a DebitReversal.' + ).optional(), + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ), - /** The rails used to reverse the funds. */ + /**The rails used to reverse the funds.*/ network: z .enum(['ach', 'card']) .describe('The rails used to reverse the funds.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('treasury.debit_reversal') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The ReceivedDebit being reversed. */ + /**The ReceivedDebit being reversed.*/ received_debit: z .string() .max(5000) .describe('The ReceivedDebit being reversed.'), - /** Status of the DebitReversal */ + /**Status of the DebitReversal*/ status: z .enum(['failed', 'processing', 'succeeded']) .describe('Status of the DebitReversal'), status_transitions: TreasuryReceivedDebitsResourceStatusTransitionsSchema, - /** The Transaction associated with this object. */ + /**The Transaction associated with this object.*/ transaction: z .union([z.string().max(5000), TreasuryTransactionSchema]) - .nullable() .describe('The Transaction associated with this object.') .optional() }) @@ -42534,120 +40274,114 @@ export namespace stripe { */ export const TreasuryOutboundPaymentSchema = z .object({ - /** Amount (in cents) transferred. */ + /**Amount (in cents) transferred.*/ amount: z.number().int().describe('Amount (in cents) transferred.'), - /** Returns `true` if the object can be canceled, and `false` otherwise. */ + /**Returns `true` if the object can be canceled, and `false` otherwise.*/ cancelable: z .boolean() .describe( 'Returns `true` if the object can be canceled, and `false` otherwise.' ), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** ID of the [customer](https://stripe.com/docs/api/customers) to whom an OutboundPayment is sent. */ + /**ID of the [customer](https://stripe.com/docs/api/customers) to whom an OutboundPayment is sent.*/ customer: z .string() .max(5000) - .nullable() .describe( 'ID of the [customer](https://stripe.com/docs/api/customers) to whom an OutboundPayment is sent.' ) .optional(), - /** An arbitrary string attached to the object. Often useful for displaying to users. */ + /**An arbitrary string attached to the object. Often useful for displaying to users.*/ description: z .string() .max(5000) - .nullable() .describe( 'An arbitrary string attached to the object. Often useful for displaying to users.' ) .optional(), - /** The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using `destination_payment_method_data`. */ + /**The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using `destination_payment_method_data`.*/ destination_payment_method: z .string() .max(5000) - .nullable() .describe( 'The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using `destination_payment_method_data`.' ) .optional(), - /** Details about the PaymentMethod for an OutboundPayment. */ + /**Details about the PaymentMethod for an OutboundPayment.*/ destination_payment_method_details: - OutboundPaymentsPaymentMethodDetailsSchema.nullable() - .describe('Details about the PaymentMethod for an OutboundPayment.') - .optional(), - /** Details about the end user. */ + OutboundPaymentsPaymentMethodDetailsSchema.describe( + 'Details about the PaymentMethod for an OutboundPayment.' + ).optional(), + /**Details about the end user.*/ end_user_details: - TreasuryOutboundPaymentsResourceOutboundPaymentResourceEndUserDetailsSchema.nullable() - .describe('Details about the end user.') - .optional(), - /** The date when funds are expected to arrive in the destination account. */ + TreasuryOutboundPaymentsResourceOutboundPaymentResourceEndUserDetailsSchema.describe( + 'Details about the end user.' + ).optional(), + /**The date when funds are expected to arrive in the destination account.*/ expected_arrival_date: z .number() .int() .describe( 'The date when funds are expected to arrive in the destination account.' ), - /** The FinancialAccount that funds were pulled from. */ + /**The FinancialAccount that funds were pulled from.*/ financial_account: z .string() .max(5000) .describe('The FinancialAccount that funds were pulled from.'), - /** A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. */ + /**A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.*/ hosted_regulatory_receipt_url: z .string() .max(5000) - .nullable() .describe( "A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses." ) .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('treasury.outbound_payment') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** Details about a returned OutboundPayment. Only set when the status is `returned`. */ + /**Details about a returned OutboundPayment. Only set when the status is `returned`.*/ returned_details: - TreasuryOutboundPaymentsResourceReturnedStatusSchema.nullable() - .describe( - 'Details about a returned OutboundPayment. Only set when the status is `returned`.' - ) - .optional(), - /** The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer). */ + TreasuryOutboundPaymentsResourceReturnedStatusSchema.describe( + 'Details about a returned OutboundPayment. Only set when the status is `returned`.' + ).optional(), + /**The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer).*/ statement_descriptor: z .string() .max(5000) .describe( 'The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer).' ), - /** Current status of the OutboundPayment: `processing`, `failed`, `posted`, `returned`, `canceled`. An OutboundPayment is `processing` if it has been created and is pending. The status changes to `posted` once the OutboundPayment has been "confirmed" and funds have left the account, or to `failed` or `canceled`. If an OutboundPayment fails to arrive at its destination, its status will change to `returned`. */ + /**Current status of the OutboundPayment: `processing`, `failed`, `posted`, `returned`, `canceled`. An OutboundPayment is `processing` if it has been created and is pending. The status changes to `posted` once the OutboundPayment has been "confirmed" and funds have left the account, or to `failed` or `canceled`. If an OutboundPayment fails to arrive at its destination, its status will change to `returned`.*/ status: z .enum(['canceled', 'failed', 'posted', 'processing', 'returned']) .describe( @@ -42655,14 +40389,12 @@ export namespace stripe { ), status_transitions: TreasuryOutboundPaymentsResourceOutboundPaymentResourceStatusTransitionsSchema, - /** Details about network-specific tracking information if available. */ + /**Details about network-specific tracking information if available.*/ tracking_details: - TreasuryOutboundPaymentsResourceOutboundPaymentResourceTrackingDetailsSchema.nullable() - .describe( - 'Details about network-specific tracking information if available.' - ) - .optional(), - /** The Transaction associated with this object. */ + TreasuryOutboundPaymentsResourceOutboundPaymentResourceTrackingDetailsSchema.describe( + 'Details about network-specific tracking information if available.' + ).optional(), + /**The Transaction associated with this object.*/ transaction: z .union([z.string().max(5000), TreasuryTransactionSchema]) .describe('The Transaction associated with this object.') @@ -42675,7 +40407,7 @@ export namespace stripe { > export const TreasuryOutboundPaymentsResourceReturnedStatusSchema = z.object({ - /** Reason for the return. */ + /**Reason for the return.*/ code: z .enum([ 'account_closed', @@ -42690,7 +40422,7 @@ export namespace stripe { 'other' ]) .describe('Reason for the return.'), - /** The Transaction associated with this object. */ + /**The Transaction associated with this object.*/ transaction: z .union([z.string().max(5000), TreasuryTransactionSchema]) .describe('The Transaction associated with this object.') @@ -42708,103 +40440,98 @@ export namespace stripe { */ export const TreasuryOutboundTransferSchema = z .object({ - /** Amount (in cents) transferred. */ + /**Amount (in cents) transferred.*/ amount: z.number().int().describe('Amount (in cents) transferred.'), - /** Returns `true` if the object can be canceled, and `false` otherwise. */ + /**Returns `true` if the object can be canceled, and `false` otherwise.*/ cancelable: z .boolean() .describe( 'Returns `true` if the object can be canceled, and `false` otherwise.' ), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** An arbitrary string attached to the object. Often useful for displaying to users. */ + /**An arbitrary string attached to the object. Often useful for displaying to users.*/ description: z .string() .max(5000) - .nullable() .describe( 'An arbitrary string attached to the object. Often useful for displaying to users.' ) .optional(), - /** The PaymentMethod used as the payment instrument for an OutboundTransfer. */ + /**The PaymentMethod used as the payment instrument for an OutboundTransfer.*/ destination_payment_method: z .string() .max(5000) - .nullable() .describe( 'The PaymentMethod used as the payment instrument for an OutboundTransfer.' ) .optional(), destination_payment_method_details: OutboundTransfersPaymentMethodDetailsSchema, - /** The date when funds are expected to arrive in the destination account. */ + /**The date when funds are expected to arrive in the destination account.*/ expected_arrival_date: z .number() .int() .describe( 'The date when funds are expected to arrive in the destination account.' ), - /** The FinancialAccount that funds were pulled from. */ + /**The FinancialAccount that funds were pulled from.*/ financial_account: z .string() .max(5000) .describe('The FinancialAccount that funds were pulled from.'), - /** A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. */ + /**A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.*/ hosted_regulatory_receipt_url: z .string() .max(5000) - .nullable() .describe( "A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses." ) .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('treasury.outbound_transfer') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** Details about a returned OutboundTransfer. Only set when the status is `returned`. */ + /**Details about a returned OutboundTransfer. Only set when the status is `returned`.*/ returned_details: - TreasuryOutboundTransfersResourceReturnedDetailsSchema.nullable() - .describe( - 'Details about a returned OutboundTransfer. Only set when the status is `returned`.' - ) - .optional(), - /** Information about the OutboundTransfer to be sent to the recipient account. */ + TreasuryOutboundTransfersResourceReturnedDetailsSchema.describe( + 'Details about a returned OutboundTransfer. Only set when the status is `returned`.' + ).optional(), + /**Information about the OutboundTransfer to be sent to the recipient account.*/ statement_descriptor: z .string() .max(5000) .describe( 'Information about the OutboundTransfer to be sent to the recipient account.' ), - /** Current status of the OutboundTransfer: `processing`, `failed`, `canceled`, `posted`, `returned`. An OutboundTransfer is `processing` if it has been created and is pending. The status changes to `posted` once the OutboundTransfer has been "confirmed" and funds have left the account, or to `failed` or `canceled`. If an OutboundTransfer fails to arrive at its destination, its status will change to `returned`. */ + /**Current status of the OutboundTransfer: `processing`, `failed`, `canceled`, `posted`, `returned`. An OutboundTransfer is `processing` if it has been created and is pending. The status changes to `posted` once the OutboundTransfer has been "confirmed" and funds have left the account, or to `failed` or `canceled`. If an OutboundTransfer fails to arrive at its destination, its status will change to `returned`.*/ status: z .enum(['canceled', 'failed', 'posted', 'processing', 'returned']) .describe( @@ -42812,14 +40539,12 @@ export namespace stripe { ), status_transitions: TreasuryOutboundTransfersResourceStatusTransitionsSchema, - /** Details about network-specific tracking information if available. */ + /**Details about network-specific tracking information if available.*/ tracking_details: - TreasuryOutboundTransfersResourceOutboundTransferResourceTrackingDetailsSchema.nullable() - .describe( - 'Details about network-specific tracking information if available.' - ) - .optional(), - /** The Transaction associated with this object. */ + TreasuryOutboundTransfersResourceOutboundTransferResourceTrackingDetailsSchema.describe( + 'Details about network-specific tracking information if available.' + ).optional(), + /**The Transaction associated with this object.*/ transaction: z .union([z.string().max(5000), TreasuryTransactionSchema]) .describe('The Transaction associated with this object.') @@ -42833,7 +40558,7 @@ export namespace stripe { export const TreasuryOutboundTransfersResourceReturnedDetailsSchema = z.object({ - /** Reason for the return. */ + /**Reason for the return.*/ code: z .enum([ 'account_closed', @@ -42848,7 +40573,7 @@ export namespace stripe { 'other' ]) .describe('Reason for the return.'), - /** The Transaction associated with this object. */ + /**The Transaction associated with this object.*/ transaction: z .union([z.string().max(5000), TreasuryTransactionSchema]) .describe('The Transaction associated with this object.') @@ -42857,32 +40582,32 @@ export namespace stripe { typeof TreasuryOutboundTransfersResourceReturnedDetailsSchema > - /** ReceivedCredits represent funds sent to a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount. */ + /**ReceivedCredits represent funds sent to a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount.*/ export const TreasuryReceivedCreditSchema = z .object({ - /** Amount (in cents) transferred. */ + /**Amount (in cents) transferred.*/ amount: z.number().int().describe('Amount (in cents) transferred.'), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** An arbitrary string attached to the object. Often useful for displaying to users. */ + /**An arbitrary string attached to the object. Often useful for displaying to users.*/ description: z .string() .max(5000) .describe( 'An arbitrary string attached to the object. Often useful for displaying to users.' ), - /** Reason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen. */ + /**Reason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen.*/ failure_code: z .enum([ 'account_closed', @@ -42890,63 +40615,59 @@ export namespace stripe { 'international_transaction', 'other' ]) - .nullable() .describe( 'Reason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen.' ) .optional(), - /** The FinancialAccount that received the funds. */ + /**The FinancialAccount that received the funds.*/ financial_account: z .string() .max(5000) - .nullable() .describe('The FinancialAccount that received the funds.') .optional(), - /** A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. */ + /**A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.*/ hosted_regulatory_receipt_url: z .string() .max(5000) - .nullable() .describe( "A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses." ) .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), initiating_payment_method_details: TreasurySharedResourceInitiatingPaymentMethodDetailsInitiatingPaymentMethodDetailsSchema, linked_flows: TreasuryReceivedCreditsResourceLinkedFlowsSchema, - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** The rails used to send the funds. */ + /**The rails used to send the funds.*/ network: z .enum(['ach', 'card', 'stripe', 'us_domestic_wire']) .describe('The rails used to send the funds.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('treasury.received_credit') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** Details describing when a ReceivedCredit may be reversed. */ + /**Details describing when a ReceivedCredit may be reversed.*/ reversal_details: - TreasuryReceivedCreditsResourceReversalDetailsSchema.nullable() - .describe('Details describing when a ReceivedCredit may be reversed.') - .optional(), - /** Status of the ReceivedCredit. ReceivedCredits are created either `succeeded` (approved) or `failed` (declined). If a ReceivedCredit is declined, the failure reason can be found in the `failure_code` field. */ + TreasuryReceivedCreditsResourceReversalDetailsSchema.describe( + 'Details describing when a ReceivedCredit may be reversed.' + ).optional(), + /**Status of the ReceivedCredit. ReceivedCredits are created either `succeeded` (approved) or `failed` (declined). If a ReceivedCredit is declined, the failure reason can be found in the `failure_code` field.*/ status: z .enum(['failed', 'succeeded']) .describe( 'Status of the ReceivedCredit. ReceivedCredits are created either `succeeded` (approved) or `failed` (declined). If a ReceivedCredit is declined, the failure reason can be found in the `failure_code` field.' ), - /** The Transaction associated with this object. */ + /**The Transaction associated with this object.*/ transaction: z .union([z.string().max(5000), TreasuryTransactionSchema]) - .nullable() .describe('The Transaction associated with this object.') .optional() }) @@ -42958,52 +40679,47 @@ export namespace stripe { > export const TreasuryReceivedCreditsResourceLinkedFlowsSchema = z.object({ - /** The CreditReversal created as a result of this ReceivedCredit being reversed. */ + /**The CreditReversal created as a result of this ReceivedCredit being reversed.*/ credit_reversal: z .string() .max(5000) - .nullable() .describe( 'The CreditReversal created as a result of this ReceivedCredit being reversed.' ) .optional(), - /** Set if the ReceivedCredit was created due to an [Issuing Authorization](https://stripe.com/docs/api#issuing_authorizations) object. */ + /**Set if the ReceivedCredit was created due to an [Issuing Authorization](https://stripe.com/docs/api#issuing_authorizations) object.*/ issuing_authorization: z .string() .max(5000) - .nullable() .describe( 'Set if the ReceivedCredit was created due to an [Issuing Authorization](https://stripe.com/docs/api#issuing_authorizations) object.' ) .optional(), - /** Set if the ReceivedCredit is also viewable as an [Issuing transaction](https://stripe.com/docs/api#issuing_transactions) object. */ + /**Set if the ReceivedCredit is also viewable as an [Issuing transaction](https://stripe.com/docs/api#issuing_transactions) object.*/ issuing_transaction: z .string() .max(5000) - .nullable() .describe( 'Set if the ReceivedCredit is also viewable as an [Issuing transaction](https://stripe.com/docs/api#issuing_transactions) object.' ) .optional(), - /** ID of the source flow. Set if `network` is `stripe` and the source flow is visible to the user. Examples of source flows include OutboundPayments, payouts, or CreditReversals. */ + /**ID of the source flow. Set if `network` is `stripe` and the source flow is visible to the user. Examples of source flows include OutboundPayments, payouts, or CreditReversals.*/ source_flow: z .string() .max(5000) - .nullable() .describe( 'ID of the source flow. Set if `network` is `stripe` and the source flow is visible to the user. Examples of source flows include OutboundPayments, payouts, or CreditReversals.' ) .optional(), - /** The expandable object of the source flow. */ + /**The expandable object of the source flow.*/ source_flow_details: - TreasuryReceivedCreditsResourceSourceFlowsDetailsSchema.nullable() - .describe('The expandable object of the source flow.') - .optional(), - /** The type of flow that originated the ReceivedCredit (for example, `outbound_payment`). */ + TreasuryReceivedCreditsResourceSourceFlowsDetailsSchema.describe( + 'The expandable object of the source flow.' + ).optional(), + /**The type of flow that originated the ReceivedCredit (for example, `outbound_payment`).*/ source_flow_type: z .string() .max(5000) - .nullable() .describe( 'The type of flow that originated the ReceivedCredit (for example, `outbound_payment`).' ) @@ -43019,7 +40735,7 @@ export namespace stripe { outbound_payment: TreasuryOutboundPaymentSchema.optional(), outbound_transfer: TreasuryOutboundTransferSchema.optional(), payout: PayoutSchema.optional(), - /** The type of the source flow that originated the ReceivedCredit. */ + /**The type of the source flow that originated the ReceivedCredit.*/ type: z .enum([ 'credit_reversal', @@ -43036,32 +40752,32 @@ export namespace stripe { typeof TreasuryReceivedCreditsResourceSourceFlowsDetailsSchema > - /** ReceivedDebits represent funds pulled from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts). These are not initiated from the FinancialAccount. */ + /**ReceivedDebits represent funds pulled from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts). These are not initiated from the FinancialAccount.*/ export const TreasuryReceivedDebitSchema = z .object({ - /** Amount (in cents) transferred. */ + /**Amount (in cents) transferred.*/ amount: z.number().int().describe('Amount (in cents) transferred.'), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ), - /** An arbitrary string attached to the object. Often useful for displaying to users. */ + /**An arbitrary string attached to the object. Often useful for displaying to users.*/ description: z .string() .max(5000) .describe( 'An arbitrary string attached to the object. Often useful for displaying to users.' ), - /** Reason for the failure. A ReceivedDebit might fail because the FinancialAccount doesn't have sufficient funds, is closed, or is frozen. */ + /**Reason for the failure. A ReceivedDebit might fail because the FinancialAccount doesn't have sufficient funds, is closed, or is frozen.*/ failure_code: z .enum([ 'account_closed', @@ -43070,65 +40786,59 @@ export namespace stripe { 'international_transaction', 'other' ]) - .nullable() .describe( "Reason for the failure. A ReceivedDebit might fail because the FinancialAccount doesn't have sufficient funds, is closed, or is frozen." ) .optional(), - /** The FinancialAccount that funds were pulled from. */ + /**The FinancialAccount that funds were pulled from.*/ financial_account: z .string() .max(5000) - .nullable() .describe('The FinancialAccount that funds were pulled from.') .optional(), - /** A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. */ + /**A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.*/ hosted_regulatory_receipt_url: z .string() .max(5000) - .nullable() .describe( "A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses." ) .optional(), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), initiating_payment_method_details: TreasurySharedResourceInitiatingPaymentMethodDetailsInitiatingPaymentMethodDetailsSchema.optional(), linked_flows: TreasuryReceivedDebitsResourceLinkedFlowsSchema, - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** The network used for the ReceivedDebit. */ + /**The network used for the ReceivedDebit.*/ network: z .enum(['ach', 'card', 'stripe']) .describe('The network used for the ReceivedDebit.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('treasury.received_debit') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** Details describing when a ReceivedDebit might be reversed. */ + /**Details describing when a ReceivedDebit might be reversed.*/ reversal_details: - TreasuryReceivedDebitsResourceReversalDetailsSchema.nullable() - .describe( - 'Details describing when a ReceivedDebit might be reversed.' - ) - .optional(), - /** Status of the ReceivedDebit. ReceivedDebits are created with a status of either `succeeded` (approved) or `failed` (declined). The failure reason can be found under the `failure_code`. */ + TreasuryReceivedDebitsResourceReversalDetailsSchema.describe( + 'Details describing when a ReceivedDebit might be reversed.' + ).optional(), + /**Status of the ReceivedDebit. ReceivedDebits are created with a status of either `succeeded` (approved) or `failed` (declined). The failure reason can be found under the `failure_code`.*/ status: z .enum(['failed', 'succeeded']) .describe( 'Status of the ReceivedDebit. ReceivedDebits are created with a status of either `succeeded` (approved) or `failed` (declined). The failure reason can be found under the `failure_code`.' ), - /** The Transaction associated with this object. */ + /**The Transaction associated with this object.*/ transaction: z .union([z.string().max(5000), TreasuryTransactionSchema]) - .nullable() .describe('The Transaction associated with this object.') .optional() }) @@ -43157,54 +40867,45 @@ export namespace stripe { */ export const CheckoutSessionSchema = z .object({ - /** Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing). */ + /**Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).*/ adaptive_pricing: - PaymentPagesCheckoutSessionAdaptivePricingSchema.nullable() - .describe( - 'Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).' - ) - .optional(), - /** When set, provides configuration for actions to take if this Checkout Session expires. */ + PaymentPagesCheckoutSessionAdaptivePricingSchema.describe( + 'Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).' + ).optional(), + /**When set, provides configuration for actions to take if this Checkout Session expires.*/ after_expiration: - PaymentPagesCheckoutSessionAfterExpirationSchema.nullable() - .describe( - 'When set, provides configuration for actions to take if this Checkout Session expires.' - ) - .optional(), - /** Enables user redeemable promotion codes. */ + PaymentPagesCheckoutSessionAfterExpirationSchema.describe( + 'When set, provides configuration for actions to take if this Checkout Session expires.' + ).optional(), + /**Enables user redeemable promotion codes.*/ allow_promotion_codes: z .boolean() - .nullable() .describe('Enables user redeemable promotion codes.') .optional(), - /** Total of all items before discounts or taxes are applied. */ + /**Total of all items before discounts or taxes are applied.*/ amount_subtotal: z .number() .int() - .nullable() .describe('Total of all items before discounts or taxes are applied.') .optional(), - /** Total of all items after discounts and taxes are applied. */ + /**Total of all items after discounts and taxes are applied.*/ amount_total: z .number() .int() - .nullable() .describe('Total of all items after discounts and taxes are applied.') .optional(), automatic_tax: PaymentPagesCheckoutSessionAutomaticTaxSchema, - /** Describes whether Checkout should collect the customer's billing address. Defaults to `auto`. */ + /**Describes whether Checkout should collect the customer's billing address. Defaults to `auto`.*/ billing_address_collection: z .enum(['auto', 'required']) - .nullable() .describe( "Describes whether Checkout should collect the customer's billing address. Defaults to `auto`." ) .optional(), - /** If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. */ + /**If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.*/ cancel_url: z .string() .max(5000) - .nullable() .describe( 'If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.' ) @@ -43217,61 +40918,52 @@ export namespace stripe { client_reference_id: z .string() .max(5000) - .nullable() .describe( 'A unique string to reference the Checkout Session. This can be a\ncustomer ID, a cart ID, or similar, and can be used to reconcile the\nSession with your internal systems.' ) .optional(), - /** Client secret to be used when initializing Stripe.js embedded checkout. */ + /**Client secret to be used when initializing Stripe.js embedded checkout.*/ client_secret: z .string() .max(5000) - .nullable() .describe( 'Client secret to be used when initializing Stripe.js embedded checkout.' ) .optional(), - /** Information about the customer collected within the Checkout Session. */ + /**Information about the customer collected within the Checkout Session.*/ collected_information: - PaymentPagesCheckoutSessionCollectedInformationSchema.nullable() - .describe( - 'Information about the customer collected within the Checkout Session.' - ) - .optional(), - /** Results of `consent_collection` for this session. */ - consent: PaymentPagesCheckoutSessionConsentSchema.nullable() - .describe('Results of `consent_collection` for this session.') - .optional(), - /** When set, provides configuration for the Checkout Session to gather active consent from customers. */ + PaymentPagesCheckoutSessionCollectedInformationSchema.describe( + 'Information about the customer collected within the Checkout Session.' + ).optional(), + /**Results of `consent_collection` for this session.*/ + consent: PaymentPagesCheckoutSessionConsentSchema.describe( + 'Results of `consent_collection` for this session.' + ).optional(), + /**When set, provides configuration for the Checkout Session to gather active consent from customers.*/ consent_collection: - PaymentPagesCheckoutSessionConsentCollectionSchema.nullable() - .describe( - 'When set, provides configuration for the Checkout Session to gather active consent from customers.' - ) - .optional(), - /** Time at which the object was created. Measured in seconds since the Unix epoch. */ + PaymentPagesCheckoutSessionConsentCollectionSchema.describe( + 'When set, provides configuration for the Checkout Session to gather active consent from customers.' + ).optional(), + /**Time at which the object was created. Measured in seconds since the Unix epoch.*/ created: z .number() .int() .describe( 'Time at which the object was created. Measured in seconds since the Unix epoch.' ), - /** Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() - .nullable() .describe( 'Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ) .optional(), - /** Currency conversion details for [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing) sessions */ + /**Currency conversion details for [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing) sessions*/ currency_conversion: - PaymentPagesCheckoutSessionCurrencyConversionSchema.nullable() - .describe( - 'Currency conversion details for [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing) sessions' - ) - .optional(), - /** Collect additional information from your customer using custom fields. Up to 3 fields are supported. */ + PaymentPagesCheckoutSessionCurrencyConversionSchema.describe( + 'Currency conversion details for [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing) sessions' + ).optional(), + /**Collect additional information from your customer using custom fields. Up to 3 fields are supported.*/ custom_fields: z .array(PaymentPagesCheckoutSessionCustomFieldsSchema) .describe( @@ -43287,26 +40979,22 @@ export namespace stripe { */ customer: z .union([z.string().max(5000), CustomerSchema, DeletedCustomerSchema]) - .nullable() .describe( 'The ID of the customer for this Session.\nFor Checkout Sessions in `subscription` mode or Checkout Sessions with `customer_creation` set as `always` in `payment` mode, Checkout\nwill create a new customer object based on information provided\nduring the payment flow unless an existing customer was provided when\nthe Session was created.' ) .optional(), - /** Configure whether a Checkout Session creates a Customer when the Checkout Session completes. */ + /**Configure whether a Checkout Session creates a Customer when the Checkout Session completes.*/ customer_creation: z .enum(['always', 'if_required']) - .nullable() .describe( 'Configure whether a Checkout Session creates a Customer when the Checkout Session completes.' ) .optional(), - /** The customer details including the customer's tax exempt status and the customer's tax IDs. Customer's address details are not present on Sessions in `setup` mode. */ + /**The customer details including the customer's tax exempt status and the customer's tax IDs. Customer's address details are not present on Sessions in `setup` mode.*/ customer_details: - PaymentPagesCheckoutSessionCustomerDetailsSchema.nullable() - .describe( - "The customer details including the customer's tax exempt status and the customer's tax IDs. Customer's address details are not present on Sessions in `setup` mode." - ) - .optional(), + PaymentPagesCheckoutSessionCustomerDetailsSchema.describe( + "The customer details including the customer's tax exempt status and the customer's tax IDs. Customer's address details are not present on Sessions in `setup` mode." + ).optional(), /** * If provided, this value will be used when the Customer object is created. * If not provided, customers will be asked to enter their email address. @@ -43317,59 +41005,54 @@ export namespace stripe { customer_email: z .string() .max(5000) - .nullable() .describe( 'If provided, this value will be used when the Customer object is created.\nIf not provided, customers will be asked to enter their email address.\nUse this parameter to prefill customer data if you already have an email\non file. To access information about the customer once the payment flow is\ncomplete, use the `customer` attribute.' ) .optional(), - /** List of coupons and promotion codes attached to the Checkout Session. */ + /**List of coupons and promotion codes attached to the Checkout Session.*/ discounts: z .array(PaymentPagesCheckoutSessionDiscountSchema) - .nullable() .describe( 'List of coupons and promotion codes attached to the Checkout Session.' ) .optional(), - /** The timestamp at which the Checkout Session will expire. */ + /**The timestamp at which the Checkout Session will expire.*/ expires_at: z .number() .int() .describe('The timestamp at which the Checkout Session will expire.'), - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** ID of the invoice created by the Checkout Session, if it exists. */ + /**ID of the invoice created by the Checkout Session, if it exists.*/ invoice: z .union([z.string().max(5000), InvoiceSchema]) - .nullable() .describe( 'ID of the invoice created by the Checkout Session, if it exists.' ) .optional(), - /** Details on the state of invoice creation for the Checkout Session. */ + /**Details on the state of invoice creation for the Checkout Session.*/ invoice_creation: - PaymentPagesCheckoutSessionInvoiceCreationSchema.nullable() - .describe( - 'Details on the state of invoice creation for the Checkout Session.' - ) - .optional(), - /** The line items purchased by the customer. */ + PaymentPagesCheckoutSessionInvoiceCreationSchema.describe( + 'Details on the state of invoice creation for the Checkout Session.' + ).optional(), + /**The line items purchased by the customer.*/ line_items: z .object({ - /** Details about each object. */ + /**Details about each object.*/ data: z.array(ItemSchema).describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -43377,13 +41060,13 @@ export namespace stripe { }) .describe('The line items purchased by the customer.') .optional(), - /** Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + /**Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.*/ livemode: z .boolean() .describe( 'Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.' ), - /** The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used. */ + /**The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.*/ locale: z .enum([ 'auto', @@ -43428,65 +41111,56 @@ export namespace stripe { 'zh-HK', 'zh-TW' ]) - .nullable() .describe( "The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used." ) .optional(), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.*/ metadata: z .record(z.string().max(500)) - .nullable() .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.' ) .optional(), - /** The mode of the Checkout Session. */ + /**The mode of the Checkout Session.*/ mode: z .enum(['payment', 'setup', 'subscription']) .describe('The mode of the Checkout Session.'), - /** String representing the object's type. Objects of the same type share the same value. */ + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('checkout.session') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The ID of the PaymentIntent for Checkout Sessions in `payment` mode. You can't confirm or cancel the PaymentIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead. */ + /**The ID of the PaymentIntent for Checkout Sessions in `payment` mode. You can't confirm or cancel the PaymentIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.*/ payment_intent: z .union([z.string().max(5000), PaymentIntentSchema]) - .nullable() .describe( "The ID of the PaymentIntent for Checkout Sessions in `payment` mode. You can't confirm or cancel the PaymentIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead." ) .optional(), - /** The ID of the Payment Link that created this Session. */ + /**The ID of the Payment Link that created this Session.*/ payment_link: z .union([z.string().max(5000), PaymentLinkSchema]) - .nullable() .describe('The ID of the Payment Link that created this Session.') .optional(), - /** Configure whether a Checkout Session should collect a payment method. Defaults to `always`. */ + /**Configure whether a Checkout Session should collect a payment method. Defaults to `always`.*/ payment_method_collection: z .enum(['always', 'if_required']) - .nullable() .describe( 'Configure whether a Checkout Session should collect a payment method. Defaults to `always`.' ) .optional(), - /** Information about the payment method configuration used for this Checkout session if using dynamic payment methods. */ + /**Information about the payment method configuration used for this Checkout session if using dynamic payment methods.*/ payment_method_configuration_details: - PaymentMethodConfigBizPaymentMethodConfigurationDetailsSchema.nullable() - .describe( - 'Information about the payment method configuration used for this Checkout session if using dynamic payment methods.' - ) - .optional(), - /** Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession. */ + PaymentMethodConfigBizPaymentMethodConfigurationDetailsSchema.describe( + 'Information about the payment method configuration used for this Checkout session if using dynamic payment methods.' + ).optional(), + /**Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession.*/ payment_method_options: - CheckoutSessionPaymentMethodOptionsSchema.nullable() - .describe( - 'Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession.' - ) - .optional(), + CheckoutSessionPaymentMethodOptionsSchema.describe( + 'Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession.' + ).optional(), /** * A list of the types of payment methods (e.g. card) this Checkout * Session is allowed to accept. @@ -43507,23 +41181,22 @@ export namespace stripe { ), phone_number_collection: PaymentPagesCheckoutSessionPhoneNumberCollectionSchema.optional(), - /** The ID of the original expired Checkout Session that triggered the recovery flow. */ + /**The ID of the original expired Checkout Session that triggered the recovery flow.*/ recovered_from: z .string() .max(5000) - .nullable() .describe( 'The ID of the original expired Checkout Session that triggered the recovery flow.' ) .optional(), - /** This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`. */ + /**This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.*/ redirect_on_completion: z .enum(['always', 'if_required', 'never']) .describe( 'This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.' ) .optional(), - /** Applies to Checkout Sessions with `ui_mode: embedded`. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. */ + /**Applies to Checkout Sessions with `ui_mode: embedded`. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.*/ return_url: z .string() .max(5000) @@ -43531,46 +41204,38 @@ export namespace stripe { "Applies to Checkout Sessions with `ui_mode: embedded`. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site." ) .optional(), - /** Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode. */ + /**Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.*/ saved_payment_method_options: - PaymentPagesCheckoutSessionSavedPaymentMethodOptionsSchema.nullable() - .describe( - 'Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.' - ) - .optional(), - /** The ID of the SetupIntent for Checkout Sessions in `setup` mode. You can't confirm or cancel the SetupIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead. */ + PaymentPagesCheckoutSessionSavedPaymentMethodOptionsSchema.describe( + 'Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.' + ).optional(), + /**The ID of the SetupIntent for Checkout Sessions in `setup` mode. You can't confirm or cancel the SetupIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead.*/ setup_intent: z .union([z.string().max(5000), SetupIntentSchema]) - .nullable() .describe( "The ID of the SetupIntent for Checkout Sessions in `setup` mode. You can't confirm or cancel the SetupIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead." ) .optional(), - /** When set, provides configuration for Checkout to collect a shipping address from a customer. */ + /**When set, provides configuration for Checkout to collect a shipping address from a customer.*/ shipping_address_collection: - PaymentPagesCheckoutSessionShippingAddressCollectionSchema.nullable() - .describe( - 'When set, provides configuration for Checkout to collect a shipping address from a customer.' - ) - .optional(), - /** The details of the customer cost of shipping, including the customer chosen ShippingRate. */ - shipping_cost: PaymentPagesCheckoutSessionShippingCostSchema.nullable() - .describe( - 'The details of the customer cost of shipping, including the customer chosen ShippingRate.' - ) - .optional(), - /** Shipping information for this Checkout Session. */ - shipping_details: ShippingSchema.nullable() - .describe('Shipping information for this Checkout Session.') - .optional(), - /** The shipping rate options applied to this Session. */ + PaymentPagesCheckoutSessionShippingAddressCollectionSchema.describe( + 'When set, provides configuration for Checkout to collect a shipping address from a customer.' + ).optional(), + /**The details of the customer cost of shipping, including the customer chosen ShippingRate.*/ + shipping_cost: PaymentPagesCheckoutSessionShippingCostSchema.describe( + 'The details of the customer cost of shipping, including the customer chosen ShippingRate.' + ).optional(), + /**Shipping information for this Checkout Session.*/ + shipping_details: ShippingSchema.describe( + 'Shipping information for this Checkout Session.' + ).optional(), + /**The shipping rate options applied to this Session.*/ shipping_options: z .array(PaymentPagesCheckoutSessionShippingOptionSchema) .describe('The shipping rate options applied to this Session.'), - /** The status of the Checkout Session, one of `open`, `complete`, or `expired`. */ + /**The status of the Checkout Session, one of `open`, `complete`, or `expired`.*/ status: z .enum(['complete', 'expired', 'open']) - .nullable() .describe( 'The status of the Checkout Session, one of `open`, `complete`, or `expired`.' ) @@ -43582,15 +41247,13 @@ export namespace stripe { */ submit_type: z .enum(['auto', 'book', 'donate', 'pay', 'subscribe']) - .nullable() .describe( 'Describes the type of transaction being performed by Checkout in order to customize\nrelevant text on the page, such as the submit button. `submit_type` can only be\nspecified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used.' ) .optional(), - /** The ID of the subscription for Checkout Sessions in `subscription` mode. */ + /**The ID of the subscription for Checkout Sessions in `subscription` mode.*/ subscription: z .union([z.string().max(5000), SubscriptionSchema]) - .nullable() .describe( 'The ID of the subscription for Checkout Sessions in `subscription` mode.' ) @@ -43602,21 +41265,19 @@ export namespace stripe { success_url: z .string() .max(5000) - .nullable() .describe( 'The URL the customer will be directed to after the payment or\nsubscription creation is successful.' ) .optional(), tax_id_collection: PaymentPagesCheckoutSessionTaxIdCollectionSchema.optional(), - /** Tax and discount details for the computed total amount. */ - total_details: PaymentPagesCheckoutSessionTotalDetailsSchema.nullable() - .describe('Tax and discount details for the computed total amount.') - .optional(), - /** The UI mode of the Session. Defaults to `hosted`. */ + /**Tax and discount details for the computed total amount.*/ + total_details: PaymentPagesCheckoutSessionTotalDetailsSchema.describe( + 'Tax and discount details for the computed total amount.' + ).optional(), + /**The UI mode of the Session. Defaults to `hosted`.*/ ui_mode: z .enum(['embedded', 'hosted']) - .nullable() .describe('The UI mode of the Session. Defaults to `hosted`.') .optional(), /** @@ -43626,7 +41287,6 @@ export namespace stripe { url: z .string() .max(5000) - .nullable() .describe( 'The URL to the Checkout Session. Redirect customers to this URL to take them to Checkout. If you’re using [Custom Domains](https://stripe.com/docs/payments/checkout/custom-domains), the URL will use your subdomain. Otherwise, it’ll use `checkout.stripe.com.`\nThis value is only present when the session is active.' ) @@ -43642,7 +41302,7 @@ export namespace stripe { // ----------------------------------------------------------------------------- export const GetAccountParamsSchema = z.object({ - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -43674,7 +41334,7 @@ export namespace stripe { > export const GetAccountsParamsSchema = z.object({ - /** Only return connected accounts that were created during the given date interval. */ + /**Only return connected accounts that were created during the given date interval.*/ created: z .union([ z.object({ @@ -43689,19 +41349,19 @@ export namespace stripe { 'Only return connected accounts that were created during the given date interval.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .describe( 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -43709,7 +41369,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .describe( @@ -43721,19 +41381,19 @@ export namespace stripe { export const GetAccountsResponseSchema = z.object({ data: z.array(AccountSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/accounts')) @@ -43750,7 +41410,7 @@ export namespace stripe { export const GetAccountsAccountParamsSchema = z.object({ account: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -43805,7 +41465,7 @@ export namespace stripe { export const GetAccountsAccountBankAccountsIdParamsSchema = z.object({ account: z.string().max(5000), id: z.string(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -43851,7 +41511,7 @@ export namespace stripe { export const GetAccountsAccountCapabilitiesParamsSchema = z.object({ account: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -43863,19 +41523,19 @@ export namespace stripe { export const GetAccountsAccountCapabilitiesResponseSchema = z.object({ data: z.array(CapabilitySchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -43888,7 +41548,7 @@ export namespace stripe { export const GetAccountsAccountCapabilitiesCapabilityParamsSchema = z.object({ account: z.string().max(5000), capability: z.string(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -43919,19 +41579,19 @@ export namespace stripe { export const GetAccountsAccountExternalAccountsParamsSchema = z.object({ account: z.string().max(5000), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .describe( 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -43939,14 +41599,14 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** Filter external accounts according to a particular object type. */ + /**Filter external accounts according to a particular object type.*/ object: z .enum(['bank_account', 'card']) .describe( 'Filter external accounts according to a particular object type.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .describe( @@ -43959,25 +41619,25 @@ export namespace stripe { > export const GetAccountsAccountExternalAccountsResponseSchema = z.object({ - /** The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards. */ + /**The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards.*/ data: z .array(z.union([BankAccountSchema, CardSchema])) .describe( 'The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards.' ), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -44003,7 +41663,7 @@ export namespace stripe { export const GetAccountsAccountExternalAccountsIdParamsSchema = z.object({ account: z.string().max(5000), id: z.string(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -44061,7 +41721,7 @@ export namespace stripe { export const GetAccountsAccountPeopleParamsSchema = z.object({ account: z.string().max(5000), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -44069,12 +41729,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -44082,7 +41742,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** Filters on the list of people returned based on the person's relationship to the account's company. */ + /**Filters on the list of people returned based on the person's relationship to the account's company.*/ relationship: z .object({ authorizer: z.boolean().optional(), @@ -44096,7 +41756,7 @@ export namespace stripe { "Filters on the list of people returned based on the person's relationship to the account's company." ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -44111,19 +41771,19 @@ export namespace stripe { export const GetAccountsAccountPeopleResponseSchema = z.object({ data: z.array(PersonSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -44148,7 +41808,7 @@ export namespace stripe { export const GetAccountsAccountPeoplePersonParamsSchema = z.object({ account: z.string().max(5000), person: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -44192,7 +41852,7 @@ export namespace stripe { export const GetAccountsAccountPersonsParamsSchema = z.object({ account: z.string().max(5000), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -44200,12 +41860,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -44213,7 +41873,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** Filters on the list of people returned based on the person's relationship to the account's company. */ + /**Filters on the list of people returned based on the person's relationship to the account's company.*/ relationship: z .object({ authorizer: z.boolean().optional(), @@ -44227,7 +41887,7 @@ export namespace stripe { "Filters on the list of people returned based on the person's relationship to the account's company." ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -44242,19 +41902,19 @@ export namespace stripe { export const GetAccountsAccountPersonsResponseSchema = z.object({ data: z.array(PersonSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -44279,7 +41939,7 @@ export namespace stripe { export const GetAccountsAccountPersonsPersonParamsSchema = z.object({ account: z.string().max(5000), person: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -44335,7 +41995,7 @@ export namespace stripe { export const GetApplePayDomainsParamsSchema = z.object({ domain_name: z.string().max(5000).optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -44343,12 +42003,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -44356,7 +42016,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -44371,19 +42031,19 @@ export namespace stripe { export const GetApplePayDomainsResponseSchema = z.object({ data: z.array(ApplePayDomainSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/apple_pay/domains')) @@ -44406,7 +42066,7 @@ export namespace stripe { export const GetApplePayDomainsDomainParamsSchema = z.object({ domain: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -44435,7 +42095,7 @@ export namespace stripe { > export const GetApplicationFeesParamsSchema = z.object({ - /** Only return application fees for the charge specified by this charge ID. */ + /**Only return application fees for the charge specified by this charge ID.*/ charge: z .string() .max(5000) @@ -44443,7 +42103,7 @@ export namespace stripe { 'Only return application fees for the charge specified by this charge ID.' ) .optional(), - /** Only return applications fees that were created during the given date interval. */ + /**Only return applications fees that were created during the given date interval.*/ created: z .union([ z.object({ @@ -44458,7 +42118,7 @@ export namespace stripe { 'Only return applications fees that were created during the given date interval.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -44466,12 +42126,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -44479,7 +42139,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -44494,19 +42154,19 @@ export namespace stripe { export const GetApplicationFeesResponseSchema = z.object({ data: z.array(ApplicationFeeSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/application_fees')) @@ -44520,7 +42180,7 @@ export namespace stripe { export const GetApplicationFeesFeeRefundsIdParamsSchema = z.object({ fee: z.string().max(5000), id: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -44550,7 +42210,7 @@ export namespace stripe { export const GetApplicationFeesIdParamsSchema = z.object({ id: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -44579,7 +42239,7 @@ export namespace stripe { export const GetApplicationFeesIdRefundsParamsSchema = z.object({ id: z.string().max(5000), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -44587,12 +42247,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -44600,7 +42260,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -44614,21 +42274,21 @@ export namespace stripe { > export const GetApplicationFeesIdRefundsResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z.array(FeeRefundSchema).describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -44651,7 +42311,7 @@ export namespace stripe { > export const GetAppsSecretsParamsSchema = z.object({ - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -44659,12 +42319,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -44672,7 +42332,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user. */ + /**Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.*/ scope: z .object({ type: z.enum(['account', 'user']), @@ -44681,7 +42341,7 @@ export namespace stripe { .describe( 'Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.' ), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -44694,19 +42354,19 @@ export namespace stripe { export const GetAppsSecretsResponseSchema = z.object({ data: z.array(AppsSecretSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/apps/secrets')) @@ -44738,17 +42398,17 @@ export namespace stripe { > export const GetAppsSecretsFindParamsSchema = z.object({ - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A name for the secret that's unique within the scope. */ + /**A name for the secret that's unique within the scope.*/ name: z .string() .max(5000) .describe("A name for the secret that's unique within the scope."), - /** Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user. */ + /**Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.*/ scope: z .object({ type: z.enum(['account', 'user']), @@ -44768,7 +42428,7 @@ export namespace stripe { > export const GetBalanceParamsSchema = z.object({ - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -44780,7 +42440,7 @@ export namespace stripe { export type GetBalanceResponse = z.infer export const GetBalanceHistoryParamsSchema = z.object({ - /** Only return transactions that were created during the given date interval. */ + /**Only return transactions that were created during the given date interval.*/ created: z .union([ z.object({ @@ -44795,14 +42455,14 @@ export namespace stripe { 'Only return transactions that were created during the given date interval.' ) .optional(), - /** Only return transactions in a certain currency. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Only return transactions in a certain currency. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Only return transactions in a certain currency. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -44810,12 +42470,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -44823,7 +42483,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID. */ + /**For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.*/ payout: z .string() .max(5000) @@ -44831,13 +42491,13 @@ export namespace stripe { 'For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.' ) .optional(), - /** Only returns the original transaction. */ + /**Only returns the original transaction.*/ source: z .string() .max(5000) .describe('Only returns the original transaction.') .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -44845,7 +42505,7 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. */ + /**Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`.*/ type: z .string() .max(5000) @@ -44860,19 +42520,19 @@ export namespace stripe { export const GetBalanceHistoryResponseSchema = z.object({ data: z.array(BalanceTransactionSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/balance_transactions')) @@ -44885,7 +42545,7 @@ export namespace stripe { export const GetBalanceHistoryIdParamsSchema = z.object({ id: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -44901,7 +42561,7 @@ export namespace stripe { > export const GetBalanceTransactionsParamsSchema = z.object({ - /** Only return transactions that were created during the given date interval. */ + /**Only return transactions that were created during the given date interval.*/ created: z .union([ z.object({ @@ -44916,14 +42576,14 @@ export namespace stripe { 'Only return transactions that were created during the given date interval.' ) .optional(), - /** Only return transactions in a certain currency. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + /**Only return transactions in a certain currency. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).*/ currency: z .string() .describe( 'Only return transactions in a certain currency. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -44931,12 +42591,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -44944,7 +42604,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID. */ + /**For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.*/ payout: z .string() .max(5000) @@ -44952,13 +42612,13 @@ export namespace stripe { 'For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.' ) .optional(), - /** Only returns the original transaction. */ + /**Only returns the original transaction.*/ source: z .string() .max(5000) .describe('Only returns the original transaction.') .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -44966,7 +42626,7 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. */ + /**Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`.*/ type: z .string() .max(5000) @@ -44981,19 +42641,19 @@ export namespace stripe { export const GetBalanceTransactionsResponseSchema = z.object({ data: z.array(BalanceTransactionSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/balance_transactions')) @@ -45006,7 +42666,7 @@ export namespace stripe { export const GetBalanceTransactionsIdParamsSchema = z.object({ id: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -45022,12 +42682,12 @@ export namespace stripe { > export const GetBillingAlertsParamsSchema = z.object({ - /** Filter results to only include this type of alert. */ + /**Filter results to only include this type of alert.*/ alert_type: z .literal('usage_threshold') .describe('Filter results to only include this type of alert.') .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -45035,12 +42695,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -45048,13 +42708,13 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** Filter results to only include alerts with the given meter. */ + /**Filter results to only include alerts with the given meter.*/ meter: z .string() .max(5000) .describe('Filter results to only include alerts with the given meter.') .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -45069,19 +42729,19 @@ export namespace stripe { export const GetBillingAlertsResponseSchema = z.object({ data: z.array(BillingAlertSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/billing/alerts')) @@ -45104,7 +42764,7 @@ export namespace stripe { export const GetBillingAlertsIdParamsSchema = z.object({ id: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -45156,17 +42816,17 @@ export namespace stripe { > export const GetBillingCreditBalanceSummaryParamsSchema = z.object({ - /** The customer for which to fetch credit balance summary. */ + /**The customer for which to fetch credit balance summary.*/ customer: z .string() .max(5000) .describe('The customer for which to fetch credit balance summary.'), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** The filter criteria for the credit balance summary. */ + /**The filter criteria for the credit balance summary.*/ filter: z .object({ applicability_scope: z @@ -45191,7 +42851,7 @@ export namespace stripe { > export const GetBillingCreditBalanceTransactionsParamsSchema = z.object({ - /** The credit grant for which to fetch credit balance transactions. */ + /**The credit grant for which to fetch credit balance transactions.*/ credit_grant: z .string() .max(5000) @@ -45199,12 +42859,12 @@ export namespace stripe { 'The credit grant for which to fetch credit balance transactions.' ) .optional(), - /** The customer for which to fetch credit balance transactions. */ + /**The customer for which to fetch credit balance transactions.*/ customer: z .string() .max(5000) .describe('The customer for which to fetch credit balance transactions.'), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -45212,12 +42872,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -45225,7 +42885,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -45240,19 +42900,19 @@ export namespace stripe { export const GetBillingCreditBalanceTransactionsResponseSchema = z.object({ data: z.array(BillingCreditBalanceTransactionSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/billing/credit_grants')) @@ -45264,9 +42924,9 @@ export namespace stripe { > export const GetBillingCreditBalanceTransactionsIdParamsSchema = z.object({ - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -45283,13 +42943,13 @@ export namespace stripe { > export const GetBillingCreditGrantsParamsSchema = z.object({ - /** Only return credit grants for this customer. */ + /**Only return credit grants for this customer.*/ customer: z .string() .max(5000) .describe('Only return credit grants for this customer.') .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -45297,12 +42957,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -45310,7 +42970,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -45325,19 +42985,19 @@ export namespace stripe { export const GetBillingCreditGrantsResponseSchema = z.object({ data: z.array(BillingCreditGrantSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/billing/credit_grants')) @@ -45359,9 +43019,9 @@ export namespace stripe { > export const GetBillingCreditGrantsIdParamsSchema = z.object({ - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -45377,7 +43037,7 @@ export namespace stripe { > export const PostBillingCreditGrantsIdParamsSchema = z.object({ - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.') }) export type PostBillingCreditGrantsIdParams = z.infer< @@ -45391,7 +43051,7 @@ export namespace stripe { > export const PostBillingCreditGrantsIdExpireParamsSchema = z.object({ - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.') }) export type PostBillingCreditGrantsIdExpireParams = z.infer< @@ -45405,7 +43065,7 @@ export namespace stripe { > export const PostBillingCreditGrantsIdVoidParamsSchema = z.object({ - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.') }) export type PostBillingCreditGrantsIdVoidParams = z.infer< @@ -45440,7 +43100,7 @@ export namespace stripe { > export const GetBillingMetersParamsSchema = z.object({ - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -45448,12 +43108,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -45461,7 +43121,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -45469,7 +43129,7 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** Filter results to only include meters with the given status. */ + /**Filter results to only include meters with the given status.*/ status: z .enum(['active', 'inactive']) .describe('Filter results to only include meters with the given status.') @@ -45481,19 +43141,19 @@ export namespace stripe { export const GetBillingMetersResponseSchema = z.object({ data: z.array(BillingMeterSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/billing/meters')) @@ -45515,9 +43175,9 @@ export namespace stripe { > export const GetBillingMetersIdParamsSchema = z.object({ - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -45533,7 +43193,7 @@ export namespace stripe { > export const PostBillingMetersIdParamsSchema = z.object({ - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.') }) export type PostBillingMetersIdParams = z.infer< @@ -45546,7 +43206,7 @@ export namespace stripe { > export const PostBillingMetersIdDeactivateParamsSchema = z.object({ - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.') }) export type PostBillingMetersIdDeactivateParams = z.infer< @@ -45559,21 +43219,21 @@ export namespace stripe { > export const GetBillingMetersIdEventSummariesParamsSchema = z.object({ - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.'), - /** The customer for which to fetch event summaries. */ + /**The customer for which to fetch event summaries.*/ customer: z .string() .max(5000) .describe('The customer for which to fetch event summaries.'), - /** The timestamp from when to stop aggregating meter events (exclusive). Must be aligned with minute boundaries. */ + /**The timestamp from when to stop aggregating meter events (exclusive). Must be aligned with minute boundaries.*/ end_time: z .number() .int() .describe( 'The timestamp from when to stop aggregating meter events (exclusive). Must be aligned with minute boundaries.' ), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -45581,12 +43241,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -45594,14 +43254,14 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries. */ + /**The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries.*/ start_time: z .number() .int() .describe( 'The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries.' ), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -45609,7 +43269,7 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** Specifies what granularity to use when generating event summaries. If not specified, a single event summary would be returned for the specified time range. For hourly granularity, start and end times must align with hour boundaries (e.g., 00:00, 01:00, ..., 23:00). For daily granularity, start and end times must align with UTC day boundaries (00:00 UTC). */ + /**Specifies what granularity to use when generating event summaries. If not specified, a single event summary would be returned for the specified time range. For hourly granularity, start and end times must align with hour boundaries (e.g., 00:00, 01:00, ..., 23:00). For daily granularity, start and end times must align with UTC day boundaries (00:00 UTC).*/ value_grouping_window: z .enum(['day', 'hour']) .describe( @@ -45623,19 +43283,19 @@ export namespace stripe { export const GetBillingMetersIdEventSummariesResponseSchema = z.object({ data: z.array(BillingMeterEventSummarySchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/billing/meters/[^/]+/event_summaries')) @@ -45647,7 +43307,7 @@ export namespace stripe { > export const PostBillingMetersIdReactivateParamsSchema = z.object({ - /** Unique identifier for the object. */ + /**Unique identifier for the object.*/ id: z.string().max(5000).describe('Unique identifier for the object.') }) export type PostBillingMetersIdReactivateParams = z.infer< @@ -45660,14 +43320,14 @@ export namespace stripe { > export const GetBillingPortalConfigurationsParamsSchema = z.object({ - /** Only return configurations that are active or inactive (e.g., pass `true` to only list active configurations). */ + /**Only return configurations that are active or inactive (e.g., pass `true` to only list active configurations).*/ active: z .boolean() .describe( 'Only return configurations that are active or inactive (e.g., pass `true` to only list active configurations).' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -45675,19 +43335,19 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** Only return the default or non-default configurations (e.g., pass `true` to only list the default configuration). */ + /**Only return the default or non-default configurations (e.g., pass `true` to only list the default configuration).*/ is_default: z .boolean() .describe( 'Only return the default or non-default configurations (e.g., pass `true` to only list the default configuration).' ) .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -45695,7 +43355,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -45710,19 +43370,19 @@ export namespace stripe { export const GetBillingPortalConfigurationsResponseSchema = z.object({ data: z.array(BillingPortalConfigurationSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/billing_portal/configurations')) @@ -45747,7 +43407,7 @@ export namespace stripe { export const GetBillingPortalConfigurationsConfigurationParamsSchema = z.object({ configuration: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -45787,7 +43447,7 @@ export namespace stripe { > export const GetChargesParamsSchema = z.object({ - /** Only return charges that were created during the given date interval. */ + /**Only return charges that were created during the given date interval.*/ created: z .union([ z.object({ @@ -45802,7 +43462,7 @@ export namespace stripe { 'Only return charges that were created during the given date interval.' ) .optional(), - /** Only return charges for the customer specified by this customer ID. */ + /**Only return charges for the customer specified by this customer ID.*/ customer: z .string() .max(5000) @@ -45810,19 +43470,19 @@ export namespace stripe { 'Only return charges for the customer specified by this customer ID.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .describe( 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -45830,7 +43490,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID. */ + /**Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID.*/ payment_intent: z .string() .max(5000) @@ -45838,14 +43498,14 @@ export namespace stripe { 'Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .describe( 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** Only return charges for this transfer group, limited to 100. */ + /**Only return charges for this transfer group, limited to 100.*/ transfer_group: z .string() .max(5000) @@ -45856,19 +43516,19 @@ export namespace stripe { export const GetChargesResponseSchema = z.object({ data: z.array(ChargeSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/charges')) @@ -45884,12 +43544,12 @@ export namespace stripe { export type PostChargesResponse = z.infer export const GetChargesSearchParamsSchema = z.object({ - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -45897,7 +43557,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. */ + /**A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.*/ page: z .string() .max(5000) @@ -45905,7 +43565,7 @@ export namespace stripe { "A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results." ) .optional(), - /** The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for charges](https://stripe.com/docs/search#query-fields-for-charges). */ + /**The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for charges](https://stripe.com/docs/search#query-fields-for-charges).*/ query: z .string() .max(5000) @@ -45920,14 +43580,14 @@ export namespace stripe { export const GetChargesSearchResponseSchema = z.object({ data: z.array(ChargeSchema), has_more: z.boolean(), - next_page: z.string().max(5000).nullable().optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + next_page: z.string().max(5000).optional(), + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('search_result') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The total number of objects that match the query, only accurate up to 10,000. */ + /**The total number of objects that match the query, only accurate up to 10,000.*/ total_count: z .number() .int() @@ -45943,7 +43603,7 @@ export namespace stripe { export const GetChargesChargeParamsSchema = z.object({ charge: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -45984,7 +43644,7 @@ export namespace stripe { export const GetChargesChargeDisputeParamsSchema = z.object({ charge: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -46024,7 +43684,7 @@ export namespace stripe { > export const PostChargesChargeRefundParamsSchema = z.object({ - /** The identifier of the charge to refund. */ + /**The identifier of the charge to refund.*/ charge: z .string() .max(5000) @@ -46041,19 +43701,19 @@ export namespace stripe { export const GetChargesChargeRefundsParamsSchema = z.object({ charge: z.string(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .describe( 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -46061,7 +43721,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .describe( @@ -46074,21 +43734,21 @@ export namespace stripe { > export const GetChargesChargeRefundsResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z.array(RefundSchema).describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -46099,7 +43759,7 @@ export namespace stripe { > export const PostChargesChargeRefundsParamsSchema = z.object({ - /** The identifier of the charge to refund. */ + /**The identifier of the charge to refund.*/ charge: z .string() .max(5000) @@ -46117,7 +43777,7 @@ export namespace stripe { export const GetChargesChargeRefundsRefundParamsSchema = z.object({ charge: z.string(), refund: z.string(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -46146,7 +43806,7 @@ export namespace stripe { > export const GetCheckoutSessionsParamsSchema = z.object({ - /** Only return Checkout Sessions that were created during the given date interval. */ + /**Only return Checkout Sessions that were created during the given date interval.*/ created: z .union([ z.object({ @@ -46161,20 +43821,20 @@ export namespace stripe { 'Only return Checkout Sessions that were created during the given date interval.' ) .optional(), - /** Only return the Checkout Sessions for the Customer specified. */ + /**Only return the Checkout Sessions for the Customer specified.*/ customer: z .string() .max(5000) .describe('Only return the Checkout Sessions for the Customer specified.') .optional(), - /** Only return the Checkout Sessions for the Customer details specified. */ + /**Only return the Checkout Sessions for the Customer details specified.*/ customer_details: z .object({ email: z.string() }) .describe( 'Only return the Checkout Sessions for the Customer details specified.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -46182,12 +43842,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -46195,7 +43855,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** Only return the Checkout Session for the PaymentIntent specified. */ + /**Only return the Checkout Session for the PaymentIntent specified.*/ payment_intent: z .string() .max(5000) @@ -46203,7 +43863,7 @@ export namespace stripe { 'Only return the Checkout Session for the PaymentIntent specified.' ) .optional(), - /** Only return the Checkout Sessions for the Payment Link specified. */ + /**Only return the Checkout Sessions for the Payment Link specified.*/ payment_link: z .string() .max(5000) @@ -46211,7 +43871,7 @@ export namespace stripe { 'Only return the Checkout Sessions for the Payment Link specified.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -46219,12 +43879,12 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** Only return the Checkout Sessions matching the given status. */ + /**Only return the Checkout Sessions matching the given status.*/ status: z .enum(['complete', 'expired', 'open']) .describe('Only return the Checkout Sessions matching the given status.') .optional(), - /** Only return the Checkout Session for the subscription specified. */ + /**Only return the Checkout Session for the subscription specified.*/ subscription: z .string() .max(5000) @@ -46239,19 +43899,19 @@ export namespace stripe { export const GetCheckoutSessionsResponseSchema = z.object({ data: z.array(CheckoutSessionSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -46273,7 +43933,7 @@ export namespace stripe { export const GetCheckoutSessionsSessionParamsSchema = z.object({ session: z.string().max(66), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -46315,7 +43975,7 @@ export namespace stripe { export const GetCheckoutSessionsSessionLineItemsParamsSchema = z.object({ session: z.string().max(5000), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -46323,12 +43983,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -46336,7 +43996,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -46350,21 +44010,21 @@ export namespace stripe { > export const GetCheckoutSessionsSessionLineItemsResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z.array(ItemSchema).describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -46375,7 +44035,7 @@ export namespace stripe { > export const GetClimateOrdersParamsSchema = z.object({ - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -46383,12 +44043,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -46396,7 +44056,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -46411,19 +44071,19 @@ export namespace stripe { export const GetClimateOrdersResponseSchema = z.object({ data: z.array(ClimateOrderSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/climate/orders')) @@ -46445,9 +44105,9 @@ export namespace stripe { > export const GetClimateOrdersOrderParamsSchema = z.object({ - /** Unique identifier of the order. */ + /**Unique identifier of the order.*/ order: z.string().max(5000).describe('Unique identifier of the order.'), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -46463,7 +44123,7 @@ export namespace stripe { > export const PostClimateOrdersOrderParamsSchema = z.object({ - /** Unique identifier of the order. */ + /**Unique identifier of the order.*/ order: z.string().max(5000).describe('Unique identifier of the order.') }) export type PostClimateOrdersOrderParams = z.infer< @@ -46476,7 +44136,7 @@ export namespace stripe { > export const PostClimateOrdersOrderCancelParamsSchema = z.object({ - /** Unique identifier of the order. */ + /**Unique identifier of the order.*/ order: z.string().max(5000).describe('Unique identifier of the order.') }) export type PostClimateOrdersOrderCancelParams = z.infer< @@ -46489,7 +44149,7 @@ export namespace stripe { > export const GetClimateProductsParamsSchema = z.object({ - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -46497,12 +44157,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -46510,7 +44170,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -46525,19 +44185,19 @@ export namespace stripe { export const GetClimateProductsResponseSchema = z.object({ data: z.array(ClimateProductSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/climate/products')) @@ -46550,7 +44210,7 @@ export namespace stripe { export const GetClimateProductsProductParamsSchema = z.object({ product: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -46566,7 +44226,7 @@ export namespace stripe { > export const GetClimateSuppliersParamsSchema = z.object({ - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -46574,12 +44234,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -46587,7 +44247,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -46602,19 +44262,19 @@ export namespace stripe { export const GetClimateSuppliersResponseSchema = z.object({ data: z.array(ClimateSupplierSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/climate/suppliers')) @@ -46627,7 +44287,7 @@ export namespace stripe { export const GetClimateSuppliersSupplierParamsSchema = z.object({ supplier: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -46644,7 +44304,7 @@ export namespace stripe { export const GetConfirmationTokensConfirmationTokenParamsSchema = z.object({ confirmation_token: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -46661,7 +44321,7 @@ export namespace stripe { > export const GetCountrySpecsParamsSchema = z.object({ - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -46669,12 +44329,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -46682,7 +44342,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -46697,19 +44357,19 @@ export namespace stripe { export const GetCountrySpecsResponseSchema = z.object({ data: z.array(CountrySpecSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/country_specs')) @@ -46722,7 +44382,7 @@ export namespace stripe { export const GetCountrySpecsCountryParamsSchema = z.object({ country: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -46738,7 +44398,7 @@ export namespace stripe { > export const GetCouponsParamsSchema = z.object({ - /** A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. */ + /**A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.*/ created: z .union([ z.object({ @@ -46753,7 +44413,7 @@ export namespace stripe { 'A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -46761,12 +44421,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -46774,7 +44434,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -46787,19 +44447,19 @@ export namespace stripe { export const GetCouponsResponseSchema = z.object({ data: z.array(CouponSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/coupons')) @@ -46816,7 +44476,7 @@ export namespace stripe { export const GetCouponsCouponParamsSchema = z.object({ coupon: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -46856,7 +44516,7 @@ export namespace stripe { > export const GetCreditNotesParamsSchema = z.object({ - /** Only return credit notes that were created during the given date interval. */ + /**Only return credit notes that were created during the given date interval.*/ created: z .union([ z.object({ @@ -46871,7 +44531,7 @@ export namespace stripe { 'Only return credit notes that were created during the given date interval.' ) .optional(), - /** Only return credit notes for the customer specified by this customer ID. */ + /**Only return credit notes for the customer specified by this customer ID.*/ customer: z .string() .max(5000) @@ -46879,7 +44539,7 @@ export namespace stripe { 'Only return credit notes for the customer specified by this customer ID.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -46887,12 +44547,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** Only return credit notes for the invoice specified by this invoice ID. */ + /**Only return credit notes for the invoice specified by this invoice ID.*/ invoice: z .string() .max(5000) @@ -46900,7 +44560,7 @@ export namespace stripe { 'Only return credit notes for the invoice specified by this invoice ID.' ) .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -46908,7 +44568,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -46921,19 +44581,19 @@ export namespace stripe { export const GetCreditNotesResponseSchema = z.object({ data: z.array(CreditNoteSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -46954,7 +44614,7 @@ export namespace stripe { > export const GetCreditNotesPreviewParamsSchema = z.object({ - /** The integer amount in cents (or local equivalent) representing the total amount of the credit note. */ + /**The integer amount in cents (or local equivalent) representing the total amount of the credit note.*/ amount: z .number() .int() @@ -46962,7 +44622,7 @@ export namespace stripe { 'The integer amount in cents (or local equivalent) representing the total amount of the credit note.' ) .optional(), - /** The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. */ + /**The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.*/ credit_amount: z .number() .int() @@ -46970,7 +44630,7 @@ export namespace stripe { "The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice." ) .optional(), - /** The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF. */ + /**The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.*/ effective_at: z .number() .int() @@ -46978,21 +44638,21 @@ export namespace stripe { "The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF." ) .optional(), - /** Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`. */ + /**Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.*/ email_type: z .enum(['credit_note', 'none']) .describe( 'Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** ID of the invoice. */ + /**ID of the invoice.*/ invoice: z.string().max(5000).describe('ID of the invoice.'), - /** Line items that make up the credit note. */ + /**Line items that make up the credit note.*/ lines: z .array( z.object({ @@ -47022,20 +44682,20 @@ export namespace stripe { ) .describe('Line items that make up the credit note.') .optional(), - /** The credit note's memo appears on the credit note PDF. */ + /**The credit note's memo appears on the credit note PDF.*/ memo: z .string() .max(5000) .describe("The credit note's memo appears on the credit note PDF.") .optional(), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.*/ metadata: z .record(z.string()) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.' ) .optional(), - /** The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe. */ + /**The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.*/ out_of_band_amount: z .number() .int() @@ -47043,7 +44703,7 @@ export namespace stripe { 'The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.' ) .optional(), - /** Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` */ + /**Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`*/ reason: z .enum([ 'duplicate', @@ -47055,12 +44715,12 @@ export namespace stripe { 'Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`' ) .optional(), - /** ID of an existing refund to link this credit note to. */ + /**ID of an existing refund to link this credit note to.*/ refund: z .string() .describe('ID of an existing refund to link this credit note to.') .optional(), - /** The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. */ + /**The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.*/ refund_amount: z .number() .int() @@ -47068,7 +44728,7 @@ export namespace stripe { 'The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.' ) .optional(), - /** When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. */ + /**When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.*/ shipping_cost: z .object({ shipping_rate: z.string().max(5000).optional() }) .describe( @@ -47086,7 +44746,7 @@ export namespace stripe { > export const GetCreditNotesPreviewLinesParamsSchema = z.object({ - /** The integer amount in cents (or local equivalent) representing the total amount of the credit note. */ + /**The integer amount in cents (or local equivalent) representing the total amount of the credit note.*/ amount: z .number() .int() @@ -47094,7 +44754,7 @@ export namespace stripe { 'The integer amount in cents (or local equivalent) representing the total amount of the credit note.' ) .optional(), - /** The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. */ + /**The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.*/ credit_amount: z .number() .int() @@ -47102,7 +44762,7 @@ export namespace stripe { "The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice." ) .optional(), - /** The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF. */ + /**The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.*/ effective_at: z .number() .int() @@ -47110,14 +44770,14 @@ export namespace stripe { "The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF." ) .optional(), - /** Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`. */ + /**Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.*/ email_type: z .enum(['credit_note', 'none']) .describe( 'Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -47125,14 +44785,14 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** ID of the invoice. */ + /**ID of the invoice.*/ invoice: z.string().max(5000).describe('ID of the invoice.'), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -47140,7 +44800,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** Line items that make up the credit note. */ + /**Line items that make up the credit note.*/ lines: z .array( z.object({ @@ -47170,20 +44830,20 @@ export namespace stripe { ) .describe('Line items that make up the credit note.') .optional(), - /** The credit note's memo appears on the credit note PDF. */ + /**The credit note's memo appears on the credit note PDF.*/ memo: z .string() .max(5000) .describe("The credit note's memo appears on the credit note PDF.") .optional(), - /** Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ + /**Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.*/ metadata: z .record(z.string()) .describe( 'Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.' ) .optional(), - /** The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe. */ + /**The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.*/ out_of_band_amount: z .number() .int() @@ -47191,7 +44851,7 @@ export namespace stripe { 'The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.' ) .optional(), - /** Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` */ + /**Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`*/ reason: z .enum([ 'duplicate', @@ -47203,12 +44863,12 @@ export namespace stripe { 'Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`' ) .optional(), - /** ID of an existing refund to link this credit note to. */ + /**ID of an existing refund to link this credit note to.*/ refund: z .string() .describe('ID of an existing refund to link this credit note to.') .optional(), - /** The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. */ + /**The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.*/ refund_amount: z .number() .int() @@ -47216,14 +44876,14 @@ export namespace stripe { 'The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.' ) .optional(), - /** When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. */ + /**When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.*/ shipping_cost: z .object({ shipping_rate: z.string().max(5000).optional() }) .describe( 'When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -47237,23 +44897,23 @@ export namespace stripe { > export const GetCreditNotesPreviewLinesResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z .array(CreditNoteLineItemSchema) .describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -47265,7 +44925,7 @@ export namespace stripe { export const GetCreditNotesCreditNoteLinesParamsSchema = z.object({ credit_note: z.string().max(5000), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -47273,12 +44933,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -47286,7 +44946,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -47300,23 +44960,23 @@ export namespace stripe { > export const GetCreditNotesCreditNoteLinesResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z .array(CreditNoteLineItemSchema) .describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -47328,7 +44988,7 @@ export namespace stripe { export const GetCreditNotesIdParamsSchema = z.object({ id: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -47378,7 +45038,7 @@ export namespace stripe { > export const GetCustomersParamsSchema = z.object({ - /** Only return customers that were created during the given date interval. */ + /**Only return customers that were created during the given date interval.*/ created: z .union([ z.object({ @@ -47393,7 +45053,7 @@ export namespace stripe { 'Only return customers that were created during the given date interval.' ) .optional(), - /** A case-sensitive filter on the list based on the customer's `email` field. The value must be a string. */ + /**A case-sensitive filter on the list based on the customer's `email` field. The value must be a string.*/ email: z .string() .max(512) @@ -47401,7 +45061,7 @@ export namespace stripe { "A case-sensitive filter on the list based on the customer's `email` field. The value must be a string." ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -47409,12 +45069,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -47422,7 +45082,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -47430,7 +45090,7 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** Provides a list of customers that are associated with the specified test clock. The response will not include customers with test clocks if this parameter is not set. */ + /**Provides a list of customers that are associated with the specified test clock. The response will not include customers with test clocks if this parameter is not set.*/ test_clock: z .string() .max(5000) @@ -47443,19 +45103,19 @@ export namespace stripe { export const GetCustomersResponseSchema = z.object({ data: z.array(CustomerSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/customers')) @@ -47473,12 +45133,12 @@ export namespace stripe { > export const GetCustomersSearchParamsSchema = z.object({ - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -47486,7 +45146,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. */ + /**A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.*/ page: z .string() .max(5000) @@ -47494,7 +45154,7 @@ export namespace stripe { "A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results." ) .optional(), - /** The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for customers](https://stripe.com/docs/search#query-fields-for-customers). */ + /**The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for customers](https://stripe.com/docs/search#query-fields-for-customers).*/ query: z .string() .max(5000) @@ -47509,14 +45169,14 @@ export namespace stripe { export const GetCustomersSearchResponseSchema = z.object({ data: z.array(CustomerSchema), has_more: z.boolean(), - next_page: z.string().max(5000).nullable().optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + next_page: z.string().max(5000).optional(), + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('search_result') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The total number of objects that match the query, only accurate up to 10,000. */ + /**The total number of objects that match the query, only accurate up to 10,000.*/ total_count: z .number() .int() @@ -47532,7 +45192,7 @@ export namespace stripe { export const GetCustomersCustomerParamsSchema = z.object({ customer: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -47576,7 +45236,7 @@ export namespace stripe { export const GetCustomersCustomerBalanceTransactionsParamsSchema = z.object({ customer: z.string().max(5000), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -47584,12 +45244,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -47597,7 +45257,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -47612,23 +45272,23 @@ export namespace stripe { export const GetCustomersCustomerBalanceTransactionsResponseSchema = z.object( { - /** Details about each object. */ + /**Details about each object.*/ data: z .array(CustomerBalanceTransactionSchema) .describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -47656,7 +45316,7 @@ export namespace stripe { z.object({ customer: z.string().max(5000), transaction: z.string(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -47693,19 +45353,19 @@ export namespace stripe { export const GetCustomersCustomerBankAccountsParamsSchema = z.object({ customer: z.string().max(5000), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .describe( 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -47713,7 +45373,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .describe( @@ -47726,21 +45386,21 @@ export namespace stripe { > export const GetCustomersCustomerBankAccountsResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z.array(BankAccountSchema).describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -47766,7 +45426,7 @@ export namespace stripe { export const GetCustomersCustomerBankAccountsIdParamsSchema = z.object({ customer: z.string().max(5000), id: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -47830,19 +45490,19 @@ export namespace stripe { export const GetCustomersCustomerCardsParamsSchema = z.object({ customer: z.string().max(5000), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .describe( 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -47850,7 +45510,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .describe( @@ -47864,19 +45524,19 @@ export namespace stripe { export const GetCustomersCustomerCardsResponseSchema = z.object({ data: z.array(CardSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -47901,7 +45561,7 @@ export namespace stripe { export const GetCustomersCustomerCardsIdParamsSchema = z.object({ customer: z.string().max(5000), id: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -47951,7 +45611,7 @@ export namespace stripe { export const GetCustomersCustomerCashBalanceParamsSchema = z.object({ customer: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -47982,7 +45642,7 @@ export namespace stripe { export const GetCustomersCustomerCashBalanceTransactionsParamsSchema = z.object({ customer: z.string().max(5000), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -47990,12 +45650,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -48003,7 +45663,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -48024,23 +45684,23 @@ export namespace stripe { */ export const GetCustomersCustomerCashBalanceTransactionsResponseSchema = z .object({ - /** Details about each object. */ + /**Details about each object.*/ data: z .array(CustomerCashBalanceTransactionSchema) .describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -48057,7 +45717,7 @@ export namespace stripe { z.object({ customer: z.string().max(5000), transaction: z.string(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -48077,7 +45737,7 @@ export namespace stripe { export const GetCustomersCustomerDiscountParamsSchema = z.object({ customer: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -48120,14 +45780,14 @@ export namespace stripe { export const GetCustomersCustomerPaymentMethodsParamsSchema = z.object({ customer: z.string().max(5000), - /** This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`. */ + /**This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.*/ allow_redisplay: z .enum(['always', 'limited', 'unspecified']) .describe( 'This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -48135,12 +45795,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -48148,7 +45808,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -48156,7 +45816,7 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request. */ + /**An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request.*/ type: z .enum([ 'acss_debit', @@ -48215,19 +45875,19 @@ export namespace stripe { export const GetCustomersCustomerPaymentMethodsResponseSchema = z.object({ data: z.array(PaymentMethodSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -48241,7 +45901,7 @@ export namespace stripe { z.object({ customer: z.string().max(5000), payment_method: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -48259,19 +45919,19 @@ export namespace stripe { export const GetCustomersCustomerSourcesParamsSchema = z.object({ customer: z.string().max(5000), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .describe( 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -48279,13 +45939,13 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** Filter sources according to a particular object type. */ + /**Filter sources according to a particular object type.*/ object: z .string() .max(5000) .describe('Filter sources according to a particular object type.') .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .describe( @@ -48298,23 +45958,23 @@ export namespace stripe { > export const GetCustomersCustomerSourcesResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z .array(z.union([BankAccountSchema, CardSchema, SourceSchema])) .describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -48339,7 +45999,7 @@ export namespace stripe { export const GetCustomersCustomerSourcesIdParamsSchema = z.object({ customer: z.string().max(5000), id: z.string().max(500), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -48403,7 +46063,7 @@ export namespace stripe { export const GetCustomersCustomerSubscriptionsParamsSchema = z.object({ customer: z.string().max(5000), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -48411,12 +46071,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -48424,7 +46084,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -48438,21 +46098,21 @@ export namespace stripe { > export const GetCustomersCustomerSubscriptionsResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z.array(SubscriptionSchema).describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -48479,7 +46139,7 @@ export namespace stripe { z.object({ customer: z.string().max(5000), subscription_exposed_id: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -48535,7 +46195,7 @@ export namespace stripe { z.object({ customer: z.string().max(5000), subscription_exposed_id: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -48572,7 +46232,7 @@ export namespace stripe { export const GetCustomersCustomerTaxIdsParamsSchema = z.object({ customer: z.string().max(5000), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -48580,12 +46240,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -48593,7 +46253,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -48607,21 +46267,21 @@ export namespace stripe { > export const GetCustomersCustomerTaxIdsResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z.array(TaxIdSchema).describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -48646,7 +46306,7 @@ export namespace stripe { export const GetCustomersCustomerTaxIdsIdParamsSchema = z.object({ customer: z.string().max(5000), id: z.string(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -48676,7 +46336,7 @@ export namespace stripe { > export const GetDisputesParamsSchema = z.object({ - /** Only return disputes associated to the charge specified by this charge ID. */ + /**Only return disputes associated to the charge specified by this charge ID.*/ charge: z .string() .max(5000) @@ -48684,7 +46344,7 @@ export namespace stripe { 'Only return disputes associated to the charge specified by this charge ID.' ) .optional(), - /** Only return disputes that were created during the given date interval. */ + /**Only return disputes that were created during the given date interval.*/ created: z .union([ z.object({ @@ -48699,7 +46359,7 @@ export namespace stripe { 'Only return disputes that were created during the given date interval.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -48707,12 +46367,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -48720,7 +46380,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** Only return disputes associated to the PaymentIntent specified by this PaymentIntent ID. */ + /**Only return disputes associated to the PaymentIntent specified by this PaymentIntent ID.*/ payment_intent: z .string() .max(5000) @@ -48728,7 +46388,7 @@ export namespace stripe { 'Only return disputes associated to the PaymentIntent specified by this PaymentIntent ID.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -48741,19 +46401,19 @@ export namespace stripe { export const GetDisputesResponseSchema = z.object({ data: z.array(DisputeSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/disputes')) @@ -48764,7 +46424,7 @@ export namespace stripe { export const GetDisputesDisputeParamsSchema = z.object({ dispute: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -48804,9 +46464,9 @@ export namespace stripe { > export const GetEntitlementsActiveEntitlementsParamsSchema = z.object({ - /** The ID of the customer. */ + /**The ID of the customer.*/ customer: z.string().max(5000).describe('The ID of the customer.'), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -48814,12 +46474,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -48827,7 +46487,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -48842,19 +46502,19 @@ export namespace stripe { export const GetEntitlementsActiveEntitlementsResponseSchema = z.object({ data: z.array(EntitlementsActiveEntitlementSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -48865,9 +46525,9 @@ export namespace stripe { > export const GetEntitlementsActiveEntitlementsIdParamsSchema = z.object({ - /** The ID of the entitlement. */ + /**The ID of the entitlement.*/ id: z.string().max(5000).describe('The ID of the entitlement.'), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -48884,14 +46544,14 @@ export namespace stripe { > export const GetEntitlementsFeaturesParamsSchema = z.object({ - /** If set, filter results to only include features with the given archive status. */ + /**If set, filter results to only include features with the given archive status.*/ archived: z .boolean() .describe( 'If set, filter results to only include features with the given archive status.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -48899,12 +46559,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -48912,7 +46572,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** If set, filter results to only include features with the given lookup_key. */ + /**If set, filter results to only include features with the given lookup_key.*/ lookup_key: z .string() .max(5000) @@ -48920,7 +46580,7 @@ export namespace stripe { 'If set, filter results to only include features with the given lookup_key.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -48935,19 +46595,19 @@ export namespace stripe { export const GetEntitlementsFeaturesResponseSchema = z.object({ data: z.array(EntitlementsFeatureSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/entitlements/features')) @@ -48970,9 +46630,9 @@ export namespace stripe { > export const GetEntitlementsFeaturesIdParamsSchema = z.object({ - /** The ID of the feature. */ + /**The ID of the feature.*/ id: z.string().max(5000).describe('The ID of the feature.'), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -49024,7 +46684,7 @@ export namespace stripe { > export const GetEventsParamsSchema = z.object({ - /** Only return events that were created during the given date interval. */ + /**Only return events that were created during the given date interval.*/ created: z .union([ z.object({ @@ -49039,14 +46699,14 @@ export namespace stripe { 'Only return events that were created during the given date interval.' ) .optional(), - /** Filter events by whether all webhooks were successfully delivered. If false, events which are still pending or have failed all delivery attempts to a webhook endpoint will be returned. */ + /**Filter events by whether all webhooks were successfully delivered. If false, events which are still pending or have failed all delivery attempts to a webhook endpoint will be returned.*/ delivery_success: z .boolean() .describe( 'Filter events by whether all webhooks were successfully delivered. If false, events which are still pending or have failed all delivery attempts to a webhook endpoint will be returned.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -49054,12 +46714,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -49067,7 +46727,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -49075,7 +46735,7 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** A string containing a specific event name, or group of events using * as a wildcard. The list will be filtered to include only events with a matching event property. */ + /**A string containing a specific event name, or group of events using * as a wildcard. The list will be filtered to include only events with a matching event property.*/ type: z .string() .max(5000) @@ -49083,7 +46743,7 @@ export namespace stripe { 'A string containing a specific event name, or group of events using * as a wildcard. The list will be filtered to include only events with a matching event property.' ) .optional(), - /** An array of up to 20 strings containing specific event names. The list will be filtered to include only events with a matching event property. You may pass either `type` or `types`, but not both. */ + /**An array of up to 20 strings containing specific event names. The list will be filtered to include only events with a matching event property. You may pass either `type` or `types`, but not both.*/ types: z .array(z.string().max(5000)) .describe( @@ -49095,19 +46755,19 @@ export namespace stripe { export const GetEventsResponseSchema = z.object({ data: z.array(EventSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/events')) @@ -49118,7 +46778,7 @@ export namespace stripe { export const GetEventsIdParamsSchema = z.object({ id: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -49130,7 +46790,7 @@ export namespace stripe { export type GetEventsIdResponse = z.infer export const GetExchangeRatesParamsSchema = z.object({ - /** A cursor for use in pagination. `ending_before` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with the exchange rate for currency X your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with the exchange rate for currency X your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -49138,12 +46798,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with the exchange rate for currency X your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and total number of supported payout currencies, and the default is the max. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and total number of supported payout currencies, and the default is the max.*/ limit: z .number() .int() @@ -49151,7 +46811,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and total number of supported payout currencies, and the default is the max.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with the exchange rate for currency X, your subsequent call can include `starting_after=X` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with the exchange rate for currency X, your subsequent call can include `starting_after=X` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -49166,19 +46826,19 @@ export namespace stripe { export const GetExchangeRatesResponseSchema = z.object({ data: z.array(ExchangeRateSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/exchange_rates')) @@ -49191,7 +46851,7 @@ export namespace stripe { export const GetExchangeRatesRateIdParamsSchema = z.object({ rate_id: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -49207,7 +46867,7 @@ export namespace stripe { > export const GetFileLinksParamsSchema = z.object({ - /** Only return links that were created during the given date interval. */ + /**Only return links that were created during the given date interval.*/ created: z .union([ z.object({ @@ -49222,32 +46882,32 @@ export namespace stripe { 'Only return links that were created during the given date interval.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .describe( 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** Filter links by their expiration status. By default, Stripe returns all links. */ + /**Filter links by their expiration status. By default, Stripe returns all links.*/ expired: z .boolean() .describe( 'Filter links by their expiration status. By default, Stripe returns all links.' ) .optional(), - /** Only return links for the given file. */ + /**Only return links for the given file.*/ file: z .string() .max(5000) .describe('Only return links for the given file.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -49255,7 +46915,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .describe( @@ -49266,21 +46926,21 @@ export namespace stripe { export type GetFileLinksParams = z.infer export const GetFileLinksResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z.array(FileLinkSchema).describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/file_links')) @@ -49299,7 +46959,7 @@ export namespace stripe { export const GetFileLinksLinkParamsSchema = z.object({ link: z.string(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -49325,7 +46985,7 @@ export namespace stripe { > export const GetFilesParamsSchema = z.object({ - /** Only return files that were created during the given date interval. */ + /**Only return files that were created during the given date interval.*/ created: z .union([ z.object({ @@ -49340,7 +47000,7 @@ export namespace stripe { 'Only return files that were created during the given date interval.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -49348,12 +47008,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -49361,7 +47021,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** Filter queries by the file purpose. If you don't provide a purpose, the queries return unfiltered files. */ + /**Filter queries by the file purpose. If you don't provide a purpose, the queries return unfiltered files.*/ purpose: z .enum([ 'account_requirement', @@ -49386,7 +47046,7 @@ export namespace stripe { "Filter queries by the file purpose. If you don't provide a purpose, the queries return unfiltered files." ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -49399,19 +47059,19 @@ export namespace stripe { export const GetFilesResponseSchema = z.object({ data: z.array(FileSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/files')) @@ -49421,19 +47081,19 @@ export namespace stripe { export type GetFilesResponse = z.infer export const PostFilesParamsSchema = z.object({ - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A file to upload. Make sure that the specifications follow RFC 2388, which defines file transfers for the `multipart/form-data` protocol. */ + /**A file to upload. Make sure that the specifications follow RFC 2388, which defines file transfers for the `multipart/form-data` protocol.*/ file: z .string() .base64() .describe( 'A file to upload. Make sure that the specifications follow RFC 2388, which defines file transfers for the `multipart/form-data` protocol.' ), - /** Optional parameters that automatically create a [file link](https://stripe.com/docs/api#file_links) for the newly created file. */ + /**Optional parameters that automatically create a [file link](https://stripe.com/docs/api#file_links) for the newly created file.*/ file_link_data: z .object({ create: z.boolean(), @@ -49444,7 +47104,7 @@ export namespace stripe { 'Optional parameters that automatically create a [file link](https://stripe.com/docs/api#file_links) for the newly created file.' ) .optional(), - /** The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file. */ + /**The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file.*/ purpose: z .enum([ 'account_requirement', @@ -49470,7 +47130,7 @@ export namespace stripe { export const GetFilesFileParamsSchema = z.object({ file: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -49482,7 +47142,7 @@ export namespace stripe { export type GetFilesFileResponse = z.infer export const GetFinancialConnectionsAccountsParamsSchema = z.object({ - /** If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive. */ + /**If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive.*/ account_holder: z .object({ account: z.string().max(5000).optional(), @@ -49492,7 +47152,7 @@ export namespace stripe { 'If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -49500,12 +47160,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -49513,7 +47173,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** If present, only return accounts that were collected as part of the given session. */ + /**If present, only return accounts that were collected as part of the given session.*/ session: z .string() .max(5000) @@ -49521,7 +47181,7 @@ export namespace stripe { 'If present, only return accounts that were collected as part of the given session.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -49535,23 +47195,23 @@ export namespace stripe { > export const GetFinancialConnectionsAccountsResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z .array(FinancialConnectionsAccountSchema) .describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/financial_connections/accounts')) @@ -49564,7 +47224,7 @@ export namespace stripe { export const GetFinancialConnectionsAccountsAccountParamsSchema = z.object({ account: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -49596,7 +47256,7 @@ export namespace stripe { export const GetFinancialConnectionsAccountsAccountOwnersParamsSchema = z.object({ account: z.string().max(5000), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -49604,12 +47264,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -49617,12 +47277,12 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** The ID of the ownership object to fetch owners from. */ + /**The ID of the ownership object to fetch owners from.*/ ownership: z .string() .max(5000) .describe('The ID of the ownership object to fetch owners from.'), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -49637,23 +47297,23 @@ export namespace stripe { export const GetFinancialConnectionsAccountsAccountOwnersResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z .array(FinancialConnectionsAccountOwnerSchema) .describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -49715,7 +47375,7 @@ export namespace stripe { export const GetFinancialConnectionsSessionsSessionParamsSchema = z.object({ session: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -49732,14 +47392,14 @@ export namespace stripe { > export const GetFinancialConnectionsTransactionsParamsSchema = z.object({ - /** The ID of the Financial Connections Account whose transactions will be retrieved. */ + /**The ID of the Financial Connections Account whose transactions will be retrieved.*/ account: z .string() .max(5000) .describe( 'The ID of the Financial Connections Account whose transactions will be retrieved.' ), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -49747,12 +47407,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -49760,7 +47420,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -49768,7 +47428,7 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** A filter on the list based on the object `transacted_at` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options: */ + /**A filter on the list based on the object `transacted_at` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options:*/ transacted_at: z .union([ z.object({ @@ -49783,7 +47443,7 @@ export namespace stripe { 'A filter on the list based on the object `transacted_at` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options:' ) .optional(), - /** A filter on the list based on the object `transaction_refresh` field. The value can be a dictionary with the following options: */ + /**A filter on the list based on the object `transaction_refresh` field. The value can be a dictionary with the following options:*/ transaction_refresh: z .object({ after: z.string().max(5000) }) .describe( @@ -49796,23 +47456,23 @@ export namespace stripe { > export const GetFinancialConnectionsTransactionsResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z .array(FinancialConnectionsTransactionSchema) .describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/financial_connections/transactions')) @@ -49826,7 +47486,7 @@ export namespace stripe { export const GetFinancialConnectionsTransactionsTransactionParamsSchema = z.object({ transaction: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -49843,7 +47503,7 @@ export namespace stripe { > export const GetForwardingRequestsParamsSchema = z.object({ - /** Similar to other List endpoints, filters results based on created timestamp. You can pass gt, gte, lt, and lte timestamp values. */ + /**Similar to other List endpoints, filters results based on created timestamp. You can pass gt, gte, lt, and lte timestamp values.*/ created: z .object({ gt: z.number().int().optional(), @@ -49855,7 +47515,7 @@ export namespace stripe { 'Similar to other List endpoints, filters results based on created timestamp. You can pass gt, gte, lt, and lte timestamp values.' ) .optional(), - /** A pagination cursor to fetch the previous page of the list. The value must be a ForwardingRequest ID. */ + /**A pagination cursor to fetch the previous page of the list. The value must be a ForwardingRequest ID.*/ ending_before: z .string() .max(5000) @@ -49863,12 +47523,12 @@ export namespace stripe { 'A pagination cursor to fetch the previous page of the list. The value must be a ForwardingRequest ID.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -49876,7 +47536,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A pagination cursor to fetch the next page of the list. The value must be a ForwardingRequest ID. */ + /**A pagination cursor to fetch the next page of the list. The value must be a ForwardingRequest ID.*/ starting_after: z .string() .max(5000) @@ -49889,23 +47549,23 @@ export namespace stripe { typeof GetForwardingRequestsParamsSchema > - /** List of ForwardingRequest data. */ + /**List of ForwardingRequest data.*/ export const GetForwardingRequestsResponseSchema = z .object({ data: z.array(ForwardingRequestSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -49928,7 +47588,7 @@ export namespace stripe { export const GetForwardingRequestsIdParamsSchema = z.object({ id: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -49944,7 +47604,7 @@ export namespace stripe { > export const GetIdentityVerificationReportsParamsSchema = z.object({ - /** A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. */ + /**A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.*/ client_reference_id: z .string() .max(5000) @@ -49952,7 +47612,7 @@ export namespace stripe { 'A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.' ) .optional(), - /** Only return VerificationReports that were created during the given date interval. */ + /**Only return VerificationReports that were created during the given date interval.*/ created: z .union([ z.object({ @@ -49967,7 +47627,7 @@ export namespace stripe { 'Only return VerificationReports that were created during the given date interval.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -49975,12 +47635,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -49988,7 +47648,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -49996,12 +47656,12 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** Only return VerificationReports of this type */ + /**Only return VerificationReports of this type*/ type: z .enum(['document', 'id_number']) .describe('Only return VerificationReports of this type') .optional(), - /** Only return VerificationReports created by this VerificationSession ID. It is allowed to provide a VerificationIntent ID. */ + /**Only return VerificationReports created by this VerificationSession ID. It is allowed to provide a VerificationIntent ID.*/ verification_session: z .string() .max(5000) @@ -50016,19 +47676,19 @@ export namespace stripe { export const GetIdentityVerificationReportsResponseSchema = z.object({ data: z.array(IdentityVerificationReportSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/identity/verification_reports')) @@ -50041,7 +47701,7 @@ export namespace stripe { export const GetIdentityVerificationReportsReportParamsSchema = z.object({ report: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -50058,7 +47718,7 @@ export namespace stripe { > export const GetIdentityVerificationSessionsParamsSchema = z.object({ - /** A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. */ + /**A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.*/ client_reference_id: z .string() .max(5000) @@ -50066,7 +47726,7 @@ export namespace stripe { 'A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.' ) .optional(), - /** Only return VerificationSessions that were created during the given date interval. */ + /**Only return VerificationSessions that were created during the given date interval.*/ created: z .union([ z.object({ @@ -50081,7 +47741,7 @@ export namespace stripe { 'Only return VerificationSessions that were created during the given date interval.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -50089,12 +47749,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -50103,7 +47763,7 @@ export namespace stripe { ) .optional(), related_customer: z.string().max(5000).optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -50111,7 +47771,7 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work). */ + /**Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).*/ status: z .enum(['canceled', 'processing', 'requires_input', 'verified']) .describe( @@ -50125,19 +47785,19 @@ export namespace stripe { export const GetIdentityVerificationSessionsResponseSchema = z.object({ data: z.array(IdentityVerificationSessionSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/identity/verification_sessions')) @@ -50161,7 +47821,7 @@ export namespace stripe { export const GetIdentityVerificationSessionsSessionParamsSchema = z.object({ session: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -50215,7 +47875,7 @@ export namespace stripe { > export const GetInvoiceRenderingTemplatesParamsSchema = z.object({ - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -50223,12 +47883,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -50236,7 +47896,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -50251,23 +47911,23 @@ export namespace stripe { > export const GetInvoiceRenderingTemplatesResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z .array(InvoiceRenderingTemplateSchema) .describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -50279,7 +47939,7 @@ export namespace stripe { export const GetInvoiceRenderingTemplatesTemplateParamsSchema = z.object({ template: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -50321,7 +47981,7 @@ export namespace stripe { > export const GetInvoiceitemsParamsSchema = z.object({ - /** Only return invoice items that were created during the given date interval. */ + /**Only return invoice items that were created during the given date interval.*/ created: z .union([ z.object({ @@ -50336,7 +47996,7 @@ export namespace stripe { 'Only return invoice items that were created during the given date interval.' ) .optional(), - /** The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned. */ + /**The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned.*/ customer: z .string() .max(5000) @@ -50344,7 +48004,7 @@ export namespace stripe { 'The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -50352,12 +48012,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** Only return invoice items belonging to this invoice. If none is provided, all invoice items will be returned. If specifying an invoice, no customer identifier is needed. */ + /**Only return invoice items belonging to this invoice. If none is provided, all invoice items will be returned. If specifying an invoice, no customer identifier is needed.*/ invoice: z .string() .max(5000) @@ -50365,7 +48025,7 @@ export namespace stripe { 'Only return invoice items belonging to this invoice. If none is provided, all invoice items will be returned. If specifying an invoice, no customer identifier is needed.' ) .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -50373,14 +48033,14 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** Set to `true` to only show pending invoice items, which are not yet attached to any invoices. Set to `false` to only show invoice items already attached to invoices. If unspecified, no filter is applied. */ + /**Set to `true` to only show pending invoice items, which are not yet attached to any invoices. Set to `false` to only show invoice items already attached to invoices. If unspecified, no filter is applied.*/ pending: z .boolean() .describe( 'Set to `true` to only show pending invoice items, which are not yet attached to any invoices. Set to `false` to only show invoice items already attached to invoices. If unspecified, no filter is applied.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -50395,19 +48055,19 @@ export namespace stripe { export const GetInvoiceitemsResponseSchema = z.object({ data: z.array(InvoiceitemSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/invoiceitems')) @@ -50430,7 +48090,7 @@ export namespace stripe { export const GetInvoiceitemsInvoiceitemParamsSchema = z.object({ invoiceitem: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -50471,14 +48131,14 @@ export namespace stripe { > export const GetInvoicesParamsSchema = z.object({ - /** The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`. */ + /**The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`.*/ collection_method: z .enum(['charge_automatically', 'send_invoice']) .describe( 'The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`.' ) .optional(), - /** Only return invoices that were created during the given date interval. */ + /**Only return invoices that were created during the given date interval.*/ created: z .union([ z.object({ @@ -50493,7 +48153,7 @@ export namespace stripe { 'Only return invoices that were created during the given date interval.' ) .optional(), - /** Only return invoices for the customer specified by this customer ID. */ + /**Only return invoices for the customer specified by this customer ID.*/ customer: z .string() .max(5000) @@ -50512,7 +48172,7 @@ export namespace stripe { z.number().int() ]) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -50520,12 +48180,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -50533,7 +48193,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -50541,14 +48201,14 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview) */ + /**The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview)*/ status: z .enum(['draft', 'open', 'paid', 'uncollectible', 'void']) .describe( 'The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview)' ) .optional(), - /** Only return invoices for the subscription specified by this subscription ID. */ + /**Only return invoices for the subscription specified by this subscription ID.*/ subscription: z .string() .max(5000) @@ -50561,19 +48221,19 @@ export namespace stripe { export const GetInvoicesResponseSchema = z.object({ data: z.array(InvoiceSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/invoices')) @@ -50599,12 +48259,12 @@ export namespace stripe { > export const GetInvoicesSearchParamsSchema = z.object({ - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -50612,7 +48272,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. */ + /**A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.*/ page: z .string() .max(5000) @@ -50620,7 +48280,7 @@ export namespace stripe { "A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results." ) .optional(), - /** The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for invoices](https://stripe.com/docs/search#query-fields-for-invoices). */ + /**The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for invoices](https://stripe.com/docs/search#query-fields-for-invoices).*/ query: z .string() .max(5000) @@ -50635,14 +48295,14 @@ export namespace stripe { export const GetInvoicesSearchResponseSchema = z.object({ data: z.array(InvoiceSchema), has_more: z.boolean(), - next_page: z.string().max(5000).nullable().optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + next_page: z.string().max(5000).optional(), + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('search_result') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The total number of objects that match the query, only accurate up to 10,000. */ + /**The total number of objects that match the query, only accurate up to 10,000.*/ total_count: z .number() .int() @@ -50657,7 +48317,7 @@ export namespace stripe { > export const GetInvoicesUpcomingParamsSchema = z.object({ - /** Settings for automatic tax lookup for this invoice preview. */ + /**Settings for automatic tax lookup for this invoice preview.*/ automatic_tax: z .object({ enabled: z.boolean(), @@ -50670,7 +48330,7 @@ export namespace stripe { }) .describe('Settings for automatic tax lookup for this invoice preview.') .optional(), - /** The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ + /**The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.*/ coupon: z .string() .max(5000) @@ -50678,14 +48338,14 @@ export namespace stripe { 'The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.' ) .optional(), - /** The currency to preview this invoice in. Defaults to that of `customer` if not specified. */ + /**The currency to preview this invoice in. Defaults to that of `customer` if not specified.*/ currency: z .string() .describe( 'The currency to preview this invoice in. Defaults to that of `customer` if not specified.' ) .optional(), - /** The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. */ + /**The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.*/ customer: z .string() .max(5000) @@ -50693,7 +48353,7 @@ export namespace stripe { "The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set." ) .optional(), - /** Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. */ + /**Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.*/ customer_details: z .object({ address: z @@ -50846,7 +48506,7 @@ export namespace stripe { 'Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.' ) .optional(), - /** The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts. */ + /**The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts.*/ discounts: z .union([ z.array( @@ -50862,12 +48522,12 @@ export namespace stripe { 'The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** List of invoice items to add or update in the upcoming invoice preview (up to 250). */ + /**List of invoice items to add or update in the upcoming invoice preview (up to 250).*/ invoice_items: z .array( z.object({ @@ -50920,7 +48580,7 @@ export namespace stripe { 'List of invoice items to add or update in the upcoming invoice preview (up to 250).' ) .optional(), - /** The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. */ + /**The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.*/ issuer: z .object({ account: z.string().optional(), @@ -50930,21 +48590,21 @@ export namespace stripe { 'The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.' ) .optional(), - /** The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. */ + /**The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.*/ on_behalf_of: z .union([z.string(), z.literal('')]) .describe( 'The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.' ) .optional(), - /** Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified. */ + /**Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified.*/ preview_mode: z .enum(['next', 'recurring']) .describe( 'Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified.' ) .optional(), - /** The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. */ + /**The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.*/ schedule: z .string() .max(5000) @@ -50952,7 +48612,7 @@ export namespace stripe { "The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields." ) .optional(), - /** The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields. */ + /**The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields.*/ schedule_details: z .object({ end_behavior: z.enum(['cancel', 'release']).optional(), @@ -51127,7 +48787,7 @@ export namespace stripe { 'The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields.' ) .optional(), - /** The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_details.items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_details.items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. */ + /**The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_details.items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_details.items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions.*/ subscription: z .string() .max(5000) @@ -51135,42 +48795,42 @@ export namespace stripe { "The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_details.items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_details.items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions." ) .optional(), - /** For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.billing_cycle_anchor` instead. */ + /**For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.billing_cycle_anchor` instead.*/ subscription_billing_cycle_anchor: z .union([z.enum(['now', 'unchanged']), z.number().int()]) .describe( "For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.billing_cycle_anchor` instead." ) .optional(), - /** A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at` instead. */ + /**A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at` instead.*/ subscription_cancel_at: z .union([z.number().int(), z.literal('')]) .describe( 'A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at` instead.' ) .optional(), - /** Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead. */ + /**Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead.*/ subscription_cancel_at_period_end: z .boolean() .describe( 'Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead.' ) .optional(), - /** This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_now` instead. */ + /**This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_now` instead.*/ subscription_cancel_now: z .boolean() .describe( 'This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_now` instead.' ) .optional(), - /** If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set. This field has been deprecated and will be removed in a future API version. Use `subscription_details.default_tax_rates` instead. */ + /**If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set. This field has been deprecated and will be removed in a future API version. Use `subscription_details.default_tax_rates` instead.*/ subscription_default_tax_rates: z .union([z.array(z.string().max(5000)), z.literal('')]) .describe( 'If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set. This field has been deprecated and will be removed in a future API version. Use `subscription_details.default_tax_rates` instead.' ) .optional(), - /** The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields. */ + /**The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields.*/ subscription_details: z .object({ billing_cycle_anchor: z @@ -51244,7 +48904,7 @@ export namespace stripe { 'The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields.' ) .optional(), - /** A list of up to 20 subscription items, each with an attached price. This field has been deprecated and will be removed in a future API version. Use `subscription_details.items` instead. */ + /**A list of up to 20 subscription items, each with an attached price. This field has been deprecated and will be removed in a future API version. Use `subscription_details.items` instead.*/ subscription_items: z .array( z.object({ @@ -51293,14 +48953,14 @@ export namespace stripe { 'A list of up to 20 subscription items, each with an attached price. This field has been deprecated and will be removed in a future API version. Use `subscription_details.items` instead.' ) .optional(), - /** Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_behavior` instead. */ + /**Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_behavior` instead.*/ subscription_proration_behavior: z .enum(['always_invoice', 'create_prorations', 'none']) .describe( "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_behavior` instead." ) .optional(), - /** If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_date` instead. */ + /**If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_date` instead.*/ subscription_proration_date: z .number() .int() @@ -51308,14 +48968,14 @@ export namespace stripe { "If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_date` instead." ) .optional(), - /** For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Use `subscription_details.resume_at` instead. */ + /**For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Use `subscription_details.resume_at` instead.*/ subscription_resume_at: z .literal('now') .describe( 'For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Use `subscription_details.resume_at` instead.' ) .optional(), - /** Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use `subscription_details.start_date` instead. */ + /**Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use `subscription_details.start_date` instead.*/ subscription_start_date: z .number() .int() @@ -51323,7 +48983,7 @@ export namespace stripe { 'Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use `subscription_details.start_date` instead.' ) .optional(), - /** If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_items` or `subscription` is required. This field has been deprecated and will be removed in a future API version. Use `subscription_details.trial_end` instead. */ + /**If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_items` or `subscription` is required. This field has been deprecated and will be removed in a future API version. Use `subscription_details.trial_end` instead.*/ subscription_trial_end: z .union([z.literal('now'), z.number().int()]) .describe( @@ -51341,7 +49001,7 @@ export namespace stripe { > export const GetInvoicesUpcomingLinesParamsSchema = z.object({ - /** Settings for automatic tax lookup for this invoice preview. */ + /**Settings for automatic tax lookup for this invoice preview.*/ automatic_tax: z .object({ enabled: z.boolean(), @@ -51354,7 +49014,7 @@ export namespace stripe { }) .describe('Settings for automatic tax lookup for this invoice preview.') .optional(), - /** The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ + /**The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.*/ coupon: z .string() .max(5000) @@ -51362,14 +49022,14 @@ export namespace stripe { 'The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.' ) .optional(), - /** The currency to preview this invoice in. Defaults to that of `customer` if not specified. */ + /**The currency to preview this invoice in. Defaults to that of `customer` if not specified.*/ currency: z .string() .describe( 'The currency to preview this invoice in. Defaults to that of `customer` if not specified.' ) .optional(), - /** The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. */ + /**The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.*/ customer: z .string() .max(5000) @@ -51377,7 +49037,7 @@ export namespace stripe { "The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set." ) .optional(), - /** Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. */ + /**Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.*/ customer_details: z .object({ address: z @@ -51530,7 +49190,7 @@ export namespace stripe { 'Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.' ) .optional(), - /** The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts. */ + /**The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts.*/ discounts: z .union([ z.array( @@ -51546,7 +49206,7 @@ export namespace stripe { 'The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -51554,12 +49214,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** List of invoice items to add or update in the upcoming invoice preview (up to 250). */ + /**List of invoice items to add or update in the upcoming invoice preview (up to 250).*/ invoice_items: z .array( z.object({ @@ -51612,7 +49272,7 @@ export namespace stripe { 'List of invoice items to add or update in the upcoming invoice preview (up to 250).' ) .optional(), - /** The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. */ + /**The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.*/ issuer: z .object({ account: z.string().optional(), @@ -51622,7 +49282,7 @@ export namespace stripe { 'The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.' ) .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -51630,21 +49290,21 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. */ + /**The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.*/ on_behalf_of: z .union([z.string(), z.literal('')]) .describe( 'The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.' ) .optional(), - /** Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified. */ + /**Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified.*/ preview_mode: z .enum(['next', 'recurring']) .describe( 'Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified.' ) .optional(), - /** The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. */ + /**The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.*/ schedule: z .string() .max(5000) @@ -51652,7 +49312,7 @@ export namespace stripe { "The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields." ) .optional(), - /** The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields. */ + /**The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields.*/ schedule_details: z .object({ end_behavior: z.enum(['cancel', 'release']).optional(), @@ -51827,7 +49487,7 @@ export namespace stripe { 'The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -51835,7 +49495,7 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_details.items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_details.items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. */ + /**The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_details.items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_details.items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions.*/ subscription: z .string() .max(5000) @@ -51843,42 +49503,42 @@ export namespace stripe { "The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_details.items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_details.items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions." ) .optional(), - /** For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.billing_cycle_anchor` instead. */ + /**For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.billing_cycle_anchor` instead.*/ subscription_billing_cycle_anchor: z .union([z.enum(['now', 'unchanged']), z.number().int()]) .describe( "For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.billing_cycle_anchor` instead." ) .optional(), - /** A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at` instead. */ + /**A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at` instead.*/ subscription_cancel_at: z .union([z.number().int(), z.literal('')]) .describe( 'A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at` instead.' ) .optional(), - /** Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead. */ + /**Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead.*/ subscription_cancel_at_period_end: z .boolean() .describe( 'Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead.' ) .optional(), - /** This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_now` instead. */ + /**This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_now` instead.*/ subscription_cancel_now: z .boolean() .describe( 'This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_now` instead.' ) .optional(), - /** If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set. This field has been deprecated and will be removed in a future API version. Use `subscription_details.default_tax_rates` instead. */ + /**If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set. This field has been deprecated and will be removed in a future API version. Use `subscription_details.default_tax_rates` instead.*/ subscription_default_tax_rates: z .union([z.array(z.string().max(5000)), z.literal('')]) .describe( 'If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set. This field has been deprecated and will be removed in a future API version. Use `subscription_details.default_tax_rates` instead.' ) .optional(), - /** The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields. */ + /**The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields.*/ subscription_details: z .object({ billing_cycle_anchor: z @@ -51952,7 +49612,7 @@ export namespace stripe { 'The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields.' ) .optional(), - /** A list of up to 20 subscription items, each with an attached price. This field has been deprecated and will be removed in a future API version. Use `subscription_details.items` instead. */ + /**A list of up to 20 subscription items, each with an attached price. This field has been deprecated and will be removed in a future API version. Use `subscription_details.items` instead.*/ subscription_items: z .array( z.object({ @@ -52001,14 +49661,14 @@ export namespace stripe { 'A list of up to 20 subscription items, each with an attached price. This field has been deprecated and will be removed in a future API version. Use `subscription_details.items` instead.' ) .optional(), - /** Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_behavior` instead. */ + /**Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_behavior` instead.*/ subscription_proration_behavior: z .enum(['always_invoice', 'create_prorations', 'none']) .describe( "Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_behavior` instead." ) .optional(), - /** If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_date` instead. */ + /**If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_date` instead.*/ subscription_proration_date: z .number() .int() @@ -52016,14 +49676,14 @@ export namespace stripe { "If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_date` instead." ) .optional(), - /** For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Use `subscription_details.resume_at` instead. */ + /**For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Use `subscription_details.resume_at` instead.*/ subscription_resume_at: z .literal('now') .describe( 'For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Use `subscription_details.resume_at` instead.' ) .optional(), - /** Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use `subscription_details.start_date` instead. */ + /**Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use `subscription_details.start_date` instead.*/ subscription_start_date: z .number() .int() @@ -52031,7 +49691,7 @@ export namespace stripe { 'Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use `subscription_details.start_date` instead.' ) .optional(), - /** If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_items` or `subscription` is required. This field has been deprecated and will be removed in a future API version. Use `subscription_details.trial_end` instead. */ + /**If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_items` or `subscription` is required. This field has been deprecated and will be removed in a future API version. Use `subscription_details.trial_end` instead.*/ subscription_trial_end: z .union([z.literal('now'), z.number().int()]) .describe( @@ -52044,21 +49704,21 @@ export namespace stripe { > export const GetInvoicesUpcomingLinesResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z.array(LineItemSchema).describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -52070,7 +49730,7 @@ export namespace stripe { export const GetInvoicesInvoiceParamsSchema = z.object({ invoice: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -52135,7 +49795,7 @@ export namespace stripe { export const GetInvoicesInvoiceLinesParamsSchema = z.object({ invoice: z.string().max(5000), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -52143,12 +49803,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -52156,7 +49816,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -52170,21 +49830,21 @@ export namespace stripe { > export const GetInvoicesInvoiceLinesResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z.array(LineItemSchema).describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -52195,9 +49855,9 @@ export namespace stripe { > export const PostInvoicesInvoiceLinesLineItemIdParamsSchema = z.object({ - /** Invoice ID of line item */ + /**Invoice ID of line item*/ invoice: z.string().max(5000).describe('Invoice ID of line item'), - /** Invoice line item ID */ + /**Invoice line item ID*/ line_item_id: z.string().max(5000).describe('Invoice line item ID') }) export type PostInvoicesInvoiceLinesLineItemIdParams = z.infer< @@ -52283,13 +49943,13 @@ export namespace stripe { > export const GetIssuingAuthorizationsParamsSchema = z.object({ - /** Only return authorizations that belong to the given card. */ + /**Only return authorizations that belong to the given card.*/ card: z .string() .max(5000) .describe('Only return authorizations that belong to the given card.') .optional(), - /** Only return authorizations that belong to the given cardholder. */ + /**Only return authorizations that belong to the given cardholder.*/ cardholder: z .string() .max(5000) @@ -52297,7 +49957,7 @@ export namespace stripe { 'Only return authorizations that belong to the given cardholder.' ) .optional(), - /** Only return authorizations that were created during the given date interval. */ + /**Only return authorizations that were created during the given date interval.*/ created: z .union([ z.object({ @@ -52312,7 +49972,7 @@ export namespace stripe { 'Only return authorizations that were created during the given date interval.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -52320,12 +49980,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -52333,7 +49993,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -52341,7 +50001,7 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** Only return authorizations with the given status. One of `pending`, `closed`, or `reversed`. */ + /**Only return authorizations with the given status. One of `pending`, `closed`, or `reversed`.*/ status: z .enum(['closed', 'pending', 'reversed']) .describe( @@ -52355,19 +50015,19 @@ export namespace stripe { export const GetIssuingAuthorizationsResponseSchema = z.object({ data: z.array(IssuingAuthorizationSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/issuing/authorizations')) @@ -52380,7 +50040,7 @@ export namespace stripe { export const GetIssuingAuthorizationsAuthorizationParamsSchema = z.object({ authorization: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -52434,7 +50094,7 @@ export namespace stripe { > export const GetIssuingCardholdersParamsSchema = z.object({ - /** Only return cardholders that were created during the given date interval. */ + /**Only return cardholders that were created during the given date interval.*/ created: z .union([ z.object({ @@ -52449,12 +50109,12 @@ export namespace stripe { 'Only return cardholders that were created during the given date interval.' ) .optional(), - /** Only return cardholders that have the given email address. */ + /**Only return cardholders that have the given email address.*/ email: z .string() .describe('Only return cardholders that have the given email address.') .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -52462,12 +50122,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -52475,12 +50135,12 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** Only return cardholders that have the given phone number. */ + /**Only return cardholders that have the given phone number.*/ phone_number: z .string() .describe('Only return cardholders that have the given phone number.') .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -52488,14 +50148,14 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** Only return cardholders that have the given status. One of `active`, `inactive`, or `blocked`. */ + /**Only return cardholders that have the given status. One of `active`, `inactive`, or `blocked`.*/ status: z .enum(['active', 'blocked', 'inactive']) .describe( 'Only return cardholders that have the given status. One of `active`, `inactive`, or `blocked`.' ) .optional(), - /** Only return cardholders that have the given type. One of `individual` or `company`. */ + /**Only return cardholders that have the given type. One of `individual` or `company`.*/ type: z .enum(['company', 'individual']) .describe( @@ -52509,19 +50169,19 @@ export namespace stripe { export const GetIssuingCardholdersResponseSchema = z.object({ data: z.array(IssuingCardholderSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/issuing/cardholders')) @@ -52544,7 +50204,7 @@ export namespace stripe { export const GetIssuingCardholdersCardholderParamsSchema = z.object({ cardholder: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -52574,7 +50234,7 @@ export namespace stripe { > export const GetIssuingCardsParamsSchema = z.object({ - /** Only return cards belonging to the Cardholder with the provided ID. */ + /**Only return cards belonging to the Cardholder with the provided ID.*/ cardholder: z .string() .max(5000) @@ -52582,7 +50242,7 @@ export namespace stripe { 'Only return cards belonging to the Cardholder with the provided ID.' ) .optional(), - /** Only return cards that were issued during the given date interval. */ + /**Only return cards that were issued during the given date interval.*/ created: z .union([ z.object({ @@ -52597,7 +50257,7 @@ export namespace stripe { 'Only return cards that were issued during the given date interval.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -52605,30 +50265,30 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Only return cards that have the given expiration month. */ + /**Only return cards that have the given expiration month.*/ exp_month: z .number() .int() .describe('Only return cards that have the given expiration month.') .optional(), - /** Only return cards that have the given expiration year. */ + /**Only return cards that have the given expiration year.*/ exp_year: z .number() .int() .describe('Only return cards that have the given expiration year.') .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** Only return cards that have the given last four digits. */ + /**Only return cards that have the given last four digits.*/ last4: z .string() .max(5000) .describe('Only return cards that have the given last four digits.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -52637,7 +50297,7 @@ export namespace stripe { ) .optional(), personalization_design: z.string().max(5000).optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -52645,14 +50305,14 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** Only return cards that have the given status. One of `active`, `inactive`, or `canceled`. */ + /**Only return cards that have the given status. One of `active`, `inactive`, or `canceled`.*/ status: z .enum(['active', 'canceled', 'inactive']) .describe( 'Only return cards that have the given status. One of `active`, `inactive`, or `canceled`.' ) .optional(), - /** Only return cards that have the given type. One of `virtual` or `physical`. */ + /**Only return cards that have the given type. One of `virtual` or `physical`.*/ type: z .enum(['physical', 'virtual']) .describe( @@ -52666,19 +50326,19 @@ export namespace stripe { export const GetIssuingCardsResponseSchema = z.object({ data: z.array(IssuingCardSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/issuing/cards')) @@ -52701,7 +50361,7 @@ export namespace stripe { export const GetIssuingCardsCardParamsSchema = z.object({ card: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -52729,7 +50389,7 @@ export namespace stripe { > export const GetIssuingDisputesParamsSchema = z.object({ - /** Only return Issuing disputes that were created during the given date interval. */ + /**Only return Issuing disputes that were created during the given date interval.*/ created: z .union([ z.object({ @@ -52744,7 +50404,7 @@ export namespace stripe { 'Only return Issuing disputes that were created during the given date interval.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -52752,12 +50412,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -52765,7 +50425,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -52773,12 +50433,12 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** Select Issuing disputes with the given status. */ + /**Select Issuing disputes with the given status.*/ status: z .enum(['expired', 'lost', 'submitted', 'unsubmitted', 'won']) .describe('Select Issuing disputes with the given status.') .optional(), - /** Select the Issuing dispute for the given transaction. */ + /**Select the Issuing dispute for the given transaction.*/ transaction: z .string() .max(5000) @@ -52791,19 +50451,19 @@ export namespace stripe { export const GetIssuingDisputesResponseSchema = z.object({ data: z.array(IssuingDisputeSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/issuing/disputes')) @@ -52826,7 +50486,7 @@ export namespace stripe { export const GetIssuingDisputesDisputeParamsSchema = z.object({ dispute: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -52867,7 +50527,7 @@ export namespace stripe { > export const GetIssuingPersonalizationDesignsParamsSchema = z.object({ - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -52875,12 +50535,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -52888,14 +50548,14 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** Only return personalization designs with the given lookup keys. */ + /**Only return personalization designs with the given lookup keys.*/ lookup_keys: z .array(z.string().max(200)) .describe( 'Only return personalization designs with the given lookup keys.' ) .optional(), - /** Only return personalization designs with the given preferences. */ + /**Only return personalization designs with the given preferences.*/ preferences: z .object({ is_default: z.boolean().optional(), @@ -52905,7 +50565,7 @@ export namespace stripe { 'Only return personalization designs with the given preferences.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -52913,7 +50573,7 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** Only return personalization designs with the given status. */ + /**Only return personalization designs with the given status.*/ status: z .enum(['active', 'inactive', 'rejected', 'review']) .describe('Only return personalization designs with the given status.') @@ -52925,19 +50585,19 @@ export namespace stripe { export const GetIssuingPersonalizationDesignsResponseSchema = z.object({ data: z.array(IssuingPersonalizationDesignSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/issuing/personalization_designs')) @@ -52962,7 +50622,7 @@ export namespace stripe { export const GetIssuingPersonalizationDesignsPersonalizationDesignParamsSchema = z.object({ personalization_design: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -52995,7 +50655,7 @@ export namespace stripe { > export const GetIssuingPhysicalBundlesParamsSchema = z.object({ - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -53003,12 +50663,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -53016,7 +50676,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -53024,12 +50684,12 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** Only return physical bundles with the given status. */ + /**Only return physical bundles with the given status.*/ status: z .enum(['active', 'inactive', 'review']) .describe('Only return physical bundles with the given status.') .optional(), - /** Only return physical bundles with the given type. */ + /**Only return physical bundles with the given type.*/ type: z .enum(['custom', 'standard']) .describe('Only return physical bundles with the given type.') @@ -53041,19 +50701,19 @@ export namespace stripe { export const GetIssuingPhysicalBundlesResponseSchema = z.object({ data: z.array(IssuingPhysicalBundleSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/issuing/physical_bundles')) @@ -53066,7 +50726,7 @@ export namespace stripe { export const GetIssuingPhysicalBundlesPhysicalBundleParamsSchema = z.object({ physical_bundle: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -53084,7 +50744,7 @@ export namespace stripe { export const GetIssuingSettlementsSettlementParamsSchema = z.object({ settlement: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -53114,12 +50774,12 @@ export namespace stripe { > export const GetIssuingTokensParamsSchema = z.object({ - /** The Issuing card identifier to list tokens for. */ + /**The Issuing card identifier to list tokens for.*/ card: z .string() .max(5000) .describe('The Issuing card identifier to list tokens for.'), - /** Only return Issuing tokens that were created during the given date interval. */ + /**Only return Issuing tokens that were created during the given date interval.*/ created: z .union([ z.object({ @@ -53134,7 +50794,7 @@ export namespace stripe { 'Only return Issuing tokens that were created during the given date interval.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -53142,12 +50802,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -53155,7 +50815,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -53163,7 +50823,7 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** Select Issuing tokens with the given status. */ + /**Select Issuing tokens with the given status.*/ status: z .enum(['active', 'deleted', 'requested', 'suspended']) .describe('Select Issuing tokens with the given status.') @@ -53175,19 +50835,19 @@ export namespace stripe { export const GetIssuingTokensResponseSchema = z.object({ data: z.array(IssuingTokenSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -53199,7 +50859,7 @@ export namespace stripe { export const GetIssuingTokensTokenParamsSchema = z.object({ token: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -53227,19 +50887,19 @@ export namespace stripe { > export const GetIssuingTransactionsParamsSchema = z.object({ - /** Only return transactions that belong to the given card. */ + /**Only return transactions that belong to the given card.*/ card: z .string() .max(5000) .describe('Only return transactions that belong to the given card.') .optional(), - /** Only return transactions that belong to the given cardholder. */ + /**Only return transactions that belong to the given cardholder.*/ cardholder: z .string() .max(5000) .describe('Only return transactions that belong to the given cardholder.') .optional(), - /** Only return transactions that were created during the given date interval. */ + /**Only return transactions that were created during the given date interval.*/ created: z .union([ z.object({ @@ -53254,7 +50914,7 @@ export namespace stripe { 'Only return transactions that were created during the given date interval.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -53262,12 +50922,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -53275,7 +50935,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -53283,7 +50943,7 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** Only return transactions that have the given type. One of `capture` or `refund`. */ + /**Only return transactions that have the given type. One of `capture` or `refund`.*/ type: z .enum(['capture', 'refund']) .describe( @@ -53297,19 +50957,19 @@ export namespace stripe { export const GetIssuingTransactionsResponseSchema = z.object({ data: z.array(IssuingTransactionSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/issuing/transactions')) @@ -53322,7 +50982,7 @@ export namespace stripe { export const GetIssuingTransactionsTransactionParamsSchema = z.object({ transaction: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -53364,7 +51024,7 @@ export namespace stripe { export const GetLinkAccountSessionsSessionParamsSchema = z.object({ session: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -53381,7 +51041,7 @@ export namespace stripe { > export const GetLinkedAccountsParamsSchema = z.object({ - /** If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive. */ + /**If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive.*/ account_holder: z .object({ account: z.string().max(5000).optional(), @@ -53391,7 +51051,7 @@ export namespace stripe { 'If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -53399,12 +51059,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -53412,7 +51072,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** If present, only return accounts that were collected as part of the given session. */ + /**If present, only return accounts that were collected as part of the given session.*/ session: z .string() .max(5000) @@ -53420,7 +51080,7 @@ export namespace stripe { 'If present, only return accounts that were collected as part of the given session.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -53434,23 +51094,23 @@ export namespace stripe { > export const GetLinkedAccountsResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z .array(FinancialConnectionsAccountSchema) .describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/financial_connections/accounts')) @@ -53463,7 +51123,7 @@ export namespace stripe { export const GetLinkedAccountsAccountParamsSchema = z.object({ account: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -53494,7 +51154,7 @@ export namespace stripe { export const GetLinkedAccountsAccountOwnersParamsSchema = z.object({ account: z.string().max(5000), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -53502,12 +51162,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -53515,12 +51175,12 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** The ID of the ownership object to fetch owners from. */ + /**The ID of the ownership object to fetch owners from.*/ ownership: z .string() .max(5000) .describe('The ID of the ownership object to fetch owners from.'), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -53534,23 +51194,23 @@ export namespace stripe { > export const GetLinkedAccountsAccountOwnersResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z .array(FinancialConnectionsAccountOwnerSchema) .describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -53575,7 +51235,7 @@ export namespace stripe { export const GetMandatesMandateParamsSchema = z.object({ mandate: z.string(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -53591,7 +51251,7 @@ export namespace stripe { > export const GetPaymentIntentsParamsSchema = z.object({ - /** A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp or a dictionary with a number of different query options. */ + /**A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp or a dictionary with a number of different query options.*/ created: z .union([ z.object({ @@ -53606,7 +51266,7 @@ export namespace stripe { 'A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp or a dictionary with a number of different query options.' ) .optional(), - /** Only return PaymentIntents for the customer that this customer ID specifies. */ + /**Only return PaymentIntents for the customer that this customer ID specifies.*/ customer: z .string() .max(5000) @@ -53614,7 +51274,7 @@ export namespace stripe { 'Only return PaymentIntents for the customer that this customer ID specifies.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -53622,12 +51282,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -53635,7 +51295,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -53650,19 +51310,19 @@ export namespace stripe { export const GetPaymentIntentsResponseSchema = z.object({ data: z.array(PaymentIntentSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/payment_intents')) @@ -53684,12 +51344,12 @@ export namespace stripe { > export const GetPaymentIntentsSearchParamsSchema = z.object({ - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -53697,7 +51357,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. */ + /**A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.*/ page: z .string() .max(5000) @@ -53705,7 +51365,7 @@ export namespace stripe { "A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results." ) .optional(), - /** The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for payment intents](https://stripe.com/docs/search#query-fields-for-payment-intents). */ + /**The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for payment intents](https://stripe.com/docs/search#query-fields-for-payment-intents).*/ query: z .string() .max(5000) @@ -53720,14 +51380,14 @@ export namespace stripe { export const GetPaymentIntentsSearchResponseSchema = z.object({ data: z.array(PaymentIntentSchema), has_more: z.boolean(), - next_page: z.string().max(5000).nullable().optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + next_page: z.string().max(5000).optional(), + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('search_result') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The total number of objects that match the query, only accurate up to 10,000. */ + /**The total number of objects that match the query, only accurate up to 10,000.*/ total_count: z .number() .int() @@ -53743,7 +51403,7 @@ export namespace stripe { export const GetPaymentIntentsIntentParamsSchema = z.object({ intent: z.string().max(5000), - /** The client secret of the PaymentIntent. We require it if you use a publishable key to retrieve the source. */ + /**The client secret of the PaymentIntent. We require it if you use a publishable key to retrieve the source.*/ client_secret: z .string() .max(5000) @@ -53751,7 +51411,7 @@ export namespace stripe { 'The client secret of the PaymentIntent. We require it if you use a publishable key to retrieve the source.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -53854,14 +51514,14 @@ export namespace stripe { > export const GetPaymentLinksParamsSchema = z.object({ - /** Only return payment links that are active or inactive (e.g., pass `false` to list all inactive payment links). */ + /**Only return payment links that are active or inactive (e.g., pass `false` to list all inactive payment links).*/ active: z .boolean() .describe( 'Only return payment links that are active or inactive (e.g., pass `false` to list all inactive payment links).' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -53869,12 +51529,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -53882,7 +51542,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -53897,19 +51557,19 @@ export namespace stripe { export const GetPaymentLinksResponseSchema = z.object({ data: z.array(PaymentLinkSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/payment_links')) @@ -53932,7 +51592,7 @@ export namespace stripe { export const GetPaymentLinksPaymentLinkParamsSchema = z.object({ payment_link: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -53961,7 +51621,7 @@ export namespace stripe { export const GetPaymentLinksPaymentLinkLineItemsParamsSchema = z.object({ payment_link: z.string().max(5000), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -53969,12 +51629,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -53982,7 +51642,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -53996,21 +51656,21 @@ export namespace stripe { > export const GetPaymentLinksPaymentLinkLineItemsResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z.array(ItemSchema).describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -54021,12 +51681,12 @@ export namespace stripe { > export const GetPaymentMethodConfigurationsParamsSchema = z.object({ - /** The Connect application to filter by. */ + /**The Connect application to filter by.*/ application: z .union([z.string().max(100), z.literal('')]) .describe('The Connect application to filter by.') .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -54034,12 +51694,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -54047,7 +51707,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -54062,19 +51722,19 @@ export namespace stripe { export const GetPaymentMethodConfigurationsResponseSchema = z.object({ data: z.array(PaymentMethodConfigurationSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/payment_method_configurations')) @@ -54099,7 +51759,7 @@ export namespace stripe { export const GetPaymentMethodConfigurationsConfigurationParamsSchema = z.object({ configuration: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -54128,7 +51788,7 @@ export namespace stripe { > export const GetPaymentMethodDomainsParamsSchema = z.object({ - /** The domain name that this payment method domain object represents. */ + /**The domain name that this payment method domain object represents.*/ domain_name: z .string() .max(5000) @@ -54136,14 +51796,14 @@ export namespace stripe { 'The domain name that this payment method domain object represents.' ) .optional(), - /** Whether this payment method domain is enabled. If the domain is not enabled, payment methods will not appear in Elements */ + /**Whether this payment method domain is enabled. If the domain is not enabled, payment methods will not appear in Elements*/ enabled: z .boolean() .describe( 'Whether this payment method domain is enabled. If the domain is not enabled, payment methods will not appear in Elements' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -54151,12 +51811,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -54164,7 +51824,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -54179,19 +51839,19 @@ export namespace stripe { export const GetPaymentMethodDomainsResponseSchema = z.object({ data: z.array(PaymentMethodDomainSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/payment_method_domains')) @@ -54216,7 +51876,7 @@ export namespace stripe { export const GetPaymentMethodDomainsPaymentMethodDomainParamsSchema = z.object({ payment_method_domain: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -54259,7 +51919,7 @@ export namespace stripe { > export const GetPaymentMethodsParamsSchema = z.object({ - /** The ID of the customer whose PaymentMethods will be retrieved. */ + /**The ID of the customer whose PaymentMethods will be retrieved.*/ customer: z .string() .max(5000) @@ -54267,7 +51927,7 @@ export namespace stripe { 'The ID of the customer whose PaymentMethods will be retrieved.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -54275,12 +51935,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -54288,7 +51948,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -54296,7 +51956,7 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request. */ + /**An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request.*/ type: z .enum([ 'acss_debit', @@ -54355,19 +52015,19 @@ export namespace stripe { export const GetPaymentMethodsResponseSchema = z.object({ data: z.array(PaymentMethodSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/payment_methods')) @@ -54390,7 +52050,7 @@ export namespace stripe { export const GetPaymentMethodsPaymentMethodParamsSchema = z.object({ payment_method: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -54446,7 +52106,7 @@ export namespace stripe { > export const GetPayoutsParamsSchema = z.object({ - /** Only return payouts that are expected to arrive during the given date interval. */ + /**Only return payouts that are expected to arrive during the given date interval.*/ arrival_date: z .union([ z.object({ @@ -54461,7 +52121,7 @@ export namespace stripe { 'Only return payouts that are expected to arrive during the given date interval.' ) .optional(), - /** Only return payouts that were created during the given date interval. */ + /**Only return payouts that were created during the given date interval.*/ created: z .union([ z.object({ @@ -54476,14 +52136,14 @@ export namespace stripe { 'Only return payouts that were created during the given date interval.' ) .optional(), - /** The ID of an external account - only return payouts sent to this external account. */ + /**The ID of an external account - only return payouts sent to this external account.*/ destination: z .string() .describe( 'The ID of an external account - only return payouts sent to this external account.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -54491,12 +52151,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -54504,7 +52164,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -54512,7 +52172,7 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** Only return payouts that have the given status: `pending`, `paid`, `failed`, or `canceled`. */ + /**Only return payouts that have the given status: `pending`, `paid`, `failed`, or `canceled`.*/ status: z .string() .max(5000) @@ -54525,19 +52185,19 @@ export namespace stripe { export const GetPayoutsResponseSchema = z.object({ data: z.array(PayoutSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/payouts')) @@ -54554,7 +52214,7 @@ export namespace stripe { export const GetPayoutsPayoutParamsSchema = z.object({ payout: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -54606,14 +52266,14 @@ export namespace stripe { > export const GetPlansParamsSchema = z.object({ - /** Only return plans that are active or inactive (e.g., pass `false` to list all inactive plans). */ + /**Only return plans that are active or inactive (e.g., pass `false` to list all inactive plans).*/ active: z .boolean() .describe( 'Only return plans that are active or inactive (e.g., pass `false` to list all inactive plans).' ) .optional(), - /** A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. */ + /**A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.*/ created: z .union([ z.object({ @@ -54628,7 +52288,7 @@ export namespace stripe { 'A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -54636,12 +52296,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -54649,13 +52309,13 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** Only return plans for the given product. */ + /**Only return plans for the given product.*/ product: z .string() .max(5000) .describe('Only return plans for the given product.') .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -54667,21 +52327,21 @@ export namespace stripe { export type GetPlansParams = z.infer export const GetPlansResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z.array(PlanSchema).describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/plans')) @@ -54698,7 +52358,7 @@ export namespace stripe { export const GetPlansPlanParamsSchema = z.object({ plan: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -54732,14 +52392,14 @@ export namespace stripe { > export const GetPricesParamsSchema = z.object({ - /** Only return prices that are active or inactive (e.g., pass `false` to list all inactive prices). */ + /**Only return prices that are active or inactive (e.g., pass `false` to list all inactive prices).*/ active: z .boolean() .describe( 'Only return prices that are active or inactive (e.g., pass `false` to list all inactive prices).' ) .optional(), - /** A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. */ + /**A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.*/ created: z .union([ z.object({ @@ -54754,12 +52414,12 @@ export namespace stripe { 'A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.' ) .optional(), - /** Only return prices for the given currency. */ + /**Only return prices for the given currency.*/ currency: z .string() .describe('Only return prices for the given currency.') .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -54767,12 +52427,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -54780,20 +52440,20 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** Only return the price with these lookup_keys, if any exist. You can specify up to 10 lookup_keys. */ + /**Only return the price with these lookup_keys, if any exist. You can specify up to 10 lookup_keys.*/ lookup_keys: z .array(z.string().max(5000)) .describe( 'Only return the price with these lookup_keys, if any exist. You can specify up to 10 lookup_keys.' ) .optional(), - /** Only return prices for the given product. */ + /**Only return prices for the given product.*/ product: z .string() .max(5000) .describe('Only return prices for the given product.') .optional(), - /** Only return prices with these recurring fields. */ + /**Only return prices with these recurring fields.*/ recurring: z .object({ interval: z.enum(['day', 'month', 'week', 'year']).optional(), @@ -54802,7 +52462,7 @@ export namespace stripe { }) .describe('Only return prices with these recurring fields.') .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -54810,7 +52470,7 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** Only return prices of type `recurring` or `one_time`. */ + /**Only return prices of type `recurring` or `one_time`.*/ type: z .enum(['one_time', 'recurring']) .describe('Only return prices of type `recurring` or `one_time`.') @@ -54819,21 +52479,21 @@ export namespace stripe { export type GetPricesParams = z.infer export const GetPricesResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z.array(PriceSchema).describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/prices')) @@ -54849,12 +52509,12 @@ export namespace stripe { export type PostPricesResponse = z.infer export const GetPricesSearchParamsSchema = z.object({ - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -54862,7 +52522,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. */ + /**A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.*/ page: z .string() .max(5000) @@ -54870,7 +52530,7 @@ export namespace stripe { "A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results." ) .optional(), - /** The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for prices](https://stripe.com/docs/search#query-fields-for-prices). */ + /**The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for prices](https://stripe.com/docs/search#query-fields-for-prices).*/ query: z .string() .max(5000) @@ -54885,14 +52545,14 @@ export namespace stripe { export const GetPricesSearchResponseSchema = z.object({ data: z.array(PriceSchema), has_more: z.boolean(), - next_page: z.string().max(5000).nullable().optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + next_page: z.string().max(5000).optional(), + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('search_result') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The total number of objects that match the query, only accurate up to 10,000. */ + /**The total number of objects that match the query, only accurate up to 10,000.*/ total_count: z .number() .int() @@ -54908,7 +52568,7 @@ export namespace stripe { export const GetPricesPriceParamsSchema = z.object({ price: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -54934,14 +52594,14 @@ export namespace stripe { > export const GetProductsParamsSchema = z.object({ - /** Only return products that are active or inactive (e.g., pass `false` to list all inactive products). */ + /**Only return products that are active or inactive (e.g., pass `false` to list all inactive products).*/ active: z .boolean() .describe( 'Only return products that are active or inactive (e.g., pass `false` to list all inactive products).' ) .optional(), - /** Only return products that were created during the given date interval. */ + /**Only return products that were created during the given date interval.*/ created: z .union([ z.object({ @@ -54956,7 +52616,7 @@ export namespace stripe { 'Only return products that were created during the given date interval.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -54964,19 +52624,19 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** Only return products with the given IDs. Cannot be used with [starting_after](https://stripe.com/docs/api#list_products-starting_after) or [ending_before](https://stripe.com/docs/api#list_products-ending_before). */ + /**Only return products with the given IDs. Cannot be used with [starting_after](https://stripe.com/docs/api#list_products-starting_after) or [ending_before](https://stripe.com/docs/api#list_products-ending_before).*/ ids: z .array(z.string().max(5000)) .describe( 'Only return products with the given IDs. Cannot be used with [starting_after](https://stripe.com/docs/api#list_products-starting_after) or [ending_before](https://stripe.com/docs/api#list_products-ending_before).' ) .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -54984,14 +52644,14 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** Only return products that can be shipped (i.e., physical, not digital products). */ + /**Only return products that can be shipped (i.e., physical, not digital products).*/ shippable: z .boolean() .describe( 'Only return products that can be shipped (i.e., physical, not digital products).' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -54999,7 +52659,7 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** Only return products with the given url. */ + /**Only return products with the given url.*/ url: z .string() .max(5000) @@ -55009,21 +52669,21 @@ export namespace stripe { export type GetProductsParams = z.infer export const GetProductsResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z.array(ProductSchema).describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/products')) @@ -55039,12 +52699,12 @@ export namespace stripe { export type PostProductsResponse = z.infer export const GetProductsSearchParamsSchema = z.object({ - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -55052,7 +52712,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. */ + /**A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.*/ page: z .string() .max(5000) @@ -55060,7 +52720,7 @@ export namespace stripe { "A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results." ) .optional(), - /** The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for products](https://stripe.com/docs/search#query-fields-for-products). */ + /**The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for products](https://stripe.com/docs/search#query-fields-for-products).*/ query: z .string() .max(5000) @@ -55075,14 +52735,14 @@ export namespace stripe { export const GetProductsSearchResponseSchema = z.object({ data: z.array(ProductSchema), has_more: z.boolean(), - next_page: z.string().max(5000).nullable().optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + next_page: z.string().max(5000).optional(), + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('search_result') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The total number of objects that match the query, only accurate up to 10,000. */ + /**The total number of objects that match the query, only accurate up to 10,000.*/ total_count: z .number() .int() @@ -55098,7 +52758,7 @@ export namespace stripe { export const GetProductsIdParamsSchema = z.object({ id: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -55135,7 +52795,7 @@ export namespace stripe { export const GetProductsProductFeaturesParamsSchema = z.object({ product: z.string().max(5000), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -55143,12 +52803,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -55156,7 +52816,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -55171,19 +52831,19 @@ export namespace stripe { export const GetProductsProductFeaturesResponseSchema = z.object({ data: z.array(ProductFeatureSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -55206,11 +52866,11 @@ export namespace stripe { > export const GetProductsProductFeaturesIdParamsSchema = z.object({ - /** The ID of the product_feature. */ + /**The ID of the product_feature.*/ id: z.string().max(5000).describe('The ID of the product_feature.'), - /** The ID of the product. */ + /**The ID of the product.*/ product: z.string().max(5000).describe('The ID of the product.'), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -55240,12 +52900,12 @@ export namespace stripe { > export const GetPromotionCodesParamsSchema = z.object({ - /** Filter promotion codes by whether they are active. */ + /**Filter promotion codes by whether they are active.*/ active: z .boolean() .describe('Filter promotion codes by whether they are active.') .optional(), - /** Only return promotion codes that have this case-insensitive code. */ + /**Only return promotion codes that have this case-insensitive code.*/ code: z .string() .max(5000) @@ -55253,13 +52913,13 @@ export namespace stripe { 'Only return promotion codes that have this case-insensitive code.' ) .optional(), - /** Only return promotion codes for this coupon. */ + /**Only return promotion codes for this coupon.*/ coupon: z .string() .max(5000) .describe('Only return promotion codes for this coupon.') .optional(), - /** A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. */ + /**A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.*/ created: z .union([ z.object({ @@ -55274,7 +52934,7 @@ export namespace stripe { 'A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.' ) .optional(), - /** Only return promotion codes that are restricted to this customer. */ + /**Only return promotion codes that are restricted to this customer.*/ customer: z .string() .max(5000) @@ -55282,7 +52942,7 @@ export namespace stripe { 'Only return promotion codes that are restricted to this customer.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -55290,12 +52950,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -55303,7 +52963,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -55318,19 +52978,19 @@ export namespace stripe { export const GetPromotionCodesResponseSchema = z.object({ data: z.array(PromotionCodeSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/promotion_codes')) @@ -55353,7 +53013,7 @@ export namespace stripe { export const GetPromotionCodesPromotionCodeParamsSchema = z.object({ promotion_code: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -55383,13 +53043,13 @@ export namespace stripe { > export const GetQuotesParamsSchema = z.object({ - /** The ID of the customer whose quotes will be retrieved. */ + /**The ID of the customer whose quotes will be retrieved.*/ customer: z .string() .max(5000) .describe('The ID of the customer whose quotes will be retrieved.') .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -55397,12 +53057,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -55410,7 +53070,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -55418,12 +53078,12 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** The status of the quote. */ + /**The status of the quote.*/ status: z .enum(['accepted', 'canceled', 'draft', 'open']) .describe('The status of the quote.') .optional(), - /** Provides a list of quotes that are associated with the specified test clock. The response will not include quotes with test clocks if this and the customer parameter is not set. */ + /**Provides a list of quotes that are associated with the specified test clock. The response will not include quotes with test clocks if this and the customer parameter is not set.*/ test_clock: z .string() .max(5000) @@ -55436,19 +53096,19 @@ export namespace stripe { export const GetQuotesResponseSchema = z.object({ data: z.array(QuoteSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/quotes')) @@ -55465,7 +53125,7 @@ export namespace stripe { export const GetQuotesQuoteParamsSchema = z.object({ quote: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -55516,7 +53176,7 @@ export namespace stripe { export const GetQuotesQuoteComputedUpfrontLineItemsParamsSchema = z.object({ quote: z.string().max(5000), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -55524,12 +53184,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -55537,7 +53197,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -55551,21 +53211,21 @@ export namespace stripe { > export const GetQuotesQuoteComputedUpfrontLineItemsResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z.array(ItemSchema).describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -55589,7 +53249,7 @@ export namespace stripe { export const GetQuotesQuoteLineItemsParamsSchema = z.object({ quote: z.string().max(5000), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -55597,12 +53257,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -55610,7 +53270,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -55624,21 +53284,21 @@ export namespace stripe { > export const GetQuotesQuoteLineItemsResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z.array(ItemSchema).describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -55650,7 +53310,7 @@ export namespace stripe { export const GetQuotesQuotePdfParamsSchema = z.object({ quote: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -55663,14 +53323,14 @@ export namespace stripe { export type GetQuotesQuotePdfResponse = undefined export const GetRadarEarlyFraudWarningsParamsSchema = z.object({ - /** Only return early fraud warnings for the charge specified by this charge ID. */ + /**Only return early fraud warnings for the charge specified by this charge ID.*/ charge: z .string() .describe( 'Only return early fraud warnings for the charge specified by this charge ID.' ) .optional(), - /** Only return early fraud warnings that were created during the given date interval. */ + /**Only return early fraud warnings that were created during the given date interval.*/ created: z .union([ z.object({ @@ -55685,7 +53345,7 @@ export namespace stripe { 'Only return early fraud warnings that were created during the given date interval.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -55693,12 +53353,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -55706,7 +53366,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** Only return early fraud warnings for charges that were created by the PaymentIntent specified by this PaymentIntent ID. */ + /**Only return early fraud warnings for charges that were created by the PaymentIntent specified by this PaymentIntent ID.*/ payment_intent: z .string() .max(5000) @@ -55714,7 +53374,7 @@ export namespace stripe { 'Only return early fraud warnings for charges that were created by the PaymentIntent specified by this PaymentIntent ID.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -55729,19 +53389,19 @@ export namespace stripe { export const GetRadarEarlyFraudWarningsResponseSchema = z.object({ data: z.array(RadarEarlyFraudWarningSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/radar/early_fraud_warnings')) @@ -55755,7 +53415,7 @@ export namespace stripe { export const GetRadarEarlyFraudWarningsEarlyFraudWarningParamsSchema = z.object({ early_fraud_warning: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -55772,7 +53432,7 @@ export namespace stripe { > export const GetRadarValueListItemsParamsSchema = z.object({ - /** Only return items that were created during the given date interval. */ + /**Only return items that were created during the given date interval.*/ created: z .union([ z.object({ @@ -55787,7 +53447,7 @@ export namespace stripe { 'Only return items that were created during the given date interval.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -55795,12 +53455,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -55808,7 +53468,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -55816,7 +53476,7 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** Return items belonging to the parent list whose value matches the specified value (using an "is like" match). */ + /**Return items belonging to the parent list whose value matches the specified value (using an "is like" match).*/ value: z .string() .max(800) @@ -55824,7 +53484,7 @@ export namespace stripe { 'Return items belonging to the parent list whose value matches the specified value (using an "is like" match).' ) .optional(), - /** Identifier for the parent value list this item belongs to. */ + /**Identifier for the parent value list this item belongs to.*/ value_list: z .string() .max(5000) @@ -55836,19 +53496,19 @@ export namespace stripe { export const GetRadarValueListItemsResponseSchema = z.object({ data: z.array(RadarValueListItemSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/radar/value_list_items')) @@ -55871,7 +53531,7 @@ export namespace stripe { export const GetRadarValueListItemsItemParamsSchema = z.object({ item: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -55901,7 +53561,7 @@ export namespace stripe { > export const GetRadarValueListsParamsSchema = z.object({ - /** The alias used to reference the value list when writing rules. */ + /**The alias used to reference the value list when writing rules.*/ alias: z .string() .max(100) @@ -55909,7 +53569,7 @@ export namespace stripe { 'The alias used to reference the value list when writing rules.' ) .optional(), - /** A value contained within a value list - returns all value lists containing this value. */ + /**A value contained within a value list - returns all value lists containing this value.*/ contains: z .string() .max(800) @@ -55917,7 +53577,7 @@ export namespace stripe { 'A value contained within a value list - returns all value lists containing this value.' ) .optional(), - /** Only return value lists that were created during the given date interval. */ + /**Only return value lists that were created during the given date interval.*/ created: z .union([ z.object({ @@ -55932,7 +53592,7 @@ export namespace stripe { 'Only return value lists that were created during the given date interval.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -55940,12 +53600,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -55953,7 +53613,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -55968,19 +53628,19 @@ export namespace stripe { export const GetRadarValueListsResponseSchema = z.object({ data: z.array(RadarValueListSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/radar/value_lists')) @@ -56003,7 +53663,7 @@ export namespace stripe { export const GetRadarValueListsValueListParamsSchema = z.object({ value_list: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -56044,14 +53704,14 @@ export namespace stripe { > export const GetRefundsParamsSchema = z.object({ - /** Only return refunds for the charge specified by this charge ID. */ + /**Only return refunds for the charge specified by this charge ID.*/ charge: z .string() .describe( 'Only return refunds for the charge specified by this charge ID.' ) .optional(), - /** Only return refunds that were created during the given date interval. */ + /**Only return refunds that were created during the given date interval.*/ created: z .union([ z.object({ @@ -56066,19 +53726,19 @@ export namespace stripe { 'Only return refunds that were created during the given date interval.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .describe( 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -56086,7 +53746,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** Only return refunds for the PaymentIntent specified by this ID. */ + /**Only return refunds for the PaymentIntent specified by this ID.*/ payment_intent: z .string() .max(5000) @@ -56094,7 +53754,7 @@ export namespace stripe { 'Only return refunds for the PaymentIntent specified by this ID.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .describe( @@ -56106,19 +53766,19 @@ export namespace stripe { export const GetRefundsResponseSchema = z.object({ data: z.array(RefundSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/refunds')) @@ -56135,7 +53795,7 @@ export namespace stripe { export const GetRefundsRefundParamsSchema = z.object({ refund: z.string(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -56173,7 +53833,7 @@ export namespace stripe { > export const GetReportingReportRunsParamsSchema = z.object({ - /** Only return Report Runs that were created during the given date interval. */ + /**Only return Report Runs that were created during the given date interval.*/ created: z .union([ z.object({ @@ -56188,7 +53848,7 @@ export namespace stripe { 'Only return Report Runs that were created during the given date interval.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -56196,12 +53856,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -56209,7 +53869,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -56224,19 +53884,19 @@ export namespace stripe { export const GetReportingReportRunsResponseSchema = z.object({ data: z.array(ReportingReportRunSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/reporting/report_runs')) @@ -56259,7 +53919,7 @@ export namespace stripe { export const GetReportingReportRunsReportRunParamsSchema = z.object({ report_run: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -56276,7 +53936,7 @@ export namespace stripe { > export const GetReportingReportTypesParamsSchema = z.object({ - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -56288,19 +53948,19 @@ export namespace stripe { export const GetReportingReportTypesResponseSchema = z.object({ data: z.array(ReportingReportTypeSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -56312,7 +53972,7 @@ export namespace stripe { export const GetReportingReportTypesReportTypeParamsSchema = z.object({ report_type: z.string(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -56329,7 +53989,7 @@ export namespace stripe { > export const GetReviewsParamsSchema = z.object({ - /** Only return reviews that were created during the given date interval. */ + /**Only return reviews that were created during the given date interval.*/ created: z .union([ z.object({ @@ -56344,7 +54004,7 @@ export namespace stripe { 'Only return reviews that were created during the given date interval.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -56352,12 +54012,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -56365,7 +54025,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -56378,19 +54038,19 @@ export namespace stripe { export const GetReviewsResponseSchema = z.object({ data: z.array(ReviewSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -56400,7 +54060,7 @@ export namespace stripe { export const GetReviewsReviewParamsSchema = z.object({ review: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -56447,7 +54107,7 @@ export namespace stripe { 'A filter on the list, based on the object `created` field. The value\ncan be a string with an integer Unix timestamp or a\ndictionary with a number of different query options.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -56455,12 +54115,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -56478,7 +54138,7 @@ export namespace stripe { .describe( 'Only return SetupAttempts created by the SetupIntent specified by\nthis ID.' ), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -56493,19 +54153,19 @@ export namespace stripe { export const GetSetupAttemptsResponseSchema = z.object({ data: z.array(SetupAttemptSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/setup_attempts')) @@ -56528,7 +54188,7 @@ export namespace stripe { "If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.\n\nIt can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer." ) .optional(), - /** A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. */ + /**A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.*/ created: z .union([ z.object({ @@ -56543,7 +54203,7 @@ export namespace stripe { 'A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.' ) .optional(), - /** Only return SetupIntents for the customer specified by this customer ID. */ + /**Only return SetupIntents for the customer specified by this customer ID.*/ customer: z .string() .max(5000) @@ -56551,7 +54211,7 @@ export namespace stripe { 'Only return SetupIntents for the customer specified by this customer ID.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -56559,12 +54219,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -56572,7 +54232,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** Only return SetupIntents that associate with the specified payment method. */ + /**Only return SetupIntents that associate with the specified payment method.*/ payment_method: z .string() .max(5000) @@ -56580,7 +54240,7 @@ export namespace stripe { 'Only return SetupIntents that associate with the specified payment method.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -56595,19 +54255,19 @@ export namespace stripe { export const GetSetupIntentsResponseSchema = z.object({ data: z.array(SetupIntentSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/setup_intents')) @@ -56630,7 +54290,7 @@ export namespace stripe { export const GetSetupIntentsIntentParamsSchema = z.object({ intent: z.string().max(5000), - /** The client secret of the SetupIntent. We require this string if you use a publishable key to retrieve the SetupIntent. */ + /**The client secret of the SetupIntent. We require this string if you use a publishable key to retrieve the SetupIntent.*/ client_secret: z .string() .max(5000) @@ -56638,7 +54298,7 @@ export namespace stripe { 'The client secret of the SetupIntent. We require this string if you use a publishable key to retrieve the SetupIntent.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -56703,12 +54363,12 @@ export namespace stripe { > export const GetShippingRatesParamsSchema = z.object({ - /** Only return shipping rates that are active or inactive. */ + /**Only return shipping rates that are active or inactive.*/ active: z .boolean() .describe('Only return shipping rates that are active or inactive.') .optional(), - /** A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. */ + /**A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.*/ created: z .union([ z.object({ @@ -56723,12 +54383,12 @@ export namespace stripe { 'A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.' ) .optional(), - /** Only return shipping rates for the given currency. */ + /**Only return shipping rates for the given currency.*/ currency: z .string() .describe('Only return shipping rates for the given currency.') .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -56736,12 +54396,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -56749,7 +54409,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -56764,19 +54424,19 @@ export namespace stripe { export const GetShippingRatesResponseSchema = z.object({ data: z.array(ShippingRateSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/shipping_rates')) @@ -56799,7 +54459,7 @@ export namespace stripe { export const GetShippingRatesShippingRateTokenParamsSchema = z.object({ shipping_rate_token: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -56829,7 +54489,7 @@ export namespace stripe { > export const GetSigmaScheduledQueryRunsParamsSchema = z.object({ - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -56837,12 +54497,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -56850,7 +54510,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -56865,19 +54525,19 @@ export namespace stripe { export const GetSigmaScheduledQueryRunsResponseSchema = z.object({ data: z.array(ScheduledQueryRunSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/sigma/scheduled_query_runs')) @@ -56891,7 +54551,7 @@ export namespace stripe { export const GetSigmaScheduledQueryRunsScheduledQueryRunParamsSchema = z.object({ scheduled_query_run: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -56915,7 +54575,7 @@ export namespace stripe { export const GetSourcesSourceParamsSchema = z.object({ source: z.string().max(5000), - /** The client secret of the source. Required if a publishable key is used to retrieve the source. */ + /**The client secret of the source. Required if a publishable key is used to retrieve the source.*/ client_secret: z .string() .max(5000) @@ -56923,7 +54583,7 @@ export namespace stripe { 'The client secret of the source. Required if a publishable key is used to retrieve the source.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -56954,7 +54614,7 @@ export namespace stripe { z.object({ mandate_notification: z.string().max(5000), source: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -56974,7 +54634,7 @@ export namespace stripe { export const GetSourcesSourceSourceTransactionsParamsSchema = z.object({ source: z.string().max(5000), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -56982,12 +54642,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -56995,7 +54655,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -57010,19 +54670,19 @@ export namespace stripe { export const GetSourcesSourceSourceTransactionsResponseSchema = z.object({ data: z.array(SourceTransactionSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -57036,7 +54696,7 @@ export namespace stripe { z.object({ source: z.string().max(5000), source_transaction: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -57067,19 +54727,19 @@ export namespace stripe { > export const GetSubscriptionItemsParamsSchema = z.object({ - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .describe( 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -57087,14 +54747,14 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .describe( 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** The ID of the subscription whose items will be retrieved. */ + /**The ID of the subscription whose items will be retrieved.*/ subscription: z .string() .max(5000) @@ -57106,19 +54766,19 @@ export namespace stripe { export const GetSubscriptionItemsResponseSchema = z.object({ data: z.array(SubscriptionItemSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/subscription_items')) @@ -57141,7 +54801,7 @@ export namespace stripe { export const GetSubscriptionItemsItemParamsSchema = z.object({ item: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -57184,7 +54844,7 @@ export namespace stripe { export const GetSubscriptionItemsSubscriptionItemUsageRecordSummariesParamsSchema = z.object({ subscription_item: z.string(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -57192,12 +54852,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -57205,7 +54865,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -57222,19 +54882,19 @@ export namespace stripe { export const GetSubscriptionItemsSubscriptionItemUsageRecordSummariesResponseSchema = z.object({ data: z.array(UsageRecordSummarySchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -57259,7 +54919,7 @@ export namespace stripe { > export const GetSubscriptionSchedulesParamsSchema = z.object({ - /** Only return subscription schedules that were created canceled the given date interval. */ + /**Only return subscription schedules that were created canceled the given date interval.*/ canceled_at: z .union([ z.object({ @@ -57274,7 +54934,7 @@ export namespace stripe { 'Only return subscription schedules that were created canceled the given date interval.' ) .optional(), - /** Only return subscription schedules that completed during the given date interval. */ + /**Only return subscription schedules that completed during the given date interval.*/ completed_at: z .union([ z.object({ @@ -57289,7 +54949,7 @@ export namespace stripe { 'Only return subscription schedules that completed during the given date interval.' ) .optional(), - /** Only return subscription schedules that were created during the given date interval. */ + /**Only return subscription schedules that were created during the given date interval.*/ created: z .union([ z.object({ @@ -57304,13 +54964,13 @@ export namespace stripe { 'Only return subscription schedules that were created during the given date interval.' ) .optional(), - /** Only return subscription schedules for the given customer. */ + /**Only return subscription schedules for the given customer.*/ customer: z .string() .max(5000) .describe('Only return subscription schedules for the given customer.') .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -57318,12 +54978,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -57331,7 +54991,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** Only return subscription schedules that were released during the given date interval. */ + /**Only return subscription schedules that were released during the given date interval.*/ released_at: z .union([ z.object({ @@ -57346,12 +55006,12 @@ export namespace stripe { 'Only return subscription schedules that were released during the given date interval.' ) .optional(), - /** Only return subscription schedules that have not started yet. */ + /**Only return subscription schedules that have not started yet.*/ scheduled: z .boolean() .describe('Only return subscription schedules that have not started yet.') .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -57366,19 +55026,19 @@ export namespace stripe { export const GetSubscriptionSchedulesResponseSchema = z.object({ data: z.array(SubscriptionScheduleSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/subscription_schedules')) @@ -57402,7 +55062,7 @@ export namespace stripe { export const GetSubscriptionSchedulesScheduleParamsSchema = z.object({ schedule: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -57458,19 +55118,19 @@ export namespace stripe { > export const GetSubscriptionsParamsSchema = z.object({ - /** Filter subscriptions by their automatic tax settings. */ + /**Filter subscriptions by their automatic tax settings.*/ automatic_tax: z .object({ enabled: z.boolean() }) .describe('Filter subscriptions by their automatic tax settings.') .optional(), - /** The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`. */ + /**The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`.*/ collection_method: z .enum(['charge_automatically', 'send_invoice']) .describe( 'The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`.' ) .optional(), - /** Only return subscriptions that were created during the given date interval. */ + /**Only return subscriptions that were created during the given date interval.*/ created: z .union([ z.object({ @@ -57485,7 +55145,7 @@ export namespace stripe { 'Only return subscriptions that were created during the given date interval.' ) .optional(), - /** Only return subscriptions whose current_period_end falls within the given date interval. */ + /**Only return subscriptions whose current_period_end falls within the given date interval.*/ current_period_end: z .union([ z.object({ @@ -57500,7 +55160,7 @@ export namespace stripe { 'Only return subscriptions whose current_period_end falls within the given date interval.' ) .optional(), - /** Only return subscriptions whose current_period_start falls within the given date interval. */ + /**Only return subscriptions whose current_period_start falls within the given date interval.*/ current_period_start: z .union([ z.object({ @@ -57515,13 +55175,13 @@ export namespace stripe { 'Only return subscriptions whose current_period_start falls within the given date interval.' ) .optional(), - /** The ID of the customer whose subscriptions will be retrieved. */ + /**The ID of the customer whose subscriptions will be retrieved.*/ customer: z .string() .max(5000) .describe('The ID of the customer whose subscriptions will be retrieved.') .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -57529,12 +55189,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -57542,7 +55202,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** Filter for subscriptions that contain this recurring price ID. */ + /**Filter for subscriptions that contain this recurring price ID.*/ price: z .string() .max(5000) @@ -57550,7 +55210,7 @@ export namespace stripe { 'Filter for subscriptions that contain this recurring price ID.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -57558,7 +55218,7 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** The status of the subscriptions to retrieve. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to [incomplete payment](https://stripe.com/docs/billing/subscriptions/overview#subscription-statuses). Passing in a value of `all` will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned. */ + /**The status of the subscriptions to retrieve. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to [incomplete payment](https://stripe.com/docs/billing/subscriptions/overview#subscription-statuses). Passing in a value of `all` will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned.*/ status: z .enum([ 'active', @@ -57576,7 +55236,7 @@ export namespace stripe { 'The status of the subscriptions to retrieve. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to [incomplete payment](https://stripe.com/docs/billing/subscriptions/overview#subscription-statuses). Passing in a value of `all` will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned.' ) .optional(), - /** Filter for subscriptions that are associated with the specified test clock. The response will not include subscriptions with test clocks if this and the customer parameter is not set. */ + /**Filter for subscriptions that are associated with the specified test clock. The response will not include subscriptions with test clocks if this and the customer parameter is not set.*/ test_clock: z .string() .max(5000) @@ -57591,19 +55251,19 @@ export namespace stripe { export const GetSubscriptionsResponseSchema = z.object({ data: z.array(SubscriptionSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/subscriptions')) @@ -57625,12 +55285,12 @@ export namespace stripe { > export const GetSubscriptionsSearchParamsSchema = z.object({ - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -57638,7 +55298,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. */ + /**A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.*/ page: z .string() .max(5000) @@ -57646,7 +55306,7 @@ export namespace stripe { "A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results." ) .optional(), - /** The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for subscriptions](https://stripe.com/docs/search#query-fields-for-subscriptions). */ + /**The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for subscriptions](https://stripe.com/docs/search#query-fields-for-subscriptions).*/ query: z .string() .max(5000) @@ -57661,14 +55321,14 @@ export namespace stripe { export const GetSubscriptionsSearchResponseSchema = z.object({ data: z.array(SubscriptionSchema), has_more: z.boolean(), - next_page: z.string().max(5000).nullable().optional(), - /** String representing the object's type. Objects of the same type share the same value. */ + next_page: z.string().max(5000).optional(), + /**String representing the object's type. Objects of the same type share the same value.*/ object: z .literal('search_result') .describe( "String representing the object's type. Objects of the same type share the same value." ), - /** The total number of objects that match the query, only accurate up to 10,000. */ + /**The total number of objects that match the query, only accurate up to 10,000.*/ total_count: z .number() .int() @@ -57684,7 +55344,7 @@ export namespace stripe { export const GetSubscriptionsSubscriptionExposedIdParamsSchema = z.object({ subscription_exposed_id: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -57764,7 +55424,7 @@ export namespace stripe { export const GetTaxCalculationsCalculationParamsSchema = z.object({ calculation: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -57782,7 +55442,7 @@ export namespace stripe { export const GetTaxCalculationsCalculationLineItemsParamsSchema = z.object({ calculation: z.string().max(5000), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(500) @@ -57790,12 +55450,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -57803,7 +55463,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(500) @@ -57817,23 +55477,23 @@ export namespace stripe { > export const GetTaxCalculationsCalculationLineItemsResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z .array(TaxCalculationLineItemSchema) .describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/tax/calculations/[^/]+/line_items')) @@ -57845,7 +55505,7 @@ export namespace stripe { > export const GetTaxRegistrationsParamsSchema = z.object({ - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -57853,12 +55513,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -57866,7 +55526,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -57874,7 +55534,7 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** The status of the Tax Registration. */ + /**The status of the Tax Registration.*/ status: z .enum(['active', 'all', 'expired', 'scheduled']) .describe('The status of the Tax Registration.') @@ -57886,19 +55546,19 @@ export namespace stripe { export const GetTaxRegistrationsResponseSchema = z.object({ data: z.array(TaxRegistrationSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/tax/registrations')) @@ -57921,7 +55581,7 @@ export namespace stripe { export const GetTaxRegistrationsIdParamsSchema = z.object({ id: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -57949,7 +55609,7 @@ export namespace stripe { > export const GetTaxSettingsParamsSchema = z.object({ - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -57998,7 +55658,7 @@ export namespace stripe { export const GetTaxTransactionsTransactionParamsSchema = z.object({ transaction: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -58016,7 +55676,7 @@ export namespace stripe { export const GetTaxTransactionsTransactionLineItemsParamsSchema = z.object({ transaction: z.string().max(5000), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(500) @@ -58024,12 +55684,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -58037,7 +55697,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(500) @@ -58051,23 +55711,23 @@ export namespace stripe { > export const GetTaxTransactionsTransactionLineItemsResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z .array(TaxTransactionLineItemSchema) .describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/tax/transactions/[^/]+/line_items')) @@ -58079,19 +55739,19 @@ export namespace stripe { > export const GetTaxCodesParamsSchema = z.object({ - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .describe( 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -58099,7 +55759,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .describe( @@ -58111,19 +55771,19 @@ export namespace stripe { export const GetTaxCodesResponseSchema = z.object({ data: z.array(TaxCodeSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -58133,7 +55793,7 @@ export namespace stripe { export const GetTaxCodesIdParamsSchema = z.object({ id: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -58147,7 +55807,7 @@ export namespace stripe { > export const GetTaxIdsParamsSchema = z.object({ - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -58155,12 +55815,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -58168,7 +55828,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** The account or customer the tax ID belongs to. Defaults to `owner[type]=self`. */ + /**The account or customer the tax ID belongs to. Defaults to `owner[type]=self`.*/ owner: z .object({ account: z.string().optional(), @@ -58179,7 +55839,7 @@ export namespace stripe { 'The account or customer the tax ID belongs to. Defaults to `owner[type]=self`.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -58191,21 +55851,21 @@ export namespace stripe { export type GetTaxIdsParams = z.infer export const GetTaxIdsResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z.array(TaxIdSchema).describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -58221,7 +55881,7 @@ export namespace stripe { export const GetTaxIdsIdParamsSchema = z.object({ id: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -58243,14 +55903,14 @@ export namespace stripe { > export const GetTaxRatesParamsSchema = z.object({ - /** Optional flag to filter by tax rates that are either active or inactive (archived). */ + /**Optional flag to filter by tax rates that are either active or inactive (archived).*/ active: z .boolean() .describe( 'Optional flag to filter by tax rates that are either active or inactive (archived).' ) .optional(), - /** Optional range for filtering created date. */ + /**Optional range for filtering created date.*/ created: z .union([ z.object({ @@ -58263,7 +55923,7 @@ export namespace stripe { ]) .describe('Optional range for filtering created date.') .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -58271,19 +55931,19 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** Optional flag to filter by tax rates that are inclusive (or those that are not inclusive). */ + /**Optional flag to filter by tax rates that are inclusive (or those that are not inclusive).*/ inclusive: z .boolean() .describe( 'Optional flag to filter by tax rates that are inclusive (or those that are not inclusive).' ) .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -58291,7 +55951,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -58304,19 +55964,19 @@ export namespace stripe { export const GetTaxRatesResponseSchema = z.object({ data: z.array(TaxRateSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/tax_rates')) @@ -58333,7 +55993,7 @@ export namespace stripe { export const GetTaxRatesTaxRateParamsSchema = z.object({ tax_rate: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -58361,7 +56021,7 @@ export namespace stripe { > export const GetTerminalConfigurationsParamsSchema = z.object({ - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -58369,19 +56029,19 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** if present, only return the account default or non-default configurations. */ + /**if present, only return the account default or non-default configurations.*/ is_account_default: z .boolean() .describe( 'if present, only return the account default or non-default configurations.' ) .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -58389,7 +56049,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -58404,19 +56064,19 @@ export namespace stripe { export const GetTerminalConfigurationsResponseSchema = z.object({ data: z.array(TerminalConfigurationSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/terminal/configurations')) @@ -58440,7 +56100,7 @@ export namespace stripe { export const GetTerminalConfigurationsConfigurationParamsSchema = z.object({ configuration: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -58498,7 +56158,7 @@ export namespace stripe { > export const GetTerminalLocationsParamsSchema = z.object({ - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -58506,12 +56166,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -58519,7 +56179,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -58534,19 +56194,19 @@ export namespace stripe { export const GetTerminalLocationsResponseSchema = z.object({ data: z.array(TerminalLocationSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/terminal/locations')) @@ -58569,7 +56229,7 @@ export namespace stripe { export const GetTerminalLocationsLocationParamsSchema = z.object({ location: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -58616,7 +56276,7 @@ export namespace stripe { > export const GetTerminalReadersParamsSchema = z.object({ - /** Filters readers by device type */ + /**Filters readers by device type*/ device_type: z .enum([ 'bbpos_chipper2x', @@ -58630,7 +56290,7 @@ export namespace stripe { ]) .describe('Filters readers by device type') .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -58638,12 +56298,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -58651,7 +56311,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A location ID to filter the response list to only readers at the specific location */ + /**A location ID to filter the response list to only readers at the specific location*/ location: z .string() .max(5000) @@ -58659,13 +56319,13 @@ export namespace stripe { 'A location ID to filter the response list to only readers at the specific location' ) .optional(), - /** Filters readers by serial number */ + /**Filters readers by serial number*/ serial_number: z .string() .max(5000) .describe('Filters readers by serial number') .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -58673,7 +56333,7 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** A status filter to filter readers to only offline or online readers */ + /**A status filter to filter readers to only offline or online readers*/ status: z .enum(['offline', 'online']) .describe( @@ -58686,21 +56346,21 @@ export namespace stripe { > export const GetTerminalReadersResponseSchema = z.object({ - /** A list of readers */ + /**A list of readers*/ data: z.array(TerminalReaderSchema).describe('A list of readers'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -58722,7 +56382,7 @@ export namespace stripe { export const GetTerminalReadersReaderParamsSchema = z.object({ reader: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -59064,7 +56724,7 @@ export namespace stripe { export const PostTestHelpersIssuingSettlementsSettlementCompleteParamsSchema = z.object({ - /** The settlement token to mark as complete. */ + /**The settlement token to mark as complete.*/ settlement: z .string() .max(5000) @@ -59151,7 +56811,7 @@ export namespace stripe { > export const GetTestHelpersTestClocksParamsSchema = z.object({ - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -59159,12 +56819,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -59172,7 +56832,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -59187,19 +56847,19 @@ export namespace stripe { export const GetTestHelpersTestClocksResponseSchema = z.object({ data: z.array(TestHelpersTestClockSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/test_helpers/test_clocks')) @@ -59223,7 +56883,7 @@ export namespace stripe { export const GetTestHelpersTestClocksTestClockParamsSchema = z.object({ test_clock: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -59437,7 +57097,7 @@ export namespace stripe { export const GetTokensTokenParamsSchema = z.object({ token: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -59451,7 +57111,7 @@ export namespace stripe { > export const GetTopupsParamsSchema = z.object({ - /** A positive integer representing how much to transfer. */ + /**A positive integer representing how much to transfer.*/ amount: z .union([ z.object({ @@ -59464,7 +57124,7 @@ export namespace stripe { ]) .describe('A positive integer representing how much to transfer.') .optional(), - /** A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. */ + /**A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.*/ created: z .union([ z.object({ @@ -59479,7 +57139,7 @@ export namespace stripe { 'A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -59487,12 +57147,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -59500,7 +57160,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -59508,7 +57168,7 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** Only return top-ups that have the given status. One of `canceled`, `failed`, `pending` or `succeeded`. */ + /**Only return top-ups that have the given status. One of `canceled`, `failed`, `pending` or `succeeded`.*/ status: z .enum(['canceled', 'failed', 'pending', 'succeeded']) .describe( @@ -59520,19 +57180,19 @@ export namespace stripe { export const GetTopupsResponseSchema = z.object({ data: z.array(TopupSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/topups')) @@ -59549,7 +57209,7 @@ export namespace stripe { export const GetTopupsTopupParamsSchema = z.object({ topup: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -59587,7 +57247,7 @@ export namespace stripe { > export const GetTransfersParamsSchema = z.object({ - /** Only return transfers that were created during the given date interval. */ + /**Only return transfers that were created during the given date interval.*/ created: z .union([ z.object({ @@ -59602,7 +57262,7 @@ export namespace stripe { 'Only return transfers that were created during the given date interval.' ) .optional(), - /** Only return transfers for the destination specified by this account ID. */ + /**Only return transfers for the destination specified by this account ID.*/ destination: z .string() .max(5000) @@ -59610,7 +57270,7 @@ export namespace stripe { 'Only return transfers for the destination specified by this account ID.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -59618,12 +57278,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -59631,7 +57291,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -59639,7 +57299,7 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** Only return transfers with the specified transfer group. */ + /**Only return transfers with the specified transfer group.*/ transfer_group: z .string() .max(5000) @@ -59649,21 +57309,21 @@ export namespace stripe { export type GetTransfersParams = z.infer export const GetTransfersResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z.array(TransferSchema).describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/transfers')) @@ -59682,7 +57342,7 @@ export namespace stripe { export const GetTransfersIdReversalsParamsSchema = z.object({ id: z.string().max(5000), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -59690,12 +57350,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -59703,7 +57363,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -59717,23 +57377,23 @@ export namespace stripe { > export const GetTransfersIdReversalsResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z .array(TransferReversalSchema) .describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -59757,7 +57417,7 @@ export namespace stripe { export const GetTransfersTransferParamsSchema = z.object({ transfer: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -59787,7 +57447,7 @@ export namespace stripe { export const GetTransfersTransferReversalsIdParamsSchema = z.object({ id: z.string().max(5000), transfer: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -59818,7 +57478,7 @@ export namespace stripe { > export const GetTreasuryCreditReversalsParamsSchema = z.object({ - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -59826,16 +57486,16 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** Returns objects associated with this FinancialAccount. */ + /**Returns objects associated with this FinancialAccount.*/ financial_account: z .string() .describe('Returns objects associated with this FinancialAccount.'), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -59843,13 +57503,13 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** Only return CreditReversals for the ReceivedCredit ID. */ + /**Only return CreditReversals for the ReceivedCredit ID.*/ received_credit: z .string() .max(5000) .describe('Only return CreditReversals for the ReceivedCredit ID.') .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -59857,7 +57517,7 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** Only return CreditReversals for a given status. */ + /**Only return CreditReversals for a given status.*/ status: z .enum(['canceled', 'posted', 'processing']) .describe('Only return CreditReversals for a given status.') @@ -59868,23 +57528,23 @@ export namespace stripe { > export const GetTreasuryCreditReversalsResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z .array(TreasuryCreditReversalSchema) .describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -59907,7 +57567,7 @@ export namespace stripe { export const GetTreasuryCreditReversalsCreditReversalParamsSchema = z.object({ credit_reversal: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -59924,7 +57584,7 @@ export namespace stripe { > export const GetTreasuryDebitReversalsParamsSchema = z.object({ - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -59932,16 +57592,16 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** Returns objects associated with this FinancialAccount. */ + /**Returns objects associated with this FinancialAccount.*/ financial_account: z .string() .describe('Returns objects associated with this FinancialAccount.'), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -59949,18 +57609,18 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** Only return DebitReversals for the ReceivedDebit ID. */ + /**Only return DebitReversals for the ReceivedDebit ID.*/ received_debit: z .string() .max(5000) .describe('Only return DebitReversals for the ReceivedDebit ID.') .optional(), - /** Only return DebitReversals for a given resolution. */ + /**Only return DebitReversals for a given resolution.*/ resolution: z .enum(['lost', 'won']) .describe('Only return DebitReversals for a given resolution.') .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -59968,7 +57628,7 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** Only return DebitReversals for a given status. */ + /**Only return DebitReversals for a given status.*/ status: z .enum(['canceled', 'completed', 'processing']) .describe('Only return DebitReversals for a given status.') @@ -59979,23 +57639,23 @@ export namespace stripe { > export const GetTreasuryDebitReversalsResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z .array(TreasuryDebitReversalSchema) .describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -60018,7 +57678,7 @@ export namespace stripe { export const GetTreasuryDebitReversalsDebitReversalParamsSchema = z.object({ debit_reversal: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -60035,7 +57695,7 @@ export namespace stripe { > export const GetTreasuryFinancialAccountsParamsSchema = z.object({ - /** Only return FinancialAccounts that were created during the given date interval. */ + /**Only return FinancialAccounts that were created during the given date interval.*/ created: z .union([ z.object({ @@ -60050,24 +57710,24 @@ export namespace stripe { 'Only return FinancialAccounts that were created during the given date interval.' ) .optional(), - /** An object ID cursor for use in pagination. */ + /**An object ID cursor for use in pagination.*/ ending_before: z .string() .max(5000) .describe('An object ID cursor for use in pagination.') .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit ranging from 1 to 100 (defaults to 10). */ + /**A limit ranging from 1 to 100 (defaults to 10).*/ limit: z .number() .int() .describe('A limit ranging from 1 to 100 (defaults to 10).') .optional(), - /** An object ID cursor for use in pagination. */ + /**An object ID cursor for use in pagination.*/ starting_after: z .string() .max(5000) @@ -60080,19 +57740,19 @@ export namespace stripe { export const GetTreasuryFinancialAccountsResponseSchema = z.object({ data: z.array(TreasuryFinancialAccountSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/treasury/financial_accounts')) @@ -60117,7 +57777,7 @@ export namespace stripe { export const GetTreasuryFinancialAccountsFinancialAccountParamsSchema = z.object({ financial_account: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -60162,7 +57822,7 @@ export namespace stripe { export const GetTreasuryFinancialAccountsFinancialAccountFeaturesParamsSchema = z.object({ financial_account: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -60195,7 +57855,7 @@ export namespace stripe { > export const GetTreasuryInboundTransfersParamsSchema = z.object({ - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -60203,16 +57863,16 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** Returns objects associated with this FinancialAccount. */ + /**Returns objects associated with this FinancialAccount.*/ financial_account: z .string() .describe('Returns objects associated with this FinancialAccount.'), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -60220,7 +57880,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -60228,7 +57888,7 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** Only return InboundTransfers that have the given status: `processing`, `succeeded`, `failed` or `canceled`. */ + /**Only return InboundTransfers that have the given status: `processing`, `succeeded`, `failed` or `canceled`.*/ status: z .enum(['canceled', 'failed', 'processing', 'succeeded']) .describe( @@ -60241,23 +57901,23 @@ export namespace stripe { > export const GetTreasuryInboundTransfersResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z .array(TreasuryInboundTransferSchema) .describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -60280,7 +57940,7 @@ export namespace stripe { export const GetTreasuryInboundTransfersIdParamsSchema = z.object({ id: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -60310,7 +57970,7 @@ export namespace stripe { > export const GetTreasuryOutboundPaymentsParamsSchema = z.object({ - /** Only return OutboundPayments that were created during the given date interval. */ + /**Only return OutboundPayments that were created during the given date interval.*/ created: z .union([ z.object({ @@ -60325,13 +57985,13 @@ export namespace stripe { 'Only return OutboundPayments that were created during the given date interval.' ) .optional(), - /** Only return OutboundPayments sent to this customer. */ + /**Only return OutboundPayments sent to this customer.*/ customer: z .string() .max(5000) .describe('Only return OutboundPayments sent to this customer.') .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -60339,16 +57999,16 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** Returns objects associated with this FinancialAccount. */ + /**Returns objects associated with this FinancialAccount.*/ financial_account: z .string() .describe('Returns objects associated with this FinancialAccount.'), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -60356,7 +58016,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -60364,7 +58024,7 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** Only return OutboundPayments that have the given status: `processing`, `failed`, `posted`, `returned`, or `canceled`. */ + /**Only return OutboundPayments that have the given status: `processing`, `failed`, `posted`, `returned`, or `canceled`.*/ status: z .enum(['canceled', 'failed', 'posted', 'processing', 'returned']) .describe( @@ -60377,23 +58037,23 @@ export namespace stripe { > export const GetTreasuryOutboundPaymentsResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z .array(TreasuryOutboundPaymentSchema) .describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/treasury/outbound_payments')) @@ -60417,7 +58077,7 @@ export namespace stripe { export const GetTreasuryOutboundPaymentsIdParamsSchema = z.object({ id: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -60447,7 +58107,7 @@ export namespace stripe { > export const GetTreasuryOutboundTransfersParamsSchema = z.object({ - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -60455,16 +58115,16 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** Returns objects associated with this FinancialAccount. */ + /**Returns objects associated with this FinancialAccount.*/ financial_account: z .string() .describe('Returns objects associated with this FinancialAccount.'), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -60472,7 +58132,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -60480,7 +58140,7 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** Only return OutboundTransfers that have the given status: `processing`, `canceled`, `failed`, `posted`, or `returned`. */ + /**Only return OutboundTransfers that have the given status: `processing`, `canceled`, `failed`, `posted`, or `returned`.*/ status: z .enum(['canceled', 'failed', 'posted', 'processing', 'returned']) .describe( @@ -60493,23 +58153,23 @@ export namespace stripe { > export const GetTreasuryOutboundTransfersResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z .array(TreasuryOutboundTransferSchema) .describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -60533,7 +58193,7 @@ export namespace stripe { export const GetTreasuryOutboundTransfersOutboundTransferParamsSchema = z.object({ outbound_transfer: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -60564,7 +58224,7 @@ export namespace stripe { > export const GetTreasuryReceivedCreditsParamsSchema = z.object({ - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -60572,16 +58232,16 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** The FinancialAccount that received the funds. */ + /**The FinancialAccount that received the funds.*/ financial_account: z .string() .describe('The FinancialAccount that received the funds.'), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -60589,7 +58249,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** Only return ReceivedCredits described by the flow. */ + /**Only return ReceivedCredits described by the flow.*/ linked_flows: z .object({ source_flow_type: z.enum([ @@ -60602,7 +58262,7 @@ export namespace stripe { }) .describe('Only return ReceivedCredits described by the flow.') .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -60610,7 +58270,7 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** Only return ReceivedCredits that have the given status: `succeeded` or `failed`. */ + /**Only return ReceivedCredits that have the given status: `succeeded` or `failed`.*/ status: z .enum(['failed', 'succeeded']) .describe( @@ -60623,23 +58283,23 @@ export namespace stripe { > export const GetTreasuryReceivedCreditsResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z .array(TreasuryReceivedCreditSchema) .describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -60651,7 +58311,7 @@ export namespace stripe { export const GetTreasuryReceivedCreditsIdParamsSchema = z.object({ id: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -60668,7 +58328,7 @@ export namespace stripe { > export const GetTreasuryReceivedDebitsParamsSchema = z.object({ - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -60676,16 +58336,16 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** The FinancialAccount that funds were pulled from. */ + /**The FinancialAccount that funds were pulled from.*/ financial_account: z .string() .describe('The FinancialAccount that funds were pulled from.'), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -60693,7 +58353,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -60701,7 +58361,7 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** Only return ReceivedDebits that have the given status: `succeeded` or `failed`. */ + /**Only return ReceivedDebits that have the given status: `succeeded` or `failed`.*/ status: z .enum(['failed', 'succeeded']) .describe( @@ -60714,23 +58374,23 @@ export namespace stripe { > export const GetTreasuryReceivedDebitsResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z .array(TreasuryReceivedDebitSchema) .describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -60742,7 +58402,7 @@ export namespace stripe { export const GetTreasuryReceivedDebitsIdParamsSchema = z.object({ id: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -60759,7 +58419,7 @@ export namespace stripe { > export const GetTreasuryTransactionEntriesParamsSchema = z.object({ - /** Only return TransactionEntries that were created during the given date interval. */ + /**Only return TransactionEntries that were created during the given date interval.*/ created: z .union([ z.object({ @@ -60785,7 +58445,7 @@ export namespace stripe { z.number().int() ]) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -60793,16 +58453,16 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** Returns objects associated with this FinancialAccount. */ + /**Returns objects associated with this FinancialAccount.*/ financial_account: z .string() .describe('Returns objects associated with this FinancialAccount.'), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -60810,14 +58470,14 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** The results are in reverse chronological order by `created` or `effective_at`. The default is `created`. */ + /**The results are in reverse chronological order by `created` or `effective_at`. The default is `created`.*/ order_by: z .enum(['created', 'effective_at']) .describe( 'The results are in reverse chronological order by `created` or `effective_at`. The default is `created`.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -60825,7 +58485,7 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** Only return TransactionEntries associated with this Transaction. */ + /**Only return TransactionEntries associated with this Transaction.*/ transaction: z .string() .max(5000) @@ -60839,23 +58499,23 @@ export namespace stripe { > export const GetTreasuryTransactionEntriesResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z .array(TreasuryTransactionEntrySchema) .describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/treasury/transaction_entries')) @@ -60868,7 +58528,7 @@ export namespace stripe { export const GetTreasuryTransactionEntriesIdParamsSchema = z.object({ id: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -60885,7 +58545,7 @@ export namespace stripe { > export const GetTreasuryTransactionsParamsSchema = z.object({ - /** Only return Transactions that were created during the given date interval. */ + /**Only return Transactions that were created during the given date interval.*/ created: z .union([ z.object({ @@ -60900,7 +58560,7 @@ export namespace stripe { 'Only return Transactions that were created during the given date interval.' ) .optional(), - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -60908,16 +58568,16 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** Returns objects associated with this FinancialAccount. */ + /**Returns objects associated with this FinancialAccount.*/ financial_account: z .string() .describe('Returns objects associated with this FinancialAccount.'), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -60925,14 +58585,14 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** The results are in reverse chronological order by `created` or `posted_at`. The default is `created`. */ + /**The results are in reverse chronological order by `created` or `posted_at`. The default is `created`.*/ order_by: z .enum(['created', 'posted_at']) .describe( 'The results are in reverse chronological order by `created` or `posted_at`. The default is `created`.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -60940,14 +58600,14 @@ export namespace stripe { 'A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.' ) .optional(), - /** Only return Transactions that have the given status: `open`, `posted`, or `void`. */ + /**Only return Transactions that have the given status: `open`, `posted`, or `void`.*/ status: z .enum(['open', 'posted', 'void']) .describe( 'Only return Transactions that have the given status: `open`, `posted`, or `void`.' ) .optional(), - /** A filter for the `status_transitions.posted_at` timestamp. When using this filter, `status=posted` and `order_by=posted_at` must also be specified. */ + /**A filter for the `status_transitions.posted_at` timestamp. When using this filter, `status=posted` and `order_by=posted_at` must also be specified.*/ status_transitions: z .object({ posted_at: z @@ -60972,23 +58632,23 @@ export namespace stripe { > export const GetTreasuryTransactionsResponseSchema = z.object({ - /** Details about each object. */ + /**Details about each object.*/ data: z .array(TreasuryTransactionSchema) .describe('Details about each object.'), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .max(5000) @@ -61000,7 +58660,7 @@ export namespace stripe { export const GetTreasuryTransactionsIdParamsSchema = z.object({ id: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -61017,7 +58677,7 @@ export namespace stripe { > export const GetWebhookEndpointsParamsSchema = z.object({ - /** A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + /**A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.*/ ending_before: z .string() .max(5000) @@ -61025,12 +58685,12 @@ export namespace stripe { 'A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.' ) .optional(), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') .optional(), - /** A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + /**A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.*/ limit: z .number() .int() @@ -61038,7 +58698,7 @@ export namespace stripe { 'A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.' ) .optional(), - /** A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ + /**A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.*/ starting_after: z .string() .max(5000) @@ -61053,19 +58713,19 @@ export namespace stripe { export const GetWebhookEndpointsResponseSchema = z.object({ data: z.array(WebhookEndpointSchema), - /** True if this list has another page of items after this one that can be fetched. */ + /**True if this list has another page of items after this one that can be fetched.*/ has_more: z .boolean() .describe( 'True if this list has another page of items after this one that can be fetched.' ), - /** String representing the object's type. Objects of the same type share the same value. Always has the value `list`. */ + /**String representing the object's type. Objects of the same type share the same value. Always has the value `list`.*/ object: z .literal('list') .describe( "String representing the object's type. Objects of the same type share the same value. Always has the value `list`." ), - /** The URL where this list can be accessed. */ + /**The URL where this list can be accessed.*/ url: z .string() .regex(new RegExp('^/v1/webhook_endpoints')) @@ -61088,7 +58748,7 @@ export namespace stripe { export const GetWebhookEndpointsWebhookEndpointParamsSchema = z.object({ webhook_endpoint: z.string().max(5000), - /** Specifies which fields in the response should be expanded. */ + /**Specifies which fields in the response should be expanded.*/ expand: z .array(z.string().max(5000)) .describe('Specifies which fields in the response should be expanded.') @@ -61172,10 +58832,10 @@ export class StripeClient extends AIFunctionsProvider { */ @aiFunction({ name: 'get_account', - description: '

Retrieves the details of an account.

.', + description: `

Retrieves the details of an account.

.`, inputSchema: stripe.GetAccountParamsSchema }) - async GetAccount( + async getAccount( params: stripe.GetAccountParams ): Promise { return this.ky @@ -61190,11 +58850,10 @@ export class StripeClient extends AIFunctionsProvider { */ @aiFunction({ name: 'post_account_links', - description: - '

Creates an AccountLink object that includes a single-use Stripe URL that the platform can redirect their user to in order to take them through the Connect Onboarding flow.

.', + description: `

Creates an AccountLink object that includes a single-use Stripe URL that the platform can redirect their user to in order to take them through the Connect Onboarding flow.

.`, inputSchema: stripe.PostAccountLinksParamsSchema }) - async PostAccountLinks( + async postAccountLinks( _params: stripe.PostAccountLinksParams ): Promise { return this.ky @@ -61207,11 +58866,10 @@ export class StripeClient extends AIFunctionsProvider { */ @aiFunction({ name: 'post_account_sessions', - description: - '

Creates a AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access.

.', + description: `

Creates a AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access.

.`, inputSchema: stripe.PostAccountSessionsParamsSchema }) - async PostAccountSessions( + async postAccountSessions( _params: stripe.PostAccountSessionsParams ): Promise { return this.ky @@ -61224,16 +58882,24 @@ export class StripeClient extends AIFunctionsProvider { */ @aiFunction({ name: 'get_accounts', - description: - '

Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is empty.

.', + description: `

Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is empty.

.`, inputSchema: stripe.GetAccountsParamsSchema }) - async GetAccounts( + async getAccounts( params: stripe.GetAccountsParams ): Promise { return this.ky .get('/v1/accounts', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'created', + 'ending_before', + 'expand', + 'limit', + 'starting_after' + ) + ) }) .json() } @@ -61256,7 +58922,7 @@ creating the account. Connect Onboarding won’t ask for the prefilled informati You can prefill any information on the account.

.`, inputSchema: stripe.PostAccountsParamsSchema }) - async PostAccounts( + async postAccounts( _params: stripe.PostAccountsParams ): Promise { return this.ky.post('/v1/accounts').json() @@ -61267,10 +58933,10 @@ You can prefill any information on the account.

.`, */ @aiFunction({ name: 'get_accounts_account', - description: '

Retrieves the details of an account.

.', + description: `

Retrieves the details of an account.

.`, inputSchema: stripe.GetAccountsAccountParamsSchema }) - async GetAccountsAccount( + async getAccountsAccount( params: stripe.GetAccountsAccountParams ): Promise { return this.ky @@ -61312,7 +58978,7 @@ after which some properties can no longer be updated.

Connect documentation to learn more about updating accounts.

.`, inputSchema: stripe.PostAccountsAccountParamsSchema }) - async PostAccountsAccount( + async postAccountsAccount( params: stripe.PostAccountsAccountParams ): Promise { return this.ky @@ -61340,7 +59006,7 @@ after which some properties can no longer be updated.

If you want to delete your own account, use the account information tab in your account settings instead.

.`, inputSchema: stripe.DeleteAccountsAccountParamsSchema }) - async DeleteAccountsAccount( + async deleteAccountsAccount( params: stripe.DeleteAccountsAccountParams ): Promise { return this.ky @@ -61353,10 +59019,10 @@ after which some properties can no longer be updated.

*/ @aiFunction({ name: 'post_accounts_account_bank_accounts', - description: '

Create an external account for a given account.

.', + description: `

Create an external account for a given account.

.`, inputSchema: stripe.PostAccountsAccountBankAccountsParamsSchema }) - async PostAccountsAccountBankAccounts( + async postAccountsAccountBankAccounts( params: stripe.PostAccountsAccountBankAccountsParams ): Promise { return this.ky @@ -61369,11 +59035,10 @@ after which some properties can no longer be updated.

*/ @aiFunction({ name: 'get_accounts_account_bank_accounts_id', - description: - '

Retrieve a specified external account for a given account.

.', + description: `

Retrieve a specified external account for a given account.

.`, inputSchema: stripe.GetAccountsAccountBankAccountsIdParamsSchema }) - async GetAccountsAccountBankAccountsId( + async getAccountsAccountBankAccountsId( params: stripe.GetAccountsAccountBankAccountsIdParams ): Promise { return this.ky @@ -61405,11 +59070,14 @@ details are not editable by design.

arguments or changes.

.`, inputSchema: stripe.PostAccountsAccountBankAccountsIdParamsSchema }) - async PostAccountsAccountBankAccountsId( + async postAccountsAccountBankAccountsId( params: stripe.PostAccountsAccountBankAccountsIdParams ): Promise { return this.ky - .post(`/v1/accounts/${params.account}/bank_accounts/${params.id}`) + .post( + `/v1/accounts/${params.account}/bank_accounts/${params.id}`, + {} + ) .json() } @@ -61418,15 +59086,17 @@ arguments or changes.

.`, */ @aiFunction({ name: 'delete_accounts_account_bank_accounts_id', - description: - '

Delete a specified external account for a given account.

.', + description: `

Delete a specified external account for a given account.

.`, inputSchema: stripe.DeleteAccountsAccountBankAccountsIdParamsSchema }) - async DeleteAccountsAccountBankAccountsId( + async deleteAccountsAccountBankAccountsId( params: stripe.DeleteAccountsAccountBankAccountsIdParams ): Promise { return this.ky - .delete(`/v1/accounts/${params.account}/bank_accounts/${params.id}`) + .delete( + `/v1/accounts/${params.account}/bank_accounts/${params.id}`, + {} + ) .json() } @@ -61435,11 +59105,10 @@ arguments or changes.

.`, */ @aiFunction({ name: 'get_accounts_account_capabilities', - description: - '

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

.', + description: `

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

.`, inputSchema: stripe.GetAccountsAccountCapabilitiesParamsSchema }) - async GetAccountsAccountCapabilities( + async getAccountsAccountCapabilities( params: stripe.GetAccountsAccountCapabilitiesParams ): Promise { return this.ky @@ -61454,11 +59123,10 @@ arguments or changes.

.`, */ @aiFunction({ name: 'get_accounts_account_capabilities_capability', - description: - '

Retrieves information about the specified Account Capability.

.', + description: `

Retrieves information about the specified Account Capability.

.`, inputSchema: stripe.GetAccountsAccountCapabilitiesCapabilityParamsSchema }) - async GetAccountsAccountCapabilitiesCapability( + async getAccountsAccountCapabilitiesCapability( params: stripe.GetAccountsAccountCapabilitiesCapabilityParams ): Promise { return this.ky @@ -61476,16 +59144,16 @@ arguments or changes.

.`, */ @aiFunction({ name: 'post_accounts_account_capabilities_capability', - description: - '

Updates an existing Account Capability. Request or remove a capability by updating its requested parameter.

.', + description: `

Updates an existing Account Capability. Request or remove a capability by updating its requested parameter.

.`, inputSchema: stripe.PostAccountsAccountCapabilitiesCapabilityParamsSchema }) - async PostAccountsAccountCapabilitiesCapability( + async postAccountsAccountCapabilitiesCapability( params: stripe.PostAccountsAccountCapabilitiesCapabilityParams ): Promise { return this.ky .post( - `/v1/accounts/${params.account}/capabilities/${params.capability}` + `/v1/accounts/${params.account}/capabilities/${params.capability}`, + {} ) .json() } @@ -61495,10 +59163,10 @@ arguments or changes.

.`, */ @aiFunction({ name: 'get_accounts_account_external_accounts', - description: '

List external accounts for an account.

.', + description: `

List external accounts for an account.

.`, inputSchema: stripe.GetAccountsAccountExternalAccountsParamsSchema }) - async GetAccountsAccountExternalAccounts( + async getAccountsAccountExternalAccounts( params: stripe.GetAccountsAccountExternalAccountsParams ): Promise { return this.ky @@ -61522,10 +59190,10 @@ arguments or changes.

.`, */ @aiFunction({ name: 'post_accounts_account_external_accounts', - description: '

Create an external account for a given account.

.', + description: `

Create an external account for a given account.

.`, inputSchema: stripe.PostAccountsAccountExternalAccountsParamsSchema }) - async PostAccountsAccountExternalAccounts( + async postAccountsAccountExternalAccounts( params: stripe.PostAccountsAccountExternalAccountsParams ): Promise { return this.ky @@ -61538,11 +59206,10 @@ arguments or changes.

.`, */ @aiFunction({ name: 'get_accounts_account_external_accounts_id', - description: - '

Retrieve a specified external account for a given account.

.', + description: `

Retrieve a specified external account for a given account.

.`, inputSchema: stripe.GetAccountsAccountExternalAccountsIdParamsSchema }) - async GetAccountsAccountExternalAccountsId( + async getAccountsAccountExternalAccountsId( params: stripe.GetAccountsAccountExternalAccountsIdParams ): Promise { return this.ky @@ -61577,12 +59244,13 @@ details are not editable by design.

arguments or changes.

.`, inputSchema: stripe.PostAccountsAccountExternalAccountsIdParamsSchema }) - async PostAccountsAccountExternalAccountsId( + async postAccountsAccountExternalAccountsId( params: stripe.PostAccountsAccountExternalAccountsIdParams ): Promise { return this.ky .post( - `/v1/accounts/${params.account}/external_accounts/${params.id}` + `/v1/accounts/${params.account}/external_accounts/${params.id}`, + {} ) .json() } @@ -61592,16 +59260,16 @@ arguments or changes.

.`, */ @aiFunction({ name: 'delete_accounts_account_external_accounts_id', - description: - '

Delete a specified external account for a given account.

.', + description: `

Delete a specified external account for a given account.

.`, inputSchema: stripe.DeleteAccountsAccountExternalAccountsIdParamsSchema }) - async DeleteAccountsAccountExternalAccountsId( + async deleteAccountsAccountExternalAccountsId( params: stripe.DeleteAccountsAccountExternalAccountsIdParams ): Promise { return this.ky .delete( - `/v1/accounts/${params.account}/external_accounts/${params.id}` + `/v1/accounts/${params.account}/external_accounts/${params.id}`, + {} ) .json() } @@ -61618,7 +59286,7 @@ arguments or changes.

.`,

You can only create login links for accounts that use the Express Dashboard and are connected to your platform.

.`, inputSchema: stripe.PostAccountsAccountLoginLinksParamsSchema }) - async PostAccountsAccountLoginLinks( + async postAccountsAccountLoginLinks( params: stripe.PostAccountsAccountLoginLinksParams ): Promise { return this.ky @@ -61631,11 +59299,10 @@ arguments or changes.

.`, */ @aiFunction({ name: 'get_accounts_account_people', - description: - '

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

.', + description: `

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

.`, inputSchema: stripe.GetAccountsAccountPeopleParamsSchema }) - async GetAccountsAccountPeople( + async getAccountsAccountPeople( params: stripe.GetAccountsAccountPeopleParams ): Promise { return this.ky @@ -61659,10 +59326,10 @@ arguments or changes.

.`, */ @aiFunction({ name: 'post_accounts_account_people', - description: '

Creates a new person.

.', + description: `

Creates a new person.

.`, inputSchema: stripe.PostAccountsAccountPeopleParamsSchema }) - async PostAccountsAccountPeople( + async postAccountsAccountPeople( params: stripe.PostAccountsAccountPeopleParams ): Promise { return this.ky @@ -61675,10 +59342,10 @@ arguments or changes.

.`, */ @aiFunction({ name: 'get_accounts_account_people_person', - description: '

Retrieves an existing person.

.', + description: `

Retrieves an existing person.

.`, inputSchema: stripe.GetAccountsAccountPeoplePersonParamsSchema }) - async GetAccountsAccountPeoplePerson( + async getAccountsAccountPeoplePerson( params: stripe.GetAccountsAccountPeoplePersonParams ): Promise { return this.ky @@ -61693,14 +59360,14 @@ arguments or changes.

.`, */ @aiFunction({ name: 'post_accounts_account_people_person', - description: '

Updates an existing person.

.', + description: `

Updates an existing person.

.`, inputSchema: stripe.PostAccountsAccountPeoplePersonParamsSchema }) - async PostAccountsAccountPeoplePerson( + async postAccountsAccountPeoplePerson( params: stripe.PostAccountsAccountPeoplePersonParams ): Promise { return this.ky - .post(`/v1/accounts/${params.account}/people/${params.person}`) + .post(`/v1/accounts/${params.account}/people/${params.person}`, {}) .json() } @@ -61709,15 +59376,17 @@ arguments or changes.

.`, */ @aiFunction({ name: 'delete_accounts_account_people_person', - description: - '

Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.

.', + description: `

Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.

.`, inputSchema: stripe.DeleteAccountsAccountPeoplePersonParamsSchema }) - async DeleteAccountsAccountPeoplePerson( + async deleteAccountsAccountPeoplePerson( params: stripe.DeleteAccountsAccountPeoplePersonParams ): Promise { return this.ky - .delete(`/v1/accounts/${params.account}/people/${params.person}`) + .delete( + `/v1/accounts/${params.account}/people/${params.person}`, + {} + ) .json() } @@ -61726,11 +59395,10 @@ arguments or changes.

.`, */ @aiFunction({ name: 'get_accounts_account_persons', - description: - '

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

.', + description: `

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

.`, inputSchema: stripe.GetAccountsAccountPersonsParamsSchema }) - async GetAccountsAccountPersons( + async getAccountsAccountPersons( params: stripe.GetAccountsAccountPersonsParams ): Promise { return this.ky @@ -61754,10 +59422,10 @@ arguments or changes.

.`, */ @aiFunction({ name: 'post_accounts_account_persons', - description: '

Creates a new person.

.', + description: `

Creates a new person.

.`, inputSchema: stripe.PostAccountsAccountPersonsParamsSchema }) - async PostAccountsAccountPersons( + async postAccountsAccountPersons( params: stripe.PostAccountsAccountPersonsParams ): Promise { return this.ky @@ -61770,10 +59438,10 @@ arguments or changes.

.`, */ @aiFunction({ name: 'get_accounts_account_persons_person', - description: '

Retrieves an existing person.

.', + description: `

Retrieves an existing person.

.`, inputSchema: stripe.GetAccountsAccountPersonsPersonParamsSchema }) - async GetAccountsAccountPersonsPerson( + async getAccountsAccountPersonsPerson( params: stripe.GetAccountsAccountPersonsPersonParams ): Promise { return this.ky @@ -61788,14 +59456,14 @@ arguments or changes.

.`, */ @aiFunction({ name: 'post_accounts_account_persons_person', - description: '

Updates an existing person.

.', + description: `

Updates an existing person.

.`, inputSchema: stripe.PostAccountsAccountPersonsPersonParamsSchema }) - async PostAccountsAccountPersonsPerson( + async postAccountsAccountPersonsPerson( params: stripe.PostAccountsAccountPersonsPersonParams ): Promise { return this.ky - .post(`/v1/accounts/${params.account}/persons/${params.person}`) + .post(`/v1/accounts/${params.account}/persons/${params.person}`, {}) .json() } @@ -61804,15 +59472,17 @@ arguments or changes.

.`, */ @aiFunction({ name: 'delete_accounts_account_persons_person', - description: - '

Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.

.', + description: `

Deletes an existing person’s relationship to the account’s legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.

.`, inputSchema: stripe.DeleteAccountsAccountPersonsPersonParamsSchema }) - async DeleteAccountsAccountPersonsPerson( + async deleteAccountsAccountPersonsPerson( params: stripe.DeleteAccountsAccountPersonsPersonParams ): Promise { return this.ky - .delete(`/v1/accounts/${params.account}/persons/${params.person}`) + .delete( + `/v1/accounts/${params.account}/persons/${params.person}`, + {} + ) .json() } @@ -61828,7 +59498,7 @@ arguments or changes.

.`,

Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero.

.`, inputSchema: stripe.PostAccountsAccountRejectParamsSchema }) - async PostAccountsAccountReject( + async postAccountsAccountReject( params: stripe.PostAccountsAccountRejectParams ): Promise { return this.ky @@ -61841,15 +59511,24 @@ arguments or changes.

.`, */ @aiFunction({ name: 'get_apple_pay_domains', - description: '

List apple pay domains.

.', + description: `

List apple pay domains.

.`, inputSchema: stripe.GetApplePayDomainsParamsSchema }) - async GetApplePayDomains( + async getApplePayDomains( params: stripe.GetApplePayDomainsParams ): Promise { return this.ky .get('/v1/apple_pay/domains', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'domain_name', + 'ending_before', + 'expand', + 'limit', + 'starting_after' + ) + ) }) .json() } @@ -61859,10 +59538,10 @@ arguments or changes.

.`, */ @aiFunction({ name: 'post_apple_pay_domains', - description: '

Create an apple pay domain.

.', + description: `

Create an apple pay domain.

.`, inputSchema: stripe.PostApplePayDomainsParamsSchema }) - async PostApplePayDomains( + async postApplePayDomains( _params: stripe.PostApplePayDomainsParams ): Promise { return this.ky @@ -61875,10 +59554,10 @@ arguments or changes.

.`, */ @aiFunction({ name: 'get_apple_pay_domains_domain', - description: '

Retrieve an apple pay domain.

.', + description: `

Retrieve an apple pay domain.

.`, inputSchema: stripe.GetApplePayDomainsDomainParamsSchema }) - async GetApplePayDomainsDomain( + async getApplePayDomainsDomain( params: stripe.GetApplePayDomainsDomainParams ): Promise { return this.ky @@ -61893,10 +59572,10 @@ arguments or changes.

.`, */ @aiFunction({ name: 'delete_apple_pay_domains_domain', - description: '

Delete an apple pay domain.

.', + description: `

Delete an apple pay domain.

.`, inputSchema: stripe.DeleteApplePayDomainsDomainParamsSchema }) - async DeleteApplePayDomainsDomain( + async deleteApplePayDomainsDomain( params: stripe.DeleteApplePayDomainsDomainParams ): Promise { return this.ky @@ -61909,16 +59588,25 @@ arguments or changes.

.`, */ @aiFunction({ name: 'get_application_fees', - description: - '

Returns a list of application fees you’ve previously collected. The application fees are returned in sorted order, with the most recent fees appearing first.

.', + description: `

Returns a list of application fees you’ve previously collected. The application fees are returned in sorted order, with the most recent fees appearing first.

.`, inputSchema: stripe.GetApplicationFeesParamsSchema }) - async GetApplicationFees( + async getApplicationFees( params: stripe.GetApplicationFeesParams ): Promise { return this.ky .get('/v1/application_fees', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'charge', + 'created', + 'ending_before', + 'expand', + 'limit', + 'starting_after' + ) + ) }) .json() } @@ -61928,11 +59616,10 @@ arguments or changes.

.`, */ @aiFunction({ name: 'get_application_fees_fee_refunds_id', - description: - '

By default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee.

.', + description: `

By default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee.

.`, inputSchema: stripe.GetApplicationFeesFeeRefundsIdParamsSchema }) - async GetApplicationFeesFeeRefundsId( + async getApplicationFeesFeeRefundsId( params: stripe.GetApplicationFeesFeeRefundsIdParams ): Promise { return this.ky @@ -61954,11 +59641,11 @@ arguments or changes.

.`,

This request only accepts metadata as an argument.

.`, inputSchema: stripe.PostApplicationFeesFeeRefundsIdParamsSchema }) - async PostApplicationFeesFeeRefundsId( + async postApplicationFeesFeeRefundsId( params: stripe.PostApplicationFeesFeeRefundsIdParams ): Promise { return this.ky - .post(`/v1/application_fees/${params.fee}/refunds/${params.id}`) + .post(`/v1/application_fees/${params.fee}/refunds/${params.id}`, {}) .json() } @@ -61967,11 +59654,10 @@ arguments or changes.

.`, */ @aiFunction({ name: 'get_application_fees_id', - description: - '

Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.

.', + description: `

Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.

.`, inputSchema: stripe.GetApplicationFeesIdParamsSchema }) - async GetApplicationFeesId( + async getApplicationFeesId( params: stripe.GetApplicationFeesIdParams ): Promise { return this.ky @@ -61986,7 +59672,7 @@ arguments or changes.

.`, inputSchema: stripe.PostApplicationFeesIdRefundParamsSchema }) - async PostApplicationFeesIdRefund( + async postApplicationFeesIdRefund( params: stripe.PostApplicationFeesIdRefundParams ): Promise { return this.ky @@ -61999,11 +59685,10 @@ arguments or changes.

.`, */ @aiFunction({ name: 'get_application_fees_id_refunds', - description: - '

You can see a list of the refunds belonging to a specific application fee. Note that the 10 most recent refunds are always available by default on the application fee object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.

.', + description: `

You can see a list of the refunds belonging to a specific application fee. Note that the 10 most recent refunds are always available by default on the application fee object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.

.`, inputSchema: stripe.GetApplicationFeesIdRefundsParamsSchema }) - async GetApplicationFeesIdRefunds( + async getApplicationFeesIdRefunds( params: stripe.GetApplicationFeesIdRefundsParams ): Promise { return this.ky @@ -62039,7 +59724,7 @@ This method will raise an error when called on an already-refunded application f or when trying to refund more money than is left on an application fee.

.`, inputSchema: stripe.PostApplicationFeesIdRefundsParamsSchema }) - async PostApplicationFeesIdRefunds( + async postApplicationFeesIdRefunds( params: stripe.PostApplicationFeesIdRefundsParams ): Promise { return this.ky @@ -62052,15 +59737,24 @@ or when trying to refund more money than is left on an application fee.

.`, */ @aiFunction({ name: 'get_apps_secrets', - description: '

List all secrets stored on the given scope.

.', + description: `

List all secrets stored on the given scope.

.`, inputSchema: stripe.GetAppsSecretsParamsSchema }) - async GetAppsSecrets( + async getAppsSecrets( params: stripe.GetAppsSecretsParams ): Promise { return this.ky .get('/v1/apps/secrets', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'ending_before', + 'expand', + 'limit', + 'scope', + 'starting_after' + ) + ) }) .json() } @@ -62070,10 +59764,10 @@ or when trying to refund more money than is left on an application fee.

.`, */ @aiFunction({ name: 'post_apps_secrets', - description: '

Create or replace a secret in the secret store.

.', + description: `

Create or replace a secret in the secret store.

.`, inputSchema: stripe.PostAppsSecretsParamsSchema }) - async PostAppsSecrets( + async postAppsSecrets( _params: stripe.PostAppsSecretsParams ): Promise { return this.ky @@ -62086,11 +59780,10 @@ or when trying to refund more money than is left on an application fee.

.`, */ @aiFunction({ name: 'post_apps_secrets_delete', - description: - '

Deletes a secret from the secret store by name and scope.

.', + description: `

Deletes a secret from the secret store by name and scope.

.`, inputSchema: stripe.PostAppsSecretsDeleteParamsSchema }) - async PostAppsSecretsDelete( + async postAppsSecretsDelete( _params: stripe.PostAppsSecretsDeleteParams ): Promise { return this.ky @@ -62103,16 +59796,17 @@ or when trying to refund more money than is left on an application fee.

.`, */ @aiFunction({ name: 'get_apps_secrets_find', - description: - '

Finds a secret in the secret store by name and scope.

.', + description: `

Finds a secret in the secret store by name and scope.

.`, inputSchema: stripe.GetAppsSecretsFindParamsSchema }) - async GetAppsSecretsFind( + async getAppsSecretsFind( params: stripe.GetAppsSecretsFindParams ): Promise { return this.ky .get('/v1/apps/secrets/find', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick(params, 'expand', 'name', 'scope') + ) }) .json() } @@ -62127,7 +59821,7 @@ or when trying to refund more money than is left on an application fee.

.`, For a sample request, see Accounting for negative balances.

.`, inputSchema: stripe.GetBalanceParamsSchema }) - async GetBalance( + async getBalance( params: stripe.GetBalanceParams ): Promise { return this.ky @@ -62149,12 +59843,25 @@ or when trying to refund more money than is left on an application fee.

.`,

Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.

.`, inputSchema: stripe.GetBalanceHistoryParamsSchema }) - async GetBalanceHistory( + async getBalanceHistory( params: stripe.GetBalanceHistoryParams ): Promise { return this.ky .get('/v1/balance/history', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'created', + 'currency', + 'ending_before', + 'expand', + 'limit', + 'payout', + 'source', + 'starting_after', + 'type' + ) + ) }) .json() } @@ -62171,7 +59878,7 @@ or when trying to refund more money than is left on an application fee.

.`,

Note that this endpoint previously used the path /v1/balance/history/:id.

.`, inputSchema: stripe.GetBalanceHistoryIdParamsSchema }) - async GetBalanceHistoryId( + async getBalanceHistoryId( params: stripe.GetBalanceHistoryIdParams ): Promise { return this.ky @@ -62193,12 +59900,25 @@ or when trying to refund more money than is left on an application fee.

.`,

Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.

.`, inputSchema: stripe.GetBalanceTransactionsParamsSchema }) - async GetBalanceTransactions( + async getBalanceTransactions( params: stripe.GetBalanceTransactionsParams ): Promise { return this.ky .get('/v1/balance_transactions', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'created', + 'currency', + 'ending_before', + 'expand', + 'limit', + 'payout', + 'source', + 'starting_after', + 'type' + ) + ) }) .json() } @@ -62215,7 +59935,7 @@ or when trying to refund more money than is left on an application fee.

.`,

Note that this endpoint previously used the path /v1/balance/history/:id.

.`, inputSchema: stripe.GetBalanceTransactionsIdParamsSchema }) - async GetBalanceTransactionsId( + async getBalanceTransactionsId( params: stripe.GetBalanceTransactionsIdParams ): Promise { return this.ky @@ -62230,15 +59950,25 @@ or when trying to refund more money than is left on an application fee.

.`, */ @aiFunction({ name: 'get_billing_alerts', - description: '

Lists billing active and inactive alerts

.', + description: `

Lists billing active and inactive alerts

.`, inputSchema: stripe.GetBillingAlertsParamsSchema }) - async GetBillingAlerts( + async getBillingAlerts( params: stripe.GetBillingAlertsParams ): Promise { return this.ky .get('/v1/billing/alerts', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'alert_type', + 'ending_before', + 'expand', + 'limit', + 'meter', + 'starting_after' + ) + ) }) .json() } @@ -62248,10 +59978,10 @@ or when trying to refund more money than is left on an application fee.

.`, */ @aiFunction({ name: 'post_billing_alerts', - description: '

Creates a billing alert

.', + description: `

Creates a billing alert

.`, inputSchema: stripe.PostBillingAlertsParamsSchema }) - async PostBillingAlerts( + async postBillingAlerts( _params: stripe.PostBillingAlertsParams ): Promise { return this.ky @@ -62264,10 +59994,10 @@ or when trying to refund more money than is left on an application fee.

.`, */ @aiFunction({ name: 'get_billing_alerts_id', - description: '

Retrieves a billing alert given an ID

.', + description: `

Retrieves a billing alert given an ID

.`, inputSchema: stripe.GetBillingAlertsIdParamsSchema }) - async GetBillingAlertsId( + async getBillingAlertsId( params: stripe.GetBillingAlertsIdParams ): Promise { return this.ky @@ -62282,11 +60012,10 @@ or when trying to refund more money than is left on an application fee.

.`, */ @aiFunction({ name: 'post_billing_alerts_id_activate', - description: - '

Reactivates this alert, allowing it to trigger again.

.', + description: `

Reactivates this alert, allowing it to trigger again.

.`, inputSchema: stripe.PostBillingAlertsIdActivateParamsSchema }) - async PostBillingAlertsIdActivate( + async postBillingAlertsIdActivate( params: stripe.PostBillingAlertsIdActivateParams ): Promise { return this.ky @@ -62299,11 +60028,10 @@ or when trying to refund more money than is left on an application fee.

.`, */ @aiFunction({ name: 'post_billing_alerts_id_archive', - description: - '

Archives this alert, removing it from the list view and APIs. This is non-reversible.

.', + description: `

Archives this alert, removing it from the list view and APIs. This is non-reversible.

.`, inputSchema: stripe.PostBillingAlertsIdArchiveParamsSchema }) - async PostBillingAlertsIdArchive( + async postBillingAlertsIdArchive( params: stripe.PostBillingAlertsIdArchiveParams ): Promise { return this.ky @@ -62316,11 +60044,10 @@ or when trying to refund more money than is left on an application fee.

.`, */ @aiFunction({ name: 'post_billing_alerts_id_deactivate', - description: - '

Deactivates this alert, preventing it from triggering.

.', + description: `

Deactivates this alert, preventing it from triggering.

.`, inputSchema: stripe.PostBillingAlertsIdDeactivateParamsSchema }) - async PostBillingAlertsIdDeactivate( + async postBillingAlertsIdDeactivate( params: stripe.PostBillingAlertsIdDeactivateParams ): Promise { return this.ky @@ -62333,15 +60060,17 @@ or when trying to refund more money than is left on an application fee.

.`, */ @aiFunction({ name: 'get_billing_credit_balance_summary', - description: '

Retrieves the credit balance summary for a customer.

.', + description: `

Retrieves the credit balance summary for a customer.

.`, inputSchema: stripe.GetBillingCreditBalanceSummaryParamsSchema }) - async GetBillingCreditBalanceSummary( + async getBillingCreditBalanceSummary( params: stripe.GetBillingCreditBalanceSummaryParams ): Promise { return this.ky .get('/v1/billing/credit_balance_summary', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick(params, 'customer', 'expand', 'filter') + ) }) .json() } @@ -62351,15 +60080,25 @@ or when trying to refund more money than is left on an application fee.

.`, */ @aiFunction({ name: 'get_billing_credit_balance_transactions', - description: '

Retrieve a list of credit balance transactions.

.', + description: `

Retrieve a list of credit balance transactions.

.`, inputSchema: stripe.GetBillingCreditBalanceTransactionsParamsSchema }) - async GetBillingCreditBalanceTransactions( + async getBillingCreditBalanceTransactions( params: stripe.GetBillingCreditBalanceTransactionsParams ): Promise { return this.ky .get('/v1/billing/credit_balance_transactions', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'credit_grant', + 'customer', + 'ending_before', + 'expand', + 'limit', + 'starting_after' + ) + ) }) .json() } @@ -62369,10 +60108,10 @@ or when trying to refund more money than is left on an application fee.

.`, */ @aiFunction({ name: 'get_billing_credit_balance_transactions_id', - description: '

Retrieves a credit balance transaction.

.', + description: `

Retrieves a credit balance transaction.

.`, inputSchema: stripe.GetBillingCreditBalanceTransactionsIdParamsSchema }) - async GetBillingCreditBalanceTransactionsId( + async getBillingCreditBalanceTransactionsId( params: stripe.GetBillingCreditBalanceTransactionsIdParams ): Promise { return this.ky @@ -62387,15 +60126,24 @@ or when trying to refund more money than is left on an application fee.

.`, */ @aiFunction({ name: 'get_billing_credit_grants', - description: '

Retrieve a list of credit grants.

.', + description: `

Retrieve a list of credit grants.

.`, inputSchema: stripe.GetBillingCreditGrantsParamsSchema }) - async GetBillingCreditGrants( + async getBillingCreditGrants( params: stripe.GetBillingCreditGrantsParams ): Promise { return this.ky .get('/v1/billing/credit_grants', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'customer', + 'ending_before', + 'expand', + 'limit', + 'starting_after' + ) + ) }) .json() } @@ -62405,10 +60153,10 @@ or when trying to refund more money than is left on an application fee.

.`, */ @aiFunction({ name: 'post_billing_credit_grants', - description: '

Creates a credit grant.

.', + description: `

Creates a credit grant.

.`, inputSchema: stripe.PostBillingCreditGrantsParamsSchema }) - async PostBillingCreditGrants( + async postBillingCreditGrants( _params: stripe.PostBillingCreditGrantsParams ): Promise { return this.ky @@ -62421,10 +60169,10 @@ or when trying to refund more money than is left on an application fee.

.`, */ @aiFunction({ name: 'get_billing_credit_grants_id', - description: '

Retrieves a credit grant.

.', + description: `

Retrieves a credit grant.

.`, inputSchema: stripe.GetBillingCreditGrantsIdParamsSchema }) - async GetBillingCreditGrantsId( + async getBillingCreditGrantsId( params: stripe.GetBillingCreditGrantsIdParams ): Promise { return this.ky @@ -62439,10 +60187,10 @@ or when trying to refund more money than is left on an application fee.

.`, */ @aiFunction({ name: 'post_billing_credit_grants_id', - description: '

Updates a credit grant.

.', + description: `

Updates a credit grant.

.`, inputSchema: stripe.PostBillingCreditGrantsIdParamsSchema }) - async PostBillingCreditGrantsId( + async postBillingCreditGrantsId( params: stripe.PostBillingCreditGrantsIdParams ): Promise { return this.ky @@ -62455,10 +60203,10 @@ or when trying to refund more money than is left on an application fee.

.`, */ @aiFunction({ name: 'post_billing_credit_grants_id_expire', - description: '

Expires a credit grant.

.', + description: `

Expires a credit grant.

.`, inputSchema: stripe.PostBillingCreditGrantsIdExpireParamsSchema }) - async PostBillingCreditGrantsIdExpire( + async postBillingCreditGrantsIdExpire( params: stripe.PostBillingCreditGrantsIdExpireParams ): Promise { return this.ky @@ -62471,10 +60219,10 @@ or when trying to refund more money than is left on an application fee.

.`, */ @aiFunction({ name: 'post_billing_credit_grants_id_void', - description: '

Voids a credit grant.

.', + description: `

Voids a credit grant.

.`, inputSchema: stripe.PostBillingCreditGrantsIdVoidParamsSchema }) - async PostBillingCreditGrantsIdVoid( + async postBillingCreditGrantsIdVoid( params: stripe.PostBillingCreditGrantsIdVoidParams ): Promise { return this.ky @@ -62487,10 +60235,10 @@ or when trying to refund more money than is left on an application fee.

.`, */ @aiFunction({ name: 'post_billing_meter_event_adjustments', - description: '

Creates a billing meter event adjustment.

.', + description: `

Creates a billing meter event adjustment.

.`, inputSchema: stripe.PostBillingMeterEventAdjustmentsParamsSchema }) - async PostBillingMeterEventAdjustments( + async postBillingMeterEventAdjustments( _params: stripe.PostBillingMeterEventAdjustmentsParams ): Promise { return this.ky @@ -62503,10 +60251,10 @@ or when trying to refund more money than is left on an application fee.

.`, */ @aiFunction({ name: 'post_billing_meter_events', - description: '

Creates a billing meter event.

.', + description: `

Creates a billing meter event.

.`, inputSchema: stripe.PostBillingMeterEventsParamsSchema }) - async PostBillingMeterEvents( + async postBillingMeterEvents( _params: stripe.PostBillingMeterEventsParams ): Promise { return this.ky @@ -62519,15 +60267,24 @@ or when trying to refund more money than is left on an application fee.

.`, */ @aiFunction({ name: 'get_billing_meters', - description: '

Retrieve a list of billing meters.

.', + description: `

Retrieve a list of billing meters.

.`, inputSchema: stripe.GetBillingMetersParamsSchema }) - async GetBillingMeters( + async getBillingMeters( params: stripe.GetBillingMetersParams ): Promise { return this.ky .get('/v1/billing/meters', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'ending_before', + 'expand', + 'limit', + 'starting_after', + 'status' + ) + ) }) .json() } @@ -62537,10 +60294,10 @@ or when trying to refund more money than is left on an application fee.

.`, */ @aiFunction({ name: 'post_billing_meters', - description: '

Creates a billing meter.

.', + description: `

Creates a billing meter.

.`, inputSchema: stripe.PostBillingMetersParamsSchema }) - async PostBillingMeters( + async postBillingMeters( _params: stripe.PostBillingMetersParams ): Promise { return this.ky @@ -62553,10 +60310,10 @@ or when trying to refund more money than is left on an application fee.

.`, */ @aiFunction({ name: 'get_billing_meters_id', - description: '

Retrieves a billing meter given an ID.

.', + description: `

Retrieves a billing meter given an ID.

.`, inputSchema: stripe.GetBillingMetersIdParamsSchema }) - async GetBillingMetersId( + async getBillingMetersId( params: stripe.GetBillingMetersIdParams ): Promise { return this.ky @@ -62571,10 +60328,10 @@ or when trying to refund more money than is left on an application fee.

.`, */ @aiFunction({ name: 'post_billing_meters_id', - description: '

Updates a billing meter.

.', + description: `

Updates a billing meter.

.`, inputSchema: stripe.PostBillingMetersIdParamsSchema }) - async PostBillingMetersId( + async postBillingMetersId( params: stripe.PostBillingMetersIdParams ): Promise { return this.ky @@ -62587,11 +60344,10 @@ or when trying to refund more money than is left on an application fee.

.`, */ @aiFunction({ name: 'post_billing_meters_id_deactivate', - description: - '

When a meter is deactivated, no more meter events will be accepted for this meter. You can’t attach a deactivated meter to a price.

.', + description: `

When a meter is deactivated, no more meter events will be accepted for this meter. You can’t attach a deactivated meter to a price.

.`, inputSchema: stripe.PostBillingMetersIdDeactivateParamsSchema }) - async PostBillingMetersIdDeactivate( + async postBillingMetersIdDeactivate( params: stripe.PostBillingMetersIdDeactivateParams ): Promise { return this.ky @@ -62604,10 +60360,10 @@ or when trying to refund more money than is left on an application fee.

.`, */ @aiFunction({ name: 'get_billing_meters_id_event_summaries', - description: '

Retrieve a list of billing meter event summaries.

.', + description: `

Retrieve a list of billing meter event summaries.

.`, inputSchema: stripe.GetBillingMetersIdEventSummariesParamsSchema }) - async GetBillingMetersIdEventSummaries( + async getBillingMetersIdEventSummaries( params: stripe.GetBillingMetersIdEventSummariesParams ): Promise { return this.ky @@ -62634,11 +60390,10 @@ or when trying to refund more money than is left on an application fee.

.`, */ @aiFunction({ name: 'post_billing_meters_id_reactivate', - description: - '

When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.

.', + description: `

When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.

.`, inputSchema: stripe.PostBillingMetersIdReactivateParamsSchema }) - async PostBillingMetersIdReactivate( + async postBillingMetersIdReactivate( params: stripe.PostBillingMetersIdReactivateParams ): Promise { return this.ky @@ -62651,16 +60406,25 @@ or when trying to refund more money than is left on an application fee.

.`, */ @aiFunction({ name: 'get_billing_portal_configurations', - description: - '

Returns a list of configurations that describe the functionality of the customer portal.

.', + description: `

Returns a list of configurations that describe the functionality of the customer portal.

.`, inputSchema: stripe.GetBillingPortalConfigurationsParamsSchema }) - async GetBillingPortalConfigurations( + async getBillingPortalConfigurations( params: stripe.GetBillingPortalConfigurationsParams ): Promise { return this.ky .get('/v1/billing_portal/configurations', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'active', + 'ending_before', + 'expand', + 'is_default', + 'limit', + 'starting_after' + ) + ) }) .json() } @@ -62670,11 +60434,10 @@ or when trying to refund more money than is left on an application fee.

.`, */ @aiFunction({ name: 'post_billing_portal_configurations', - description: - '

Creates a configuration that describes the functionality and behavior of a PortalSession

.', + description: `

Creates a configuration that describes the functionality and behavior of a PortalSession

.`, inputSchema: stripe.PostBillingPortalConfigurationsParamsSchema }) - async PostBillingPortalConfigurations( + async postBillingPortalConfigurations( _params: stripe.PostBillingPortalConfigurationsParams ): Promise { return this.ky @@ -62687,11 +60450,10 @@ or when trying to refund more money than is left on an application fee.

.`, */ @aiFunction({ name: 'get_billing_portal_configurations_configuration', - description: - '

Retrieves a configuration that describes the functionality of the customer portal.

.', + description: `

Retrieves a configuration that describes the functionality of the customer portal.

.`, inputSchema: stripe.GetBillingPortalConfigurationsConfigurationParamsSchema }) - async GetBillingPortalConfigurationsConfiguration( + async getBillingPortalConfigurationsConfiguration( params: stripe.GetBillingPortalConfigurationsConfigurationParams ): Promise { return this.ky @@ -62706,11 +60468,10 @@ or when trying to refund more money than is left on an application fee.

.`, */ @aiFunction({ name: 'post_billing_portal_configurations_configuration', - description: - '

Updates a configuration that describes the functionality of the customer portal.

.', + description: `

Updates a configuration that describes the functionality of the customer portal.

.`, inputSchema: stripe.PostBillingPortalConfigurationsConfigurationParamsSchema }) - async PostBillingPortalConfigurationsConfiguration( + async postBillingPortalConfigurationsConfiguration( params: stripe.PostBillingPortalConfigurationsConfigurationParams ): Promise { return this.ky @@ -62723,10 +60484,10 @@ or when trying to refund more money than is left on an application fee.

.`, */ @aiFunction({ name: 'post_billing_portal_sessions', - description: '

Creates a session of the customer portal.

.', + description: `

Creates a session of the customer portal.

.`, inputSchema: stripe.PostBillingPortalSessionsParamsSchema }) - async PostBillingPortalSessions( + async postBillingPortalSessions( _params: stripe.PostBillingPortalSessionsParams ): Promise { return this.ky @@ -62739,16 +60500,27 @@ or when trying to refund more money than is left on an application fee.

.`, */ @aiFunction({ name: 'get_charges', - description: - '

Returns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first.

.', + description: `

Returns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first.

.`, inputSchema: stripe.GetChargesParamsSchema }) - async GetCharges( + async getCharges( params: stripe.GetChargesParams ): Promise { return this.ky .get('/v1/charges', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'created', + 'customer', + 'ending_before', + 'expand', + 'limit', + 'payment_intent', + 'starting_after', + 'transfer_group' + ) + ) }) .json() } @@ -62765,7 +60537,7 @@ to initiate a new payment instead. Confirmation of the PaymentIntent creates the object used to request payment.

.`, inputSchema: stripe.PostChargesParamsSchema }) - async PostCharges( + async postCharges( _params: stripe.PostChargesParams ): Promise { return this.ky.post('/v1/charges').json() @@ -62785,12 +60557,14 @@ conditions, data is searchable in less than a minute. Occasionally, propagation to an hour behind during outages. Search functionality is not available to merchants in India.

.`, inputSchema: stripe.GetChargesSearchParamsSchema }) - async GetChargesSearch( + async getChargesSearch( params: stripe.GetChargesSearchParams ): Promise { return this.ky .get('/v1/charges/search', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick(params, 'expand', 'limit', 'page', 'query') + ) }) .json() } @@ -62800,11 +60574,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'get_charges_charge', - description: - '

Retrieves the details of a charge that has previously been created. Supply the unique charge ID that was returned from your previous request, and Stripe will return the corresponding charge information. The same information is returned when creating or refunding the charge.

.', + description: `

Retrieves the details of a charge that has previously been created. Supply the unique charge ID that was returned from your previous request, and Stripe will return the corresponding charge information. The same information is returned when creating or refunding the charge.

.`, inputSchema: stripe.GetChargesChargeParamsSchema }) - async GetChargesCharge( + async getChargesCharge( params: stripe.GetChargesChargeParams ): Promise { return this.ky @@ -62819,11 +60592,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'post_charges_charge', - description: - '

Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

.', + description: `

Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

.`, inputSchema: stripe.PostChargesChargeParamsSchema }) - async PostChargesCharge( + async postChargesCharge( params: stripe.PostChargesChargeParams ): Promise { return this.ky @@ -62847,7 +60619,7 @@ to an hour behind during outages. Search functionality is not available to merch

Don’t use this method to capture a PaymentIntent-initiated charge. Use Capture a PaymentIntent.

.`, inputSchema: stripe.PostChargesChargeCaptureParamsSchema }) - async PostChargesChargeCapture( + async postChargesChargeCapture( params: stripe.PostChargesChargeCaptureParams ): Promise { return this.ky @@ -62860,10 +60632,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'get_charges_charge_dispute', - description: '

Retrieve a dispute for a specified charge.

.', + description: `

Retrieve a dispute for a specified charge.

.`, inputSchema: stripe.GetChargesChargeDisputeParamsSchema }) - async GetChargesChargeDispute( + async getChargesChargeDispute( params: stripe.GetChargesChargeDisputeParams ): Promise { return this.ky @@ -62878,7 +60650,7 @@ to an hour behind during outages. Search functionality is not available to merch inputSchema: stripe.PostChargesChargeDisputeParamsSchema }) - async PostChargesChargeDispute( + async postChargesChargeDispute( params: stripe.PostChargesChargeDisputeParams ): Promise { return this.ky @@ -62891,7 +60663,7 @@ to an hour behind during outages. Search functionality is not available to merch inputSchema: stripe.PostChargesChargeDisputeCloseParamsSchema }) - async PostChargesChargeDisputeClose( + async postChargesChargeDisputeClose( params: stripe.PostChargesChargeDisputeCloseParams ): Promise { return this.ky @@ -62927,7 +60699,7 @@ This method raises an error when it’s called on an already-refunded charge, or when you attempt to refund more money than is left on a charge.

.`, inputSchema: stripe.PostChargesChargeRefundParamsSchema }) - async PostChargesChargeRefund( + async postChargesChargeRefund( params: stripe.PostChargesChargeRefundParams ): Promise { return this.ky @@ -62940,11 +60712,10 @@ or when you attempt to refund more money than is left on a charge.

.`, */ @aiFunction({ name: 'get_charges_charge_refunds', - description: - '

You can see a list of the refunds belonging to a specific charge. Note that the 10 most recent refunds are always available by default on the charge object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.

.', + description: `

You can see a list of the refunds belonging to a specific charge. Note that the 10 most recent refunds are always available by default on the charge object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.

.`, inputSchema: stripe.GetChargesChargeRefundsParamsSchema }) - async GetChargesChargeRefunds( + async getChargesChargeRefunds( params: stripe.GetChargesChargeRefundsParams ): Promise { return this.ky @@ -62984,7 +60755,7 @@ This method will raise an error when called on an already-refunded charge, or when trying to refund more money than is left on a charge.

.`, inputSchema: stripe.PostChargesChargeRefundsParamsSchema }) - async PostChargesChargeRefunds( + async postChargesChargeRefunds( params: stripe.PostChargesChargeRefundsParams ): Promise { return this.ky @@ -62997,10 +60768,10 @@ or when trying to refund more money than is left on a charge.

.`, */ @aiFunction({ name: 'get_charges_charge_refunds_refund', - description: '

Retrieves the details of an existing refund.

.', + description: `

Retrieves the details of an existing refund.

.`, inputSchema: stripe.GetChargesChargeRefundsRefundParamsSchema }) - async GetChargesChargeRefundsRefund( + async getChargesChargeRefundsRefund( params: stripe.GetChargesChargeRefundsRefundParams ): Promise { return this.ky @@ -63015,14 +60786,14 @@ or when trying to refund more money than is left on a charge.

.`, */ @aiFunction({ name: 'post_charges_charge_refunds_refund', - description: '

Update a specified refund.

.', + description: `

Update a specified refund.

.`, inputSchema: stripe.PostChargesChargeRefundsRefundParamsSchema }) - async PostChargesChargeRefundsRefund( + async postChargesChargeRefundsRefund( params: stripe.PostChargesChargeRefundsRefundParams ): Promise { return this.ky - .post(`/v1/charges/${params.charge}/refunds/${params.refund}`) + .post(`/v1/charges/${params.charge}/refunds/${params.refund}`, {}) .json() } @@ -63031,15 +60802,30 @@ or when trying to refund more money than is left on a charge.

.`, */ @aiFunction({ name: 'get_checkout_sessions', - description: '

Returns a list of Checkout Sessions.

.', + description: `

Returns a list of Checkout Sessions.

.`, inputSchema: stripe.GetCheckoutSessionsParamsSchema }) - async GetCheckoutSessions( + async getCheckoutSessions( params: stripe.GetCheckoutSessionsParams ): Promise { return this.ky .get('/v1/checkout/sessions', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'created', + 'customer', + 'customer_details', + 'ending_before', + 'expand', + 'limit', + 'payment_intent', + 'payment_link', + 'starting_after', + 'status', + 'subscription' + ) + ) }) .json() } @@ -63049,10 +60835,10 @@ or when trying to refund more money than is left on a charge.

.`, */ @aiFunction({ name: 'post_checkout_sessions', - description: '

Creates a Session object.

.', + description: `

Creates a Session object.

.`, inputSchema: stripe.PostCheckoutSessionsParamsSchema }) - async PostCheckoutSessions( + async postCheckoutSessions( _params: stripe.PostCheckoutSessionsParams ): Promise { return this.ky @@ -63065,10 +60851,10 @@ or when trying to refund more money than is left on a charge.

.`, */ @aiFunction({ name: 'get_checkout_sessions_session', - description: '

Retrieves a Session object.

.', + description: `

Retrieves a Session object.

.`, inputSchema: stripe.GetCheckoutSessionsSessionParamsSchema }) - async GetCheckoutSessionsSession( + async getCheckoutSessionsSession( params: stripe.GetCheckoutSessionsSessionParams ): Promise { return this.ky @@ -63083,10 +60869,10 @@ or when trying to refund more money than is left on a charge.

.`, */ @aiFunction({ name: 'post_checkout_sessions_session', - description: '

Updates a Session object.

.', + description: `

Updates a Session object.

.`, inputSchema: stripe.PostCheckoutSessionsSessionParamsSchema }) - async PostCheckoutSessionsSession( + async postCheckoutSessionsSession( params: stripe.PostCheckoutSessionsSessionParams ): Promise { return this.ky @@ -63106,7 +60892,7 @@ or when trying to refund more money than is left on a charge.

.`,

After it expires, a customer can’t complete a Session and customers loading the Session see a message saying the Session is expired.

.`, inputSchema: stripe.PostCheckoutSessionsSessionExpireParamsSchema }) - async PostCheckoutSessionsSessionExpire( + async postCheckoutSessionsSessionExpire( params: stripe.PostCheckoutSessionsSessionExpireParams ): Promise { return this.ky @@ -63119,11 +60905,10 @@ or when trying to refund more money than is left on a charge.

.`, */ @aiFunction({ name: 'get_checkout_sessions_session_line_items', - description: - '

When retrieving a Checkout Session, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

.', + description: `

When retrieving a Checkout Session, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

.`, inputSchema: stripe.GetCheckoutSessionsSessionLineItemsParamsSchema }) - async GetCheckoutSessionsSessionLineItems( + async getCheckoutSessionsSessionLineItems( params: stripe.GetCheckoutSessionsSessionLineItemsParams ): Promise { return this.ky @@ -63145,12 +60930,14 @@ most recently created orders appearing first.

. most recently created orders appearing first.

.`, inputSchema: stripe.GetClimateOrdersParamsSchema }) - async GetClimateOrders( + async getClimateOrders( params: stripe.GetClimateOrdersParams ): Promise { return this.ky .get('/v1/climate/orders', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick(params, 'ending_before', 'expand', 'limit', 'starting_after') + ) }) .json() } @@ -63165,7 +60952,7 @@ after creation and payment will be deducted your Stripe balance.

. after creation and payment will be deducted your Stripe balance.

.`, inputSchema: stripe.PostClimateOrdersParamsSchema }) - async PostClimateOrders( + async postClimateOrders( _params: stripe.PostClimateOrdersParams ): Promise { return this.ky @@ -63178,11 +60965,10 @@ after creation and payment will be deducted your Stripe balance.

.`, */ @aiFunction({ name: 'get_climate_orders_order', - description: - '

Retrieves the details of a Climate order object with the given ID.

.', + description: `

Retrieves the details of a Climate order object with the given ID.

.`, inputSchema: stripe.GetClimateOrdersOrderParamsSchema }) - async GetClimateOrdersOrder( + async getClimateOrdersOrder( params: stripe.GetClimateOrdersOrderParams ): Promise { return this.ky @@ -63197,11 +60983,10 @@ after creation and payment will be deducted your Stripe balance.

.`, */ @aiFunction({ name: 'post_climate_orders_order', - description: - '

Updates the specified order by setting the values of the parameters passed.

.', + description: `

Updates the specified order by setting the values of the parameters passed.

.`, inputSchema: stripe.PostClimateOrdersOrderParamsSchema }) - async PostClimateOrdersOrder( + async postClimateOrdersOrder( params: stripe.PostClimateOrdersOrderParams ): Promise { return this.ky @@ -63223,7 +61008,7 @@ might cancel reservations if suppliers fail to deliver. If Frontier cancels the provides 90 days advance notice and refunds the amount_total.

.`, inputSchema: stripe.PostClimateOrdersOrderCancelParamsSchema }) - async PostClimateOrdersOrderCancel( + async postClimateOrdersOrderCancel( params: stripe.PostClimateOrdersOrderCancelParams ): Promise { return this.ky @@ -63236,15 +61021,17 @@ provides 90 days advance notice and refunds the amount_total.

.` */ @aiFunction({ name: 'get_climate_products', - description: '

Lists all available Climate product objects.

.', + description: `

Lists all available Climate product objects.

.`, inputSchema: stripe.GetClimateProductsParamsSchema }) - async GetClimateProducts( + async getClimateProducts( params: stripe.GetClimateProductsParams ): Promise { return this.ky .get('/v1/climate/products', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick(params, 'ending_before', 'expand', 'limit', 'starting_after') + ) }) .json() } @@ -63254,11 +61041,10 @@ provides 90 days advance notice and refunds the amount_total.

.` */ @aiFunction({ name: 'get_climate_products_product', - description: - '

Retrieves the details of a Climate product with the given ID.

.', + description: `

Retrieves the details of a Climate product with the given ID.

.`, inputSchema: stripe.GetClimateProductsProductParamsSchema }) - async GetClimateProductsProduct( + async getClimateProductsProduct( params: stripe.GetClimateProductsProductParams ): Promise { return this.ky @@ -63273,15 +61059,17 @@ provides 90 days advance notice and refunds the amount_total.

.` */ @aiFunction({ name: 'get_climate_suppliers', - description: '

Lists all available Climate supplier objects.

.', + description: `

Lists all available Climate supplier objects.

.`, inputSchema: stripe.GetClimateSuppliersParamsSchema }) - async GetClimateSuppliers( + async getClimateSuppliers( params: stripe.GetClimateSuppliersParams ): Promise { return this.ky .get('/v1/climate/suppliers', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick(params, 'ending_before', 'expand', 'limit', 'starting_after') + ) }) .json() } @@ -63291,10 +61079,10 @@ provides 90 days advance notice and refunds the amount_total.

.` */ @aiFunction({ name: 'get_climate_suppliers_supplier', - description: '

Retrieves a Climate supplier object.

.', + description: `

Retrieves a Climate supplier object.

.`, inputSchema: stripe.GetClimateSuppliersSupplierParamsSchema }) - async GetClimateSuppliersSupplier( + async getClimateSuppliersSupplier( params: stripe.GetClimateSuppliersSupplierParams ): Promise { return this.ky @@ -63309,10 +61097,10 @@ provides 90 days advance notice and refunds the amount_total.

.` */ @aiFunction({ name: 'get_confirmation_tokens_confirmation_token', - description: '

Retrieves an existing ConfirmationToken object

.', + description: `

Retrieves an existing ConfirmationToken object

.`, inputSchema: stripe.GetConfirmationTokensConfirmationTokenParamsSchema }) - async GetConfirmationTokensConfirmationToken( + async getConfirmationTokensConfirmationToken( params: stripe.GetConfirmationTokensConfirmationTokenParams ): Promise { return this.ky @@ -63327,15 +61115,17 @@ provides 90 days advance notice and refunds the amount_total.

.` */ @aiFunction({ name: 'get_country_specs', - description: '

Lists all Country Spec objects available in the API.

.', + description: `

Lists all Country Spec objects available in the API.

.`, inputSchema: stripe.GetCountrySpecsParamsSchema }) - async GetCountrySpecs( + async getCountrySpecs( params: stripe.GetCountrySpecsParams ): Promise { return this.ky .get('/v1/country_specs', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick(params, 'ending_before', 'expand', 'limit', 'starting_after') + ) }) .json() } @@ -63345,10 +61135,10 @@ provides 90 days advance notice and refunds the amount_total.

.` */ @aiFunction({ name: 'get_country_specs_country', - description: '

Returns a Country Spec for a given Country code.

.', + description: `

Returns a Country Spec for a given Country code.

.`, inputSchema: stripe.GetCountrySpecsCountryParamsSchema }) - async GetCountrySpecsCountry( + async getCountrySpecsCountry( params: stripe.GetCountrySpecsCountryParams ): Promise { return this.ky @@ -63363,15 +61153,24 @@ provides 90 days advance notice and refunds the amount_total.

.` */ @aiFunction({ name: 'get_coupons', - description: '

Returns a list of your coupons.

.', + description: `

Returns a list of your coupons.

.`, inputSchema: stripe.GetCouponsParamsSchema }) - async GetCoupons( + async getCoupons( params: stripe.GetCouponsParams ): Promise { return this.ky .get('/v1/coupons', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'created', + 'ending_before', + 'expand', + 'limit', + 'starting_after' + ) + ) }) .json() } @@ -63388,7 +61187,7 @@ provides 90 days advance notice and refunds the amount_total.

.`

A coupon has either a percent_off or an amount_off and currency. If you set an amount_off, that amount will be subtracted from any invoice’s subtotal. For example, an invoice with a subtotal of 100 will have a final total of 0 if a coupon with an amount_off of 200 is applied to it and an invoice with a subtotal of 300 will have a final total of 100 if a coupon with an amount_off of 200 is applied to it.

.`, inputSchema: stripe.PostCouponsParamsSchema }) - async PostCoupons( + async postCoupons( _params: stripe.PostCouponsParams ): Promise { return this.ky.post('/v1/coupons').json() @@ -63399,10 +61198,10 @@ provides 90 days advance notice and refunds the amount_total.

.` */ @aiFunction({ name: 'get_coupons_coupon', - description: '

Retrieves the coupon with the given ID.

.', + description: `

Retrieves the coupon with the given ID.

.`, inputSchema: stripe.GetCouponsCouponParamsSchema }) - async GetCouponsCoupon( + async getCouponsCoupon( params: stripe.GetCouponsCouponParams ): Promise { return this.ky @@ -63417,11 +61216,10 @@ provides 90 days advance notice and refunds the amount_total.

.` */ @aiFunction({ name: 'post_coupons_coupon', - description: - '

Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.

.', + description: `

Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.

.`, inputSchema: stripe.PostCouponsCouponParamsSchema }) - async PostCouponsCoupon( + async postCouponsCoupon( params: stripe.PostCouponsCouponParams ): Promise { return this.ky @@ -63434,11 +61232,10 @@ provides 90 days advance notice and refunds the amount_total.

.` */ @aiFunction({ name: 'delete_coupons_coupon', - description: - '

You can delete coupons via the coupon management page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can’t redeem the coupon. You can also delete coupons via the API.

.', + description: `

You can delete coupons via the coupon management page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can’t redeem the coupon. You can also delete coupons via the API.

.`, inputSchema: stripe.DeleteCouponsCouponParamsSchema }) - async DeleteCouponsCoupon( + async deleteCouponsCoupon( params: stripe.DeleteCouponsCouponParams ): Promise { return this.ky @@ -63451,15 +61248,26 @@ provides 90 days advance notice and refunds the amount_total.

.` */ @aiFunction({ name: 'get_credit_notes', - description: '

Returns a list of credit notes.

.', + description: `

Returns a list of credit notes.

.`, inputSchema: stripe.GetCreditNotesParamsSchema }) - async GetCreditNotes( + async getCreditNotes( params: stripe.GetCreditNotesParams ): Promise { return this.ky .get('/v1/credit_notes', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'created', + 'customer', + 'ending_before', + 'expand', + 'invoice', + 'limit', + 'starting_after' + ) + ) }) .json() } @@ -63498,7 +61306,7 @@ in any combination of the following:

or post_payment_credit_notes_amount depending on its status at the time of credit note creation.

.`, inputSchema: stripe.PostCreditNotesParamsSchema }) - async PostCreditNotes( + async postCreditNotes( _params: stripe.PostCreditNotesParams ): Promise { return this.ky @@ -63511,15 +61319,33 @@ or post_payment_credit_notes_amount depending on its statusGet a preview of a credit note without creating it.

.', + description: `

Get a preview of a credit note without creating it.

.`, inputSchema: stripe.GetCreditNotesPreviewParamsSchema }) - async GetCreditNotesPreview( + async getCreditNotesPreview( params: stripe.GetCreditNotesPreviewParams ): Promise { return this.ky .get('/v1/credit_notes/preview', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'amount', + 'credit_amount', + 'effective_at', + 'email_type', + 'expand', + 'invoice', + 'lines', + 'memo', + 'metadata', + 'out_of_band_amount', + 'reason', + 'refund', + 'refund_amount', + 'shipping_cost' + ) + ) }) .json() } @@ -63529,16 +61355,36 @@ or post_payment_credit_notes_amount depending on its statusWhen retrieving a credit note preview, you’ll get a lines property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items.

.', + description: `

When retrieving a credit note preview, you’ll get a lines property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items.

.`, inputSchema: stripe.GetCreditNotesPreviewLinesParamsSchema }) - async GetCreditNotesPreviewLines( + async getCreditNotesPreviewLines( params: stripe.GetCreditNotesPreviewLinesParams ): Promise { return this.ky .get('/v1/credit_notes/preview/lines', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'amount', + 'credit_amount', + 'effective_at', + 'email_type', + 'ending_before', + 'expand', + 'invoice', + 'limit', + 'lines', + 'memo', + 'metadata', + 'out_of_band_amount', + 'reason', + 'refund', + 'refund_amount', + 'shipping_cost', + 'starting_after' + ) + ) }) .json() } @@ -63548,11 +61394,10 @@ or post_payment_credit_notes_amount depending on its statusWhen retrieving a credit note, you’ll get a lines property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

.', + description: `

When retrieving a credit note, you’ll get a lines property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

.`, inputSchema: stripe.GetCreditNotesCreditNoteLinesParamsSchema }) - async GetCreditNotesCreditNoteLines( + async getCreditNotesCreditNoteLines( params: stripe.GetCreditNotesCreditNoteLinesParams ): Promise { return this.ky @@ -63569,11 +61414,10 @@ or post_payment_credit_notes_amount depending on its statusRetrieves the credit note object with the given identifier.

.', + description: `

Retrieves the credit note object with the given identifier.

.`, inputSchema: stripe.GetCreditNotesIdParamsSchema }) - async GetCreditNotesId( + async getCreditNotesId( params: stripe.GetCreditNotesIdParams ): Promise { return this.ky @@ -63588,10 +61432,10 @@ or post_payment_credit_notes_amount depending on its statusUpdates an existing credit note.

.', + description: `

Updates an existing credit note.

.`, inputSchema: stripe.PostCreditNotesIdParamsSchema }) - async PostCreditNotesId( + async postCreditNotesId( params: stripe.PostCreditNotesIdParams ): Promise { return this.ky @@ -63604,11 +61448,10 @@ or post_payment_credit_notes_amount depending on its statusMarks a credit note as void. Learn more about voiding credit notes.

.', + description: `

Marks a credit note as void. Learn more about voiding credit notes.

.`, inputSchema: stripe.PostCreditNotesIdVoidParamsSchema }) - async PostCreditNotesIdVoid( + async postCreditNotesIdVoid( params: stripe.PostCreditNotesIdVoidParams ): Promise { return this.ky @@ -63621,11 +61464,10 @@ or post_payment_credit_notes_amount depending on its statusCreates a Customer Session object that includes a single-use client secret that you can use on your front-end to grant client-side API access for certain customer resources.

.', + description: `

Creates a Customer Session object that includes a single-use client secret that you can use on your front-end to grant client-side API access for certain customer resources.

.`, inputSchema: stripe.PostCustomerSessionsParamsSchema }) - async PostCustomerSessions( + async postCustomerSessions( _params: stripe.PostCustomerSessionsParams ): Promise { return this.ky @@ -63638,16 +61480,26 @@ or post_payment_credit_notes_amount depending on its statusReturns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.

.', + description: `

Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.

.`, inputSchema: stripe.GetCustomersParamsSchema }) - async GetCustomers( + async getCustomers( params: stripe.GetCustomersParams ): Promise { return this.ky .get('/v1/customers', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'created', + 'email', + 'ending_before', + 'expand', + 'limit', + 'starting_after', + 'test_clock' + ) + ) }) .json() } @@ -63657,10 +61509,10 @@ or post_payment_credit_notes_amount depending on its statusCreates a new customer object.

.', + description: `

Creates a new customer object.

.`, inputSchema: stripe.PostCustomersParamsSchema }) - async PostCustomers( + async postCustomers( _params: stripe.PostCustomersParams ): Promise { return this.ky.post('/v1/customers').json() @@ -63680,12 +61532,14 @@ conditions, data is searchable in less than a minute. Occasionally, propagation to an hour behind during outages. Search functionality is not available to merchants in India.

.`, inputSchema: stripe.GetCustomersSearchParamsSchema }) - async GetCustomersSearch( + async getCustomersSearch( params: stripe.GetCustomersSearchParams ): Promise { return this.ky .get('/v1/customers/search', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick(params, 'expand', 'limit', 'page', 'query') + ) }) .json() } @@ -63695,10 +61549,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'get_customers_customer', - description: '

Retrieves a Customer object.

.', + description: `

Retrieves a Customer object.

.`, inputSchema: stripe.GetCustomersCustomerParamsSchema }) - async GetCustomersCustomer( + async getCustomersCustomer( params: stripe.GetCustomersCustomerParams ): Promise { return this.ky @@ -63720,7 +61574,7 @@ to an hour behind during outages. Search functionality is not available to merch

This request accepts mostly the same arguments as the customer creation call.

.`, inputSchema: stripe.PostCustomersCustomerParamsSchema }) - async PostCustomersCustomer( + async postCustomersCustomer( params: stripe.PostCustomersCustomerParams ): Promise { return this.ky @@ -63733,11 +61587,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'delete_customers_customer', - description: - '

Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.

.', + description: `

Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.

.`, inputSchema: stripe.DeleteCustomersCustomerParamsSchema }) - async DeleteCustomersCustomer( + async deleteCustomersCustomer( params: stripe.DeleteCustomersCustomerParams ): Promise { return this.ky @@ -63750,11 +61603,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'get_customers_customer_balance_transactions', - description: - '

Returns a list of transactions that updated the customer’s balances.

.', + description: `

Returns a list of transactions that updated the customer’s balances.

.`, inputSchema: stripe.GetCustomersCustomerBalanceTransactionsParamsSchema }) - async GetCustomersCustomerBalanceTransactions( + async getCustomersCustomerBalanceTransactions( params: stripe.GetCustomersCustomerBalanceTransactionsParams ): Promise { return this.ky @@ -63771,11 +61623,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'post_customers_customer_balance_transactions', - description: - '

Creates an immutable transaction that updates the customer’s credit balance.

.', + description: `

Creates an immutable transaction that updates the customer’s credit balance.

.`, inputSchema: stripe.PostCustomersCustomerBalanceTransactionsParamsSchema }) - async PostCustomersCustomerBalanceTransactions( + async postCustomersCustomerBalanceTransactions( params: stripe.PostCustomersCustomerBalanceTransactionsParams ): Promise { return this.ky @@ -63788,12 +61639,11 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'get_customers_customer_balance_transactions_transaction', - description: - '

Retrieves a specific customer balance transaction that updated the customer’s balances.

.', + description: `

Retrieves a specific customer balance transaction that updated the customer’s balances.

.`, inputSchema: stripe.GetCustomersCustomerBalanceTransactionsTransactionParamsSchema }) - async GetCustomersCustomerBalanceTransactionsTransaction( + async getCustomersCustomerBalanceTransactionsTransaction( params: stripe.GetCustomersCustomerBalanceTransactionsTransactionParams ): Promise { return this.ky @@ -63811,17 +61661,17 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'post_customers_customer_balance_transactions_transaction', - description: - '

Most credit balance transaction fields are immutable, but you may update its description and metadata.

.', + description: `

Most credit balance transaction fields are immutable, but you may update its description and metadata.

.`, inputSchema: stripe.PostCustomersCustomerBalanceTransactionsTransactionParamsSchema }) - async PostCustomersCustomerBalanceTransactionsTransaction( + async postCustomersCustomerBalanceTransactionsTransaction( params: stripe.PostCustomersCustomerBalanceTransactionsTransactionParams ): Promise { return this.ky .post( - `/v1/customers/${params.customer}/balance_transactions/${params.transaction}` + `/v1/customers/${params.customer}/balance_transactions/${params.transaction}`, + {} ) .json() } @@ -63831,11 +61681,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'get_customers_customer_bank_accounts', - description: - '

You can see a list of the bank accounts belonging to a Customer. Note that the 10 most recent sources are always available by default on the Customer. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional bank accounts.

.', + description: `

You can see a list of the bank accounts belonging to a Customer. Note that the 10 most recent sources are always available by default on the Customer. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional bank accounts.

.`, inputSchema: stripe.GetCustomersCustomerBankAccountsParamsSchema }) - async GetCustomersCustomerBankAccounts( + async getCustomersCustomerBankAccounts( params: stripe.GetCustomersCustomerBankAccountsParams ): Promise { return this.ky @@ -63863,7 +61712,7 @@ However, if the owner already has a default, then it will not change. To change the default, you should update the customer to have a new default_source.

.`, inputSchema: stripe.PostCustomersCustomerBankAccountsParamsSchema }) - async PostCustomersCustomerBankAccounts( + async postCustomersCustomerBankAccounts( params: stripe.PostCustomersCustomerBankAccountsParams ): Promise { return this.ky @@ -63876,11 +61725,10 @@ To change the default, you should update the */ @aiFunction({ name: 'get_customers_customer_bank_accounts_id', - description: - '

By default, you can see the 10 most recent sources stored on a Customer directly on the object, but you can also retrieve details about a specific bank account stored on the Stripe account.

.', + description: `

By default, you can see the 10 most recent sources stored on a Customer directly on the object, but you can also retrieve details about a specific bank account stored on the Stripe account.

.`, inputSchema: stripe.GetCustomersCustomerBankAccountsIdParamsSchema }) - async GetCustomersCustomerBankAccountsId( + async getCustomersCustomerBankAccountsId( params: stripe.GetCustomersCustomerBankAccountsIdParams ): Promise { return this.ky @@ -63898,14 +61746,17 @@ To change the default, you should update the */ @aiFunction({ name: 'post_customers_customer_bank_accounts_id', - description: '

Update a specified source for a given customer.

.', + description: `

Update a specified source for a given customer.

.`, inputSchema: stripe.PostCustomersCustomerBankAccountsIdParamsSchema }) - async PostCustomersCustomerBankAccountsId( + async postCustomersCustomerBankAccountsId( params: stripe.PostCustomersCustomerBankAccountsIdParams ): Promise { return this.ky - .post(`/v1/customers/${params.customer}/bank_accounts/${params.id}`) + .post( + `/v1/customers/${params.customer}/bank_accounts/${params.id}`, + {} + ) .json() } @@ -63914,15 +61765,16 @@ To change the default, you should update the */ @aiFunction({ name: 'delete_customers_customer_bank_accounts_id', - description: '

Delete a specified source for a given customer.

.', + description: `

Delete a specified source for a given customer.

.`, inputSchema: stripe.DeleteCustomersCustomerBankAccountsIdParamsSchema }) - async DeleteCustomersCustomerBankAccountsId( + async deleteCustomersCustomerBankAccountsId( params: stripe.DeleteCustomersCustomerBankAccountsIdParams ): Promise { return this.ky .delete( - `/v1/customers/${params.customer}/bank_accounts/${params.id}` + `/v1/customers/${params.customer}/bank_accounts/${params.id}`, + {} ) .json() } @@ -63932,16 +61784,16 @@ To change the default, you should update the */ @aiFunction({ name: 'post_customers_customer_bank_accounts_id_verify', - description: - '

Verify a specified bank account for a given customer.

.', + description: `

Verify a specified bank account for a given customer.

.`, inputSchema: stripe.PostCustomersCustomerBankAccountsIdVerifyParamsSchema }) - async PostCustomersCustomerBankAccountsIdVerify( + async postCustomersCustomerBankAccountsIdVerify( params: stripe.PostCustomersCustomerBankAccountsIdVerifyParams ): Promise { return this.ky .post( - `/v1/customers/${params.customer}/bank_accounts/${params.id}/verify` + `/v1/customers/${params.customer}/bank_accounts/${params.id}/verify`, + {} ) .json() } @@ -63958,7 +61810,7 @@ Note that the 10 most recent sources are always available on the Customer< If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional cards.

.`, inputSchema: stripe.GetCustomersCustomerCardsParamsSchema }) - async GetCustomersCustomerCards( + async getCustomersCustomerCards( params: stripe.GetCustomersCustomerCardsParams ): Promise { return this.ky @@ -63986,7 +61838,7 @@ However, if the owner already has a default, then it will not change. To change the default, you should update the customer to have a new default_source.

.`, inputSchema: stripe.PostCustomersCustomerCardsParamsSchema }) - async PostCustomersCustomerCards( + async postCustomersCustomerCards( params: stripe.PostCustomersCustomerCardsParams ): Promise { return this.ky @@ -63999,11 +61851,10 @@ To change the default, you should update the */ @aiFunction({ name: 'get_customers_customer_cards_id', - description: - '

You can always see the 10 most recent cards directly on a customer; this method lets you retrieve details about a specific card stored on the customer.

.', + description: `

You can always see the 10 most recent cards directly on a customer; this method lets you retrieve details about a specific card stored on the customer.

.`, inputSchema: stripe.GetCustomersCustomerCardsIdParamsSchema }) - async GetCustomersCustomerCardsId( + async getCustomersCustomerCardsId( params: stripe.GetCustomersCustomerCardsIdParams ): Promise { return this.ky @@ -64018,14 +61869,14 @@ To change the default, you should update the */ @aiFunction({ name: 'post_customers_customer_cards_id', - description: '

Update a specified source for a given customer.

.', + description: `

Update a specified source for a given customer.

.`, inputSchema: stripe.PostCustomersCustomerCardsIdParamsSchema }) - async PostCustomersCustomerCardsId( + async postCustomersCustomerCardsId( params: stripe.PostCustomersCustomerCardsIdParams ): Promise { return this.ky - .post(`/v1/customers/${params.customer}/cards/${params.id}`) + .post(`/v1/customers/${params.customer}/cards/${params.id}`, {}) .json() } @@ -64034,14 +61885,14 @@ To change the default, you should update the */ @aiFunction({ name: 'delete_customers_customer_cards_id', - description: '

Delete a specified source for a given customer.

.', + description: `

Delete a specified source for a given customer.

.`, inputSchema: stripe.DeleteCustomersCustomerCardsIdParamsSchema }) - async DeleteCustomersCustomerCardsId( + async deleteCustomersCustomerCardsId( params: stripe.DeleteCustomersCustomerCardsIdParams ): Promise { return this.ky - .delete(`/v1/customers/${params.customer}/cards/${params.id}`) + .delete(`/v1/customers/${params.customer}/cards/${params.id}`, {}) .json() } @@ -64050,10 +61901,10 @@ To change the default, you should update the */ @aiFunction({ name: 'get_customers_customer_cash_balance', - description: '

Retrieves a customer’s cash balance.

.', + description: `

Retrieves a customer’s cash balance.

.`, inputSchema: stripe.GetCustomersCustomerCashBalanceParamsSchema }) - async GetCustomersCustomerCashBalance( + async getCustomersCustomerCashBalance( params: stripe.GetCustomersCustomerCashBalanceParams ): Promise { return this.ky @@ -64068,10 +61919,10 @@ To change the default, you should update the */ @aiFunction({ name: 'post_customers_customer_cash_balance', - description: '

Changes the settings on a customer’s cash balance.

.', + description: `

Changes the settings on a customer’s cash balance.

.`, inputSchema: stripe.PostCustomersCustomerCashBalanceParamsSchema }) - async PostCustomersCustomerCashBalance( + async postCustomersCustomerCashBalance( params: stripe.PostCustomersCustomerCashBalanceParams ): Promise { return this.ky @@ -64084,11 +61935,10 @@ To change the default, you should update the */ @aiFunction({ name: 'get_customers_customer_cash_balance_transactions', - description: - '

Returns a list of transactions that modified the customer’s cash balance.

.', + description: `

Returns a list of transactions that modified the customer’s cash balance.

.`, inputSchema: stripe.GetCustomersCustomerCashBalanceTransactionsParamsSchema }) - async GetCustomersCustomerCashBalanceTransactions( + async getCustomersCustomerCashBalanceTransactions( params: stripe.GetCustomersCustomerCashBalanceTransactionsParams ): Promise { return this.ky @@ -64105,12 +61955,11 @@ To change the default, you should update the */ @aiFunction({ name: 'get_customers_customer_cash_balance_transactions_transaction', - description: - '

Retrieves a specific cash balance transaction, which updated the customer’s cash balance.

.', + description: `

Retrieves a specific cash balance transaction, which updated the customer’s cash balance.

.`, inputSchema: stripe.GetCustomersCustomerCashBalanceTransactionsTransactionParamsSchema }) - async GetCustomersCustomerCashBalanceTransactionsTransaction( + async getCustomersCustomerCashBalanceTransactionsTransaction( params: stripe.GetCustomersCustomerCashBalanceTransactionsTransactionParams ): Promise { return this.ky @@ -64128,7 +61977,7 @@ To change the default, you should update the inputSchema: stripe.GetCustomersCustomerDiscountParamsSchema }) - async GetCustomersCustomerDiscount( + async getCustomersCustomerDiscount( params: stripe.GetCustomersCustomerDiscountParams ): Promise { return this.ky @@ -64143,11 +61992,10 @@ To change the default, you should update the */ @aiFunction({ name: 'delete_customers_customer_discount', - description: - '

Removes the currently applied discount on a customer.

.', + description: `

Removes the currently applied discount on a customer.

.`, inputSchema: stripe.DeleteCustomersCustomerDiscountParamsSchema }) - async DeleteCustomersCustomerDiscount( + async deleteCustomersCustomerDiscount( params: stripe.DeleteCustomersCustomerDiscountParams ): Promise { return this.ky @@ -64167,7 +62015,7 @@ funding instructions will be created. If funding instructions have already been funding instructions will be retrieved. In other words, we will return the same funding instructions each time.

.`, inputSchema: stripe.PostCustomersCustomerFundingInstructionsParamsSchema }) - async PostCustomersCustomerFundingInstructions( + async postCustomersCustomerFundingInstructions( params: stripe.PostCustomersCustomerFundingInstructionsParams ): Promise { return this.ky @@ -64180,11 +62028,10 @@ funding instructions will be retrieved. In other words, we will return the same */ @aiFunction({ name: 'get_customers_customer_payment_methods', - description: - '

Returns a list of PaymentMethods for a given Customer

.', + description: `

Returns a list of PaymentMethods for a given Customer

.`, inputSchema: stripe.GetCustomersCustomerPaymentMethodsParamsSchema }) - async GetCustomersCustomerPaymentMethods( + async getCustomersCustomerPaymentMethods( params: stripe.GetCustomersCustomerPaymentMethodsParams ): Promise { return this.ky @@ -64209,12 +62056,11 @@ funding instructions will be retrieved. In other words, we will return the same */ @aiFunction({ name: 'get_customers_customer_payment_methods_payment_method', - description: - '

Retrieves a PaymentMethod object for a given Customer.

.', + description: `

Retrieves a PaymentMethod object for a given Customer.

.`, inputSchema: stripe.GetCustomersCustomerPaymentMethodsPaymentMethodParamsSchema }) - async GetCustomersCustomerPaymentMethodsPaymentMethod( + async getCustomersCustomerPaymentMethodsPaymentMethod( params: stripe.GetCustomersCustomerPaymentMethodsPaymentMethodParams ): Promise { return this.ky @@ -64232,10 +62078,10 @@ funding instructions will be retrieved. In other words, we will return the same */ @aiFunction({ name: 'get_customers_customer_sources', - description: '

List sources for a specified customer.

.', + description: `

List sources for a specified customer.

.`, inputSchema: stripe.GetCustomersCustomerSourcesParamsSchema }) - async GetCustomersCustomerSources( + async getCustomersCustomerSources( params: stripe.GetCustomersCustomerSourcesParams ): Promise { return this.ky @@ -64270,7 +62116,7 @@ However, if the owner already has a default, then it will not change. To change the default, you should update the customer to have a new default_source.

.`, inputSchema: stripe.PostCustomersCustomerSourcesParamsSchema }) - async PostCustomersCustomerSources( + async postCustomersCustomerSources( params: stripe.PostCustomersCustomerSourcesParams ): Promise { return this.ky @@ -64283,10 +62129,10 @@ To change the default, you should update the */ @aiFunction({ name: 'get_customers_customer_sources_id', - description: '

Retrieve a specified source for a given customer.

.', + description: `

Retrieve a specified source for a given customer.

.`, inputSchema: stripe.GetCustomersCustomerSourcesIdParamsSchema }) - async GetCustomersCustomerSourcesId( + async getCustomersCustomerSourcesId( params: stripe.GetCustomersCustomerSourcesIdParams ): Promise { return this.ky @@ -64301,14 +62147,14 @@ To change the default, you should update the */ @aiFunction({ name: 'post_customers_customer_sources_id', - description: '

Update a specified source for a given customer.

.', + description: `

Update a specified source for a given customer.

.`, inputSchema: stripe.PostCustomersCustomerSourcesIdParamsSchema }) - async PostCustomersCustomerSourcesId( + async postCustomersCustomerSourcesId( params: stripe.PostCustomersCustomerSourcesIdParams ): Promise { return this.ky - .post(`/v1/customers/${params.customer}/sources/${params.id}`) + .post(`/v1/customers/${params.customer}/sources/${params.id}`, {}) .json() } @@ -64317,14 +62163,14 @@ To change the default, you should update the */ @aiFunction({ name: 'delete_customers_customer_sources_id', - description: '

Delete a specified source for a given customer.

.', + description: `

Delete a specified source for a given customer.

.`, inputSchema: stripe.DeleteCustomersCustomerSourcesIdParamsSchema }) - async DeleteCustomersCustomerSourcesId( + async deleteCustomersCustomerSourcesId( params: stripe.DeleteCustomersCustomerSourcesIdParams ): Promise { return this.ky - .delete(`/v1/customers/${params.customer}/sources/${params.id}`) + .delete(`/v1/customers/${params.customer}/sources/${params.id}`, {}) .json() } @@ -64333,16 +62179,16 @@ To change the default, you should update the */ @aiFunction({ name: 'post_customers_customer_sources_id_verify', - description: - '

Verify a specified bank account for a given customer.

.', + description: `

Verify a specified bank account for a given customer.

.`, inputSchema: stripe.PostCustomersCustomerSourcesIdVerifyParamsSchema }) - async PostCustomersCustomerSourcesIdVerify( + async postCustomersCustomerSourcesIdVerify( params: stripe.PostCustomersCustomerSourcesIdVerifyParams ): Promise { return this.ky .post( - `/v1/customers/${params.customer}/sources/${params.id}/verify` + `/v1/customers/${params.customer}/sources/${params.id}/verify`, + {} ) .json() } @@ -64352,11 +62198,10 @@ To change the default, you should update the */ @aiFunction({ name: 'get_customers_customer_subscriptions', - description: - '

You can see a list of the customer’s active subscriptions. Note that the 10 most recent active subscriptions are always available by default on the customer object. If you need more than those 10, you can use the limit and starting_after parameters to page through additional subscriptions.

.', + description: `

You can see a list of the customer’s active subscriptions. Note that the 10 most recent active subscriptions are always available by default on the customer object. If you need more than those 10, you can use the limit and starting_after parameters to page through additional subscriptions.

.`, inputSchema: stripe.GetCustomersCustomerSubscriptionsParamsSchema }) - async GetCustomersCustomerSubscriptions( + async getCustomersCustomerSubscriptions( params: stripe.GetCustomersCustomerSubscriptionsParams ): Promise { return this.ky @@ -64373,10 +62218,10 @@ To change the default, you should update the */ @aiFunction({ name: 'post_customers_customer_subscriptions', - description: '

Creates a new subscription on an existing customer.

.', + description: `

Creates a new subscription on an existing customer.

.`, inputSchema: stripe.PostCustomersCustomerSubscriptionsParamsSchema }) - async PostCustomersCustomerSubscriptions( + async postCustomersCustomerSubscriptions( params: stripe.PostCustomersCustomerSubscriptionsParams ): Promise { return this.ky @@ -64389,11 +62234,11 @@ To change the default, you should update the */ @aiFunction({ name: 'get_customers_customer_subscriptions_subscription_exposed_id', - description: '

Retrieves the subscription with the given ID.

.', + description: `

Retrieves the subscription with the given ID.

.`, inputSchema: stripe.GetCustomersCustomerSubscriptionsSubscriptionExposedIdParamsSchema }) - async GetCustomersCustomerSubscriptionsSubscriptionExposedId( + async getCustomersCustomerSubscriptionsSubscriptionExposedId( params: stripe.GetCustomersCustomerSubscriptionsSubscriptionExposedIdParams ): Promise { return this.ky @@ -64411,17 +62256,17 @@ To change the default, you should update the */ @aiFunction({ name: 'post_customers_customer_subscriptions_subscription_exposed_id', - description: - '

Updates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, we will optionally prorate the price we charge next month to make up for any price changes. To preview how the proration will be calculated, use the upcoming invoice endpoint.

.', + description: `

Updates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, we will optionally prorate the price we charge next month to make up for any price changes. To preview how the proration will be calculated, use the upcoming invoice endpoint.

.`, inputSchema: stripe.PostCustomersCustomerSubscriptionsSubscriptionExposedIdParamsSchema }) - async PostCustomersCustomerSubscriptionsSubscriptionExposedId( + async postCustomersCustomerSubscriptionsSubscriptionExposedId( params: stripe.PostCustomersCustomerSubscriptionsSubscriptionExposedIdParams ): Promise { return this.ky .post( - `/v1/customers/${params.customer}/subscriptions/${params.subscription_exposed_id}` + `/v1/customers/${params.customer}/subscriptions/${params.subscription_exposed_id}`, + {} ) .json() } @@ -64443,12 +62288,13 @@ To change the default, you should update the inputSchema: stripe.DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdParamsSchema }) - async DeleteCustomersCustomerSubscriptionsSubscriptionExposedId( + async deleteCustomersCustomerSubscriptionsSubscriptionExposedId( params: stripe.DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdParams ): Promise { return this.ky .delete( - `/v1/customers/${params.customer}/subscriptions/${params.subscription_exposed_id}` + `/v1/customers/${params.customer}/subscriptions/${params.subscription_exposed_id}`, + {} ) .json() } @@ -64459,7 +62305,7 @@ To change the default, you should update the inputSchema: stripe.GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscountParamsSchema }) - async GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount( + async getCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount( params: stripe.GetCustomersCustomerSubscriptionsSubscriptionExposedIdDiscountParams ): Promise { return this.ky @@ -64477,17 +62323,17 @@ To change the default, you should update the */ @aiFunction({ name: 'delete_customers_customer_subscriptions_subscription_exposed_id_discount', - description: - '

Removes the currently applied discount on a customer.

.', + description: `

Removes the currently applied discount on a customer.

.`, inputSchema: stripe.DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscountParamsSchema }) - async DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount( + async deleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscount( params: stripe.DeleteCustomersCustomerSubscriptionsSubscriptionExposedIdDiscountParams ): Promise { return this.ky .delete( - `/v1/customers/${params.customer}/subscriptions/${params.subscription_exposed_id}/discount` + `/v1/customers/${params.customer}/subscriptions/${params.subscription_exposed_id}/discount`, + {} ) .json() } @@ -64497,10 +62343,10 @@ To change the default, you should update the */ @aiFunction({ name: 'get_customers_customer_tax_ids', - description: '

Returns a list of tax IDs for a customer.

.', + description: `

Returns a list of tax IDs for a customer.

.`, inputSchema: stripe.GetCustomersCustomerTaxIdsParamsSchema }) - async GetCustomersCustomerTaxIds( + async getCustomersCustomerTaxIds( params: stripe.GetCustomersCustomerTaxIdsParams ): Promise { return this.ky @@ -64517,11 +62363,10 @@ To change the default, you should update the */ @aiFunction({ name: 'post_customers_customer_tax_ids', - description: - '

Creates a new tax_id object for a customer.

.', + description: `

Creates a new tax_id object for a customer.

.`, inputSchema: stripe.PostCustomersCustomerTaxIdsParamsSchema }) - async PostCustomersCustomerTaxIds( + async postCustomersCustomerTaxIds( params: stripe.PostCustomersCustomerTaxIdsParams ): Promise { return this.ky @@ -64534,11 +62379,10 @@ To change the default, you should update the */ @aiFunction({ name: 'get_customers_customer_tax_ids_id', - description: - '

Retrieves the tax_id object with the given identifier.

.', + description: `

Retrieves the tax_id object with the given identifier.

.`, inputSchema: stripe.GetCustomersCustomerTaxIdsIdParamsSchema }) - async GetCustomersCustomerTaxIdsId( + async getCustomersCustomerTaxIdsId( params: stripe.GetCustomersCustomerTaxIdsIdParams ): Promise { return this.ky @@ -64553,14 +62397,14 @@ To change the default, you should update the */ @aiFunction({ name: 'delete_customers_customer_tax_ids_id', - description: '

Deletes an existing tax_id object.

.', + description: `

Deletes an existing tax_id object.

.`, inputSchema: stripe.DeleteCustomersCustomerTaxIdsIdParamsSchema }) - async DeleteCustomersCustomerTaxIdsId( + async deleteCustomersCustomerTaxIdsId( params: stripe.DeleteCustomersCustomerTaxIdsIdParams ): Promise { return this.ky - .delete(`/v1/customers/${params.customer}/tax_ids/${params.id}`) + .delete(`/v1/customers/${params.customer}/tax_ids/${params.id}`, {}) .json() } @@ -64569,15 +62413,26 @@ To change the default, you should update the */ @aiFunction({ name: 'get_disputes', - description: '

Returns a list of your disputes.

.', + description: `

Returns a list of your disputes.

.`, inputSchema: stripe.GetDisputesParamsSchema }) - async GetDisputes( + async getDisputes( params: stripe.GetDisputesParams ): Promise { return this.ky .get('/v1/disputes', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'charge', + 'created', + 'ending_before', + 'expand', + 'limit', + 'payment_intent', + 'starting_after' + ) + ) }) .json() } @@ -64587,10 +62442,10 @@ To change the default, you should update the */ @aiFunction({ name: 'get_disputes_dispute', - description: '

Retrieves the dispute with the given ID.

.', + description: `

Retrieves the dispute with the given ID.

.`, inputSchema: stripe.GetDisputesDisputeParamsSchema }) - async GetDisputesDispute( + async getDisputesDispute( params: stripe.GetDisputesDisputeParams ): Promise { return this.ky @@ -64612,7 +62467,7 @@ To change the default, you should update the

Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our guide to dispute types.

.`, inputSchema: stripe.PostDisputesDisputeParamsSchema }) - async PostDisputesDispute( + async postDisputesDispute( params: stripe.PostDisputesDisputeParams ): Promise { return this.ky @@ -64632,7 +62487,7 @@ To change the default, you should update the

The status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.

.`, inputSchema: stripe.PostDisputesDisputeCloseParamsSchema }) - async PostDisputesDisputeClose( + async postDisputesDisputeClose( params: stripe.PostDisputesDisputeCloseParams ): Promise { return this.ky @@ -64645,16 +62500,24 @@ To change the default, you should update the */ @aiFunction({ name: 'get_entitlements_active_entitlements', - description: - '

Retrieve a list of active entitlements for a customer

.', + description: `

Retrieve a list of active entitlements for a customer

.`, inputSchema: stripe.GetEntitlementsActiveEntitlementsParamsSchema }) - async GetEntitlementsActiveEntitlements( + async getEntitlementsActiveEntitlements( params: stripe.GetEntitlementsActiveEntitlementsParams ): Promise { return this.ky .get('/v1/entitlements/active_entitlements', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'customer', + 'ending_before', + 'expand', + 'limit', + 'starting_after' + ) + ) }) .json() } @@ -64664,10 +62527,10 @@ To change the default, you should update the */ @aiFunction({ name: 'get_entitlements_active_entitlements_id', - description: '

Retrieve an active entitlement

.', + description: `

Retrieve an active entitlement

.`, inputSchema: stripe.GetEntitlementsActiveEntitlementsIdParamsSchema }) - async GetEntitlementsActiveEntitlementsId( + async getEntitlementsActiveEntitlementsId( params: stripe.GetEntitlementsActiveEntitlementsIdParams ): Promise { return this.ky @@ -64682,15 +62545,25 @@ To change the default, you should update the */ @aiFunction({ name: 'get_entitlements_features', - description: '

Retrieve a list of features

.', + description: `

Retrieve a list of features

.`, inputSchema: stripe.GetEntitlementsFeaturesParamsSchema }) - async GetEntitlementsFeatures( + async getEntitlementsFeatures( params: stripe.GetEntitlementsFeaturesParams ): Promise { return this.ky .get('/v1/entitlements/features', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'archived', + 'ending_before', + 'expand', + 'limit', + 'lookup_key', + 'starting_after' + ) + ) }) .json() } @@ -64700,10 +62573,10 @@ To change the default, you should update the */ @aiFunction({ name: 'post_entitlements_features', - description: '

Creates a feature

.', + description: `

Creates a feature

.`, inputSchema: stripe.PostEntitlementsFeaturesParamsSchema }) - async PostEntitlementsFeatures( + async postEntitlementsFeatures( _params: stripe.PostEntitlementsFeaturesParams ): Promise { return this.ky @@ -64716,10 +62589,10 @@ To change the default, you should update the */ @aiFunction({ name: 'get_entitlements_features_id', - description: '

Retrieves a feature

.', + description: `

Retrieves a feature

.`, inputSchema: stripe.GetEntitlementsFeaturesIdParamsSchema }) - async GetEntitlementsFeaturesId( + async getEntitlementsFeaturesId( params: stripe.GetEntitlementsFeaturesIdParams ): Promise { return this.ky @@ -64734,11 +62607,10 @@ To change the default, you should update the */ @aiFunction({ name: 'post_entitlements_features_id', - description: - '

Update a feature’s metadata or permanently deactivate it.

.', + description: `

Update a feature’s metadata or permanently deactivate it.

.`, inputSchema: stripe.PostEntitlementsFeaturesIdParamsSchema }) - async PostEntitlementsFeaturesId( + async postEntitlementsFeaturesId( params: stripe.PostEntitlementsFeaturesIdParams ): Promise { return this.ky @@ -64751,10 +62623,10 @@ To change the default, you should update the */ @aiFunction({ name: 'post_ephemeral_keys', - description: '

Creates a short-lived API key for a given resource.

.', + description: `

Creates a short-lived API key for a given resource.

.`, inputSchema: stripe.PostEphemeralKeysParamsSchema }) - async PostEphemeralKeys( + async postEphemeralKeys( _params: stripe.PostEphemeralKeysParams ): Promise { return this.ky @@ -64767,11 +62639,10 @@ To change the default, you should update the */ @aiFunction({ name: 'delete_ephemeral_keys_key', - description: - '

Invalidates a short-lived API key for a given resource.

.', + description: `

Invalidates a short-lived API key for a given resource.

.`, inputSchema: stripe.DeleteEphemeralKeysKeyParamsSchema }) - async DeleteEphemeralKeysKey( + async deleteEphemeralKeysKey( params: stripe.DeleteEphemeralKeysKeyParams ): Promise { return this.ky @@ -64784,16 +62655,27 @@ To change the default, you should update the */ @aiFunction({ name: 'get_events', - description: - '

List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in event object api_version attribute (not according to your current Stripe API version or Stripe-Version header).

.', + description: `

List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in event object api_version attribute (not according to your current Stripe API version or Stripe-Version header).

.`, inputSchema: stripe.GetEventsParamsSchema }) - async GetEvents( + async getEvents( params: stripe.GetEventsParams ): Promise { return this.ky .get('/v1/events', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'created', + 'delivery_success', + 'ending_before', + 'expand', + 'limit', + 'starting_after', + 'type', + 'types' + ) + ) }) .json() } @@ -64803,11 +62685,10 @@ To change the default, you should update the */ @aiFunction({ name: 'get_events_id', - description: - '

Retrieves the details of an event if it was created in the last 30 days. Supply the unique identifier of the event, which you might have received in a webhook.

.', + description: `

Retrieves the details of an event if it was created in the last 30 days. Supply the unique identifier of the event, which you might have received in a webhook.

.`, inputSchema: stripe.GetEventsIdParamsSchema }) - async GetEventsId( + async getEventsId( params: stripe.GetEventsIdParams ): Promise { return this.ky @@ -64822,16 +62703,17 @@ To change the default, you should update the */ @aiFunction({ name: 'get_exchange_rates', - description: - '

Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.

.', + description: `

Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.

.`, inputSchema: stripe.GetExchangeRatesParamsSchema }) - async GetExchangeRates( + async getExchangeRates( params: stripe.GetExchangeRatesParams ): Promise { return this.ky .get('/v1/exchange_rates', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick(params, 'ending_before', 'expand', 'limit', 'starting_after') + ) }) .json() } @@ -64841,11 +62723,10 @@ To change the default, you should update the */ @aiFunction({ name: 'get_exchange_rates_rate_id', - description: - '

Retrieves the exchange rates from the given currency to every supported currency.

.', + description: `

Retrieves the exchange rates from the given currency to every supported currency.

.`, inputSchema: stripe.GetExchangeRatesRateIdParamsSchema }) - async GetExchangeRatesRateId( + async getExchangeRatesRateId( params: stripe.GetExchangeRatesRateIdParams ): Promise { return this.ky @@ -64860,15 +62741,26 @@ To change the default, you should update the */ @aiFunction({ name: 'get_file_links', - description: '

Returns a list of file links.

.', + description: `

Returns a list of file links.

.`, inputSchema: stripe.GetFileLinksParamsSchema }) - async GetFileLinks( + async getFileLinks( params: stripe.GetFileLinksParams ): Promise { return this.ky .get('/v1/file_links', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'created', + 'ending_before', + 'expand', + 'expired', + 'file', + 'limit', + 'starting_after' + ) + ) }) .json() } @@ -64878,10 +62770,10 @@ To change the default, you should update the */ @aiFunction({ name: 'post_file_links', - description: '

Creates a new file link object.

.', + description: `

Creates a new file link object.

.`, inputSchema: stripe.PostFileLinksParamsSchema }) - async PostFileLinks( + async postFileLinks( _params: stripe.PostFileLinksParams ): Promise { return this.ky.post('/v1/file_links').json() @@ -64892,10 +62784,10 @@ To change the default, you should update the */ @aiFunction({ name: 'get_file_links_link', - description: '

Retrieves the file link with the given ID.

.', + description: `

Retrieves the file link with the given ID.

.`, inputSchema: stripe.GetFileLinksLinkParamsSchema }) - async GetFileLinksLink( + async getFileLinksLink( params: stripe.GetFileLinksLinkParams ): Promise { return this.ky @@ -64910,11 +62802,10 @@ To change the default, you should update the */ @aiFunction({ name: 'post_file_links_link', - description: - '

Updates an existing file link object. Expired links can no longer be updated.

.', + description: `

Updates an existing file link object. Expired links can no longer be updated.

.`, inputSchema: stripe.PostFileLinksLinkParamsSchema }) - async PostFileLinksLink( + async postFileLinksLink( params: stripe.PostFileLinksLinkParams ): Promise { return this.ky @@ -64927,16 +62818,25 @@ To change the default, you should update the */ @aiFunction({ name: 'get_files', - description: - '

Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.

.', + description: `

Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.

.`, inputSchema: stripe.GetFilesParamsSchema }) - async GetFiles( + async getFiles( params: stripe.GetFilesParams ): Promise { return this.ky .get('/v1/files', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'created', + 'ending_before', + 'expand', + 'limit', + 'purpose', + 'starting_after' + ) + ) }) .json() } @@ -64953,12 +62853,12 @@ To change the default, you should update the

All of Stripe’s officially supported Client libraries support sending multipart/form-data.

.`, inputSchema: stripe.PostFilesParamsSchema }) - async PostFiles( + async postFiles( params: stripe.PostFilesParams ): Promise { return this.ky .post('/v1/files', { - form: params + form: pick(params, 'expand', 'file', 'file_link_data', 'purpose') }) .json() } @@ -64968,11 +62868,10 @@ To change the default, you should update the */ @aiFunction({ name: 'get_files_file', - description: - '

Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to access file contents.

.', + description: `

Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to access file contents.

.`, inputSchema: stripe.GetFilesFileParamsSchema }) - async GetFilesFile( + async getFilesFile( params: stripe.GetFilesFileParams ): Promise { return this.ky @@ -64987,16 +62886,25 @@ To change the default, you should update the */ @aiFunction({ name: 'get_financial_connections_accounts', - description: - '

Returns a list of Financial Connections Account objects.

.', + description: `

Returns a list of Financial Connections Account objects.

.`, inputSchema: stripe.GetFinancialConnectionsAccountsParamsSchema }) - async GetFinancialConnectionsAccounts( + async getFinancialConnectionsAccounts( params: stripe.GetFinancialConnectionsAccountsParams ): Promise { return this.ky .get('/v1/financial_connections/accounts', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'account_holder', + 'ending_before', + 'expand', + 'limit', + 'session', + 'starting_after' + ) + ) }) .json() } @@ -65006,11 +62914,10 @@ To change the default, you should update the */ @aiFunction({ name: 'get_financial_connections_accounts_account', - description: - '

Retrieves the details of an Financial Connections Account.

.', + description: `

Retrieves the details of an Financial Connections Account.

.`, inputSchema: stripe.GetFinancialConnectionsAccountsAccountParamsSchema }) - async GetFinancialConnectionsAccountsAccount( + async getFinancialConnectionsAccountsAccount( params: stripe.GetFinancialConnectionsAccountsAccountParams ): Promise { return this.ky @@ -65025,12 +62932,11 @@ To change the default, you should update the */ @aiFunction({ name: 'post_financial_connections_accounts_account_disconnect', - description: - '

Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).

.', + description: `

Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).

.`, inputSchema: stripe.PostFinancialConnectionsAccountsAccountDisconnectParamsSchema }) - async PostFinancialConnectionsAccountsAccountDisconnect( + async postFinancialConnectionsAccountsAccountDisconnect( params: stripe.PostFinancialConnectionsAccountsAccountDisconnectParams ): Promise { return this.ky @@ -65045,10 +62951,10 @@ To change the default, you should update the */ @aiFunction({ name: 'get_financial_connections_accounts_account_owners', - description: '

Lists all owners for a given Account

.', + description: `

Lists all owners for a given Account

.`, inputSchema: stripe.GetFinancialConnectionsAccountsAccountOwnersParamsSchema }) - async GetFinancialConnectionsAccountsAccountOwners( + async getFinancialConnectionsAccountsAccountOwners( params: stripe.GetFinancialConnectionsAccountsAccountOwnersParams ): Promise { return this.ky @@ -65072,12 +62978,11 @@ To change the default, you should update the */ @aiFunction({ name: 'post_financial_connections_accounts_account_refresh', - description: - '

Refreshes the data associated with a Financial Connections Account.

.', + description: `

Refreshes the data associated with a Financial Connections Account.

.`, inputSchema: stripe.PostFinancialConnectionsAccountsAccountRefreshParamsSchema }) - async PostFinancialConnectionsAccountsAccountRefresh( + async postFinancialConnectionsAccountsAccountRefresh( params: stripe.PostFinancialConnectionsAccountsAccountRefreshParams ): Promise { return this.ky @@ -65090,12 +62995,11 @@ To change the default, you should update the */ @aiFunction({ name: 'post_financial_connections_accounts_account_subscribe', - description: - '

Subscribes to periodic refreshes of data associated with a Financial Connections Account.

.', + description: `

Subscribes to periodic refreshes of data associated with a Financial Connections Account.

.`, inputSchema: stripe.PostFinancialConnectionsAccountsAccountSubscribeParamsSchema }) - async PostFinancialConnectionsAccountsAccountSubscribe( + async postFinancialConnectionsAccountsAccountSubscribe( params: stripe.PostFinancialConnectionsAccountsAccountSubscribeParams ): Promise { return this.ky @@ -65108,12 +63012,11 @@ To change the default, you should update the */ @aiFunction({ name: 'post_financial_connections_accounts_account_unsubscribe', - description: - '

Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.

.', + description: `

Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.

.`, inputSchema: stripe.PostFinancialConnectionsAccountsAccountUnsubscribeParamsSchema }) - async PostFinancialConnectionsAccountsAccountUnsubscribe( + async postFinancialConnectionsAccountsAccountUnsubscribe( params: stripe.PostFinancialConnectionsAccountsAccountUnsubscribeParams ): Promise { return this.ky @@ -65128,11 +63031,10 @@ To change the default, you should update the */ @aiFunction({ name: 'post_financial_connections_sessions', - description: - '

To launch the Financial Connections authorization flow, create a Session. The session’s client_secret can be used to launch the flow using Stripe.js.

.', + description: `

To launch the Financial Connections authorization flow, create a Session. The session’s client_secret can be used to launch the flow using Stripe.js.

.`, inputSchema: stripe.PostFinancialConnectionsSessionsParamsSchema }) - async PostFinancialConnectionsSessions( + async postFinancialConnectionsSessions( _params: stripe.PostFinancialConnectionsSessionsParams ): Promise { return this.ky @@ -65145,11 +63047,10 @@ To change the default, you should update the */ @aiFunction({ name: 'get_financial_connections_sessions_session', - description: - '

Retrieves the details of a Financial Connections Session

.', + description: `

Retrieves the details of a Financial Connections Session

.`, inputSchema: stripe.GetFinancialConnectionsSessionsSessionParamsSchema }) - async GetFinancialConnectionsSessionsSession( + async getFinancialConnectionsSessionsSession( params: stripe.GetFinancialConnectionsSessionsSessionParams ): Promise { return this.ky @@ -65164,16 +63065,26 @@ To change the default, you should update the */ @aiFunction({ name: 'get_financial_connections_transactions', - description: - '

Returns a list of Financial Connections Transaction objects.

.', + description: `

Returns a list of Financial Connections Transaction objects.

.`, inputSchema: stripe.GetFinancialConnectionsTransactionsParamsSchema }) - async GetFinancialConnectionsTransactions( + async getFinancialConnectionsTransactions( params: stripe.GetFinancialConnectionsTransactionsParams ): Promise { return this.ky .get('/v1/financial_connections/transactions', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'account', + 'ending_before', + 'expand', + 'limit', + 'starting_after', + 'transacted_at', + 'transaction_refresh' + ) + ) }) .json() } @@ -65183,12 +63094,11 @@ To change the default, you should update the */ @aiFunction({ name: 'get_financial_connections_transactions_transaction', - description: - '

Retrieves the details of a Financial Connections Transaction

.', + description: `

Retrieves the details of a Financial Connections Transaction

.`, inputSchema: stripe.GetFinancialConnectionsTransactionsTransactionParamsSchema }) - async GetFinancialConnectionsTransactionsTransaction( + async getFinancialConnectionsTransactionsTransaction( params: stripe.GetFinancialConnectionsTransactionsTransactionParams ): Promise { return this.ky @@ -65203,15 +63113,24 @@ To change the default, you should update the */ @aiFunction({ name: 'get_forwarding_requests', - description: '

Lists all ForwardingRequest objects.

.', + description: `

Lists all ForwardingRequest objects.

.`, inputSchema: stripe.GetForwardingRequestsParamsSchema }) - async GetForwardingRequests( + async getForwardingRequests( params: stripe.GetForwardingRequestsParams ): Promise { return this.ky .get('/v1/forwarding/requests', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'created', + 'ending_before', + 'expand', + 'limit', + 'starting_after' + ) + ) }) .json() } @@ -65221,10 +63140,10 @@ To change the default, you should update the */ @aiFunction({ name: 'post_forwarding_requests', - description: '

Creates a ForwardingRequest object.

.', + description: `

Creates a ForwardingRequest object.

.`, inputSchema: stripe.PostForwardingRequestsParamsSchema }) - async PostForwardingRequests( + async postForwardingRequests( _params: stripe.PostForwardingRequestsParams ): Promise { return this.ky @@ -65237,10 +63156,10 @@ To change the default, you should update the */ @aiFunction({ name: 'get_forwarding_requests_id', - description: '

Retrieves a ForwardingRequest object.

.', + description: `

Retrieves a ForwardingRequest object.

.`, inputSchema: stripe.GetForwardingRequestsIdParamsSchema }) - async GetForwardingRequestsId( + async getForwardingRequestsId( params: stripe.GetForwardingRequestsIdParams ): Promise { return this.ky @@ -65255,15 +63174,27 @@ To change the default, you should update the */ @aiFunction({ name: 'get_identity_verification_reports', - description: '

List all verification reports.

.', + description: `

List all verification reports.

.`, inputSchema: stripe.GetIdentityVerificationReportsParamsSchema }) - async GetIdentityVerificationReports( + async getIdentityVerificationReports( params: stripe.GetIdentityVerificationReportsParams ): Promise { return this.ky .get('/v1/identity/verification_reports', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'client_reference_id', + 'created', + 'ending_before', + 'expand', + 'limit', + 'starting_after', + 'type', + 'verification_session' + ) + ) }) .json() } @@ -65273,10 +63204,10 @@ To change the default, you should update the */ @aiFunction({ name: 'get_identity_verification_reports_report', - description: '

Retrieves an existing VerificationReport

.', + description: `

Retrieves an existing VerificationReport

.`, inputSchema: stripe.GetIdentityVerificationReportsReportParamsSchema }) - async GetIdentityVerificationReportsReport( + async getIdentityVerificationReportsReport( params: stripe.GetIdentityVerificationReportsReportParams ): Promise { return this.ky @@ -65291,15 +63222,27 @@ To change the default, you should update the */ @aiFunction({ name: 'get_identity_verification_sessions', - description: '

Returns a list of VerificationSessions

.', + description: `

Returns a list of VerificationSessions

.`, inputSchema: stripe.GetIdentityVerificationSessionsParamsSchema }) - async GetIdentityVerificationSessions( + async getIdentityVerificationSessions( params: stripe.GetIdentityVerificationSessionsParams ): Promise { return this.ky .get('/v1/identity/verification_sessions', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'client_reference_id', + 'created', + 'ending_before', + 'expand', + 'limit', + 'related_customer', + 'starting_after', + 'status' + ) + ) }) .json() } @@ -65324,7 +63267,7 @@ To change the default, you should update the

Related guide: Verify your users’ identity documents

.`, inputSchema: stripe.PostIdentityVerificationSessionsParamsSchema }) - async PostIdentityVerificationSessions( + async postIdentityVerificationSessions( _params: stripe.PostIdentityVerificationSessionsParams ): Promise { return this.ky @@ -65346,7 +63289,7 @@ To change the default, you should update the client_secret or url to allow re-submission.

.`, inputSchema: stripe.GetIdentityVerificationSessionsSessionParamsSchema }) - async GetIdentityVerificationSessionsSession( + async getIdentityVerificationSessionsSession( params: stripe.GetIdentityVerificationSessionsSessionParams ): Promise { return this.ky @@ -65370,7 +63313,7 @@ verification check and options.

. verification check and options.

.`, inputSchema: stripe.PostIdentityVerificationSessionsSessionParamsSchema }) - async PostIdentityVerificationSessionsSession( + async postIdentityVerificationSessionsSession( params: stripe.PostIdentityVerificationSessionsSessionParams ): Promise { return this.ky @@ -65391,7 +63334,7 @@ verification check and options.

.`, inputSchema: stripe.PostIdentityVerificationSessionsSessionCancelParamsSchema }) - async PostIdentityVerificationSessionsSessionCancel( + async postIdentityVerificationSessionsSessionCancel( params: stripe.PostIdentityVerificationSessionsSessionCancelParams ): Promise { return this.ky @@ -65444,7 +63387,7 @@ used for any purpose.

inputSchema: stripe.PostIdentityVerificationSessionsSessionRedactParamsSchema }) - async PostIdentityVerificationSessionsSessionRedact( + async postIdentityVerificationSessionsSessionRedact( params: stripe.PostIdentityVerificationSessionsSessionRedactParams ): Promise { return this.ky @@ -65457,16 +63400,24 @@ used for any purpose.

*/ @aiFunction({ name: 'get_invoice_rendering_templates', - description: - '

List all templates, ordered by creation date, with the most recently created template appearing first.

.', + description: `

List all templates, ordered by creation date, with the most recently created template appearing first.

.`, inputSchema: stripe.GetInvoiceRenderingTemplatesParamsSchema }) - async GetInvoiceRenderingTemplates( + async getInvoiceRenderingTemplates( params: stripe.GetInvoiceRenderingTemplatesParams ): Promise { return this.ky .get('/v1/invoice_rendering_templates', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'ending_before', + 'expand', + 'limit', + 'starting_after', + 'status' + ) + ) }) .json() } @@ -65476,11 +63427,10 @@ used for any purpose.

*/ @aiFunction({ name: 'get_invoice_rendering_templates_template', - description: - '

Retrieves an invoice rendering template with the given ID. It by default returns the latest version of the template. Optionally, specify a version to see previous versions.

.', + description: `

Retrieves an invoice rendering template with the given ID. It by default returns the latest version of the template. Optionally, specify a version to see previous versions.

.`, inputSchema: stripe.GetInvoiceRenderingTemplatesTemplateParamsSchema }) - async GetInvoiceRenderingTemplatesTemplate( + async getInvoiceRenderingTemplatesTemplate( params: stripe.GetInvoiceRenderingTemplatesTemplateParams ): Promise { return this.ky @@ -65495,11 +63445,10 @@ used for any purpose.

*/ @aiFunction({ name: 'post_invoice_rendering_templates_template_archive', - description: - '

Updates the status of an invoice rendering template to ‘archived’ so no new Stripe objects (customers, invoices, etc.) can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it.

.', + description: `

Updates the status of an invoice rendering template to ‘archived’ so no new Stripe objects (customers, invoices, etc.) can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it.

.`, inputSchema: stripe.PostInvoiceRenderingTemplatesTemplateArchiveParamsSchema }) - async PostInvoiceRenderingTemplatesTemplateArchive( + async postInvoiceRenderingTemplatesTemplateArchive( params: stripe.PostInvoiceRenderingTemplatesTemplateArchiveParams ): Promise { return this.ky @@ -65512,12 +63461,11 @@ used for any purpose.

*/ @aiFunction({ name: 'post_invoice_rendering_templates_template_unarchive', - description: - '

Unarchive an invoice rendering template so it can be used on new Stripe objects again.

.', + description: `

Unarchive an invoice rendering template so it can be used on new Stripe objects again.

.`, inputSchema: stripe.PostInvoiceRenderingTemplatesTemplateUnarchiveParamsSchema }) - async PostInvoiceRenderingTemplatesTemplateUnarchive( + async postInvoiceRenderingTemplatesTemplateUnarchive( params: stripe.PostInvoiceRenderingTemplatesTemplateUnarchiveParams ): Promise { return this.ky @@ -65530,16 +63478,27 @@ used for any purpose.

*/ @aiFunction({ name: 'get_invoiceitems', - description: - '

Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.

.', + description: `

Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.

.`, inputSchema: stripe.GetInvoiceitemsParamsSchema }) - async GetInvoiceitems( + async getInvoiceitems( params: stripe.GetInvoiceitemsParams ): Promise { return this.ky .get('/v1/invoiceitems', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'created', + 'customer', + 'ending_before', + 'expand', + 'invoice', + 'limit', + 'pending', + 'starting_after' + ) + ) }) .json() } @@ -65549,11 +63508,10 @@ used for any purpose.

*/ @aiFunction({ name: 'post_invoiceitems', - description: - '

Creates an item to be added to a draft invoice (up to 250 items per invoice). If no invoice is specified, the item will be on the next invoice created for the customer specified.

.', + description: `

Creates an item to be added to a draft invoice (up to 250 items per invoice). If no invoice is specified, the item will be on the next invoice created for the customer specified.

.`, inputSchema: stripe.PostInvoiceitemsParamsSchema }) - async PostInvoiceitems( + async postInvoiceitems( _params: stripe.PostInvoiceitemsParams ): Promise { return this.ky @@ -65566,10 +63524,10 @@ used for any purpose.

*/ @aiFunction({ name: 'get_invoiceitems_invoiceitem', - description: '

Retrieves the invoice item with the given ID.

.', + description: `

Retrieves the invoice item with the given ID.

.`, inputSchema: stripe.GetInvoiceitemsInvoiceitemParamsSchema }) - async GetInvoiceitemsInvoiceitem( + async getInvoiceitemsInvoiceitem( params: stripe.GetInvoiceitemsInvoiceitemParams ): Promise { return this.ky @@ -65584,11 +63542,10 @@ used for any purpose.

*/ @aiFunction({ name: 'post_invoiceitems_invoiceitem', - description: - '

Updates the amount or description of an invoice item on an upcoming invoice. Updating an invoice item is only possible before the invoice it’s attached to is closed.

.', + description: `

Updates the amount or description of an invoice item on an upcoming invoice. Updating an invoice item is only possible before the invoice it’s attached to is closed.

.`, inputSchema: stripe.PostInvoiceitemsInvoiceitemParamsSchema }) - async PostInvoiceitemsInvoiceitem( + async postInvoiceitemsInvoiceitem( params: stripe.PostInvoiceitemsInvoiceitemParams ): Promise { return this.ky @@ -65601,11 +63558,10 @@ used for any purpose.

*/ @aiFunction({ name: 'delete_invoiceitems_invoiceitem', - description: - '

Deletes an invoice item, removing it from an invoice. Deleting invoice items is only possible when they’re not attached to invoices, or if it’s attached to a draft invoice.

.', + description: `

Deletes an invoice item, removing it from an invoice. Deleting invoice items is only possible when they’re not attached to invoices, or if it’s attached to a draft invoice.

.`, inputSchema: stripe.DeleteInvoiceitemsInvoiceitemParamsSchema }) - async DeleteInvoiceitemsInvoiceitem( + async deleteInvoiceitemsInvoiceitem( params: stripe.DeleteInvoiceitemsInvoiceitemParams ): Promise { return this.ky @@ -65618,16 +63574,29 @@ used for any purpose.

*/ @aiFunction({ name: 'get_invoices', - description: - '

You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.

.', + description: `

You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.

.`, inputSchema: stripe.GetInvoicesParamsSchema }) - async GetInvoices( + async getInvoices( params: stripe.GetInvoicesParams ): Promise { return this.ky .get('/v1/invoices', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'collection_method', + 'created', + 'customer', + 'due_date', + 'ending_before', + 'expand', + 'limit', + 'starting_after', + 'status', + 'subscription' + ) + ) }) .json() } @@ -65637,11 +63606,10 @@ used for any purpose.

*/ @aiFunction({ name: 'post_invoices', - description: - '

This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you finalize the invoice, which allows you to pay or send the invoice to your customers.

.', + description: `

This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you finalize the invoice, which allows you to pay or send the invoice to your customers.

.`, inputSchema: stripe.PostInvoicesParamsSchema }) - async PostInvoices( + async postInvoices( _params: stripe.PostInvoicesParams ): Promise { return this.ky.post('/v1/invoices').json() @@ -65667,7 +63635,7 @@ used for any purpose.

Note: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. Learn more

.`, inputSchema: stripe.PostInvoicesCreatePreviewParamsSchema }) - async PostInvoicesCreatePreview( + async postInvoicesCreatePreview( _params: stripe.PostInvoicesCreatePreviewParams ): Promise { return this.ky @@ -65689,12 +63657,14 @@ conditions, data is searchable in less than a minute. Occasionally, propagation to an hour behind during outages. Search functionality is not available to merchants in India.

.`, inputSchema: stripe.GetInvoicesSearchParamsSchema }) - async GetInvoicesSearch( + async getInvoicesSearch( params: stripe.GetInvoicesSearchParams ): Promise { return this.ky .get('/v1/invoices/search', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick(params, 'expand', 'limit', 'page', 'query') + ) }) .json() } @@ -65719,12 +63689,42 @@ to an hour behind during outages. Search functionality is not available to merch

Note: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. Learn more

.`, inputSchema: stripe.GetInvoicesUpcomingParamsSchema }) - async GetInvoicesUpcoming( + async getInvoicesUpcoming( params: stripe.GetInvoicesUpcomingParams ): Promise { return this.ky .get('/v1/invoices/upcoming', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'automatic_tax', + 'coupon', + 'currency', + 'customer', + 'customer_details', + 'discounts', + 'expand', + 'invoice_items', + 'issuer', + 'on_behalf_of', + 'preview_mode', + 'schedule', + 'schedule_details', + 'subscription', + 'subscription_billing_cycle_anchor', + 'subscription_cancel_at', + 'subscription_cancel_at_period_end', + 'subscription_cancel_now', + 'subscription_default_tax_rates', + 'subscription_details', + 'subscription_items', + 'subscription_proration_behavior', + 'subscription_proration_date', + 'subscription_resume_at', + 'subscription_start_date', + 'subscription_trial_end' + ) + ) }) .json() } @@ -65734,16 +63734,48 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'get_invoices_upcoming_lines', - description: - '

When retrieving an upcoming invoice, you’ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

.', + description: `

When retrieving an upcoming invoice, you’ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

.`, inputSchema: stripe.GetInvoicesUpcomingLinesParamsSchema }) - async GetInvoicesUpcomingLines( + async getInvoicesUpcomingLines( params: stripe.GetInvoicesUpcomingLinesParams ): Promise { return this.ky .get('/v1/invoices/upcoming/lines', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'automatic_tax', + 'coupon', + 'currency', + 'customer', + 'customer_details', + 'discounts', + 'ending_before', + 'expand', + 'invoice_items', + 'issuer', + 'limit', + 'on_behalf_of', + 'preview_mode', + 'schedule', + 'schedule_details', + 'starting_after', + 'subscription', + 'subscription_billing_cycle_anchor', + 'subscription_cancel_at', + 'subscription_cancel_at_period_end', + 'subscription_cancel_now', + 'subscription_default_tax_rates', + 'subscription_details', + 'subscription_items', + 'subscription_proration_behavior', + 'subscription_proration_date', + 'subscription_resume_at', + 'subscription_start_date', + 'subscription_trial_end' + ) + ) }) .json() } @@ -65753,10 +63785,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'get_invoices_invoice', - description: '

Retrieves the invoice with the given ID.

.', + description: `

Retrieves the invoice with the given ID.

.`, inputSchema: stripe.GetInvoicesInvoiceParamsSchema }) - async GetInvoicesInvoice( + async getInvoicesInvoice( params: stripe.GetInvoicesInvoiceParams ): Promise { return this.ky @@ -65784,7 +63816,7 @@ sending reminders for, or automa auto_advance=false.

.`, inputSchema: stripe.PostInvoicesInvoiceParamsSchema }) - async PostInvoicesInvoice( + async postInvoicesInvoice( params: stripe.PostInvoicesInvoiceParams ): Promise { return this.ky @@ -65797,11 +63829,10 @@ sending reminders for, or automa */ @aiFunction({ name: 'delete_invoices_invoice', - description: - '

Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be voided.

.', + description: `

Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be voided.

.`, inputSchema: stripe.DeleteInvoicesInvoiceParamsSchema }) - async DeleteInvoicesInvoice( + async deleteInvoicesInvoice( params: stripe.DeleteInvoicesInvoiceParams ): Promise { return this.ky @@ -65814,11 +63845,10 @@ sending reminders for, or automa */ @aiFunction({ name: 'post_invoices_invoice_add_lines', - description: - '

Adds multiple line items to an invoice. This is only possible when an invoice is still a draft.

.', + description: `

Adds multiple line items to an invoice. This is only possible when an invoice is still a draft.

.`, inputSchema: stripe.PostInvoicesInvoiceAddLinesParamsSchema }) - async PostInvoicesInvoiceAddLines( + async postInvoicesInvoiceAddLines( params: stripe.PostInvoicesInvoiceAddLinesParams ): Promise { return this.ky @@ -65831,11 +63861,10 @@ sending reminders for, or automa */ @aiFunction({ name: 'post_invoices_invoice_finalize', - description: - '

Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you’d like to finalize a draft invoice manually, you can do so using this method.

.', + description: `

Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you’d like to finalize a draft invoice manually, you can do so using this method.

.`, inputSchema: stripe.PostInvoicesInvoiceFinalizeParamsSchema }) - async PostInvoicesInvoiceFinalize( + async postInvoicesInvoiceFinalize( params: stripe.PostInvoicesInvoiceFinalizeParams ): Promise { return this.ky @@ -65848,11 +63877,10 @@ sending reminders for, or automa */ @aiFunction({ name: 'get_invoices_invoice_lines', - description: - '

When retrieving an invoice, you’ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

.', + description: `

When retrieving an invoice, you’ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

.`, inputSchema: stripe.GetInvoicesInvoiceLinesParamsSchema }) - async GetInvoicesInvoiceLines( + async getInvoicesInvoiceLines( params: stripe.GetInvoicesInvoiceLinesParams ): Promise { return this.ky @@ -65878,11 +63906,14 @@ item and the invoice line item, so updates on this endpoint will propagate to th Updating an invoice’s line item is only possible before the invoice is finalized.

.`, inputSchema: stripe.PostInvoicesInvoiceLinesLineItemIdParamsSchema }) - async PostInvoicesInvoiceLinesLineItemId( + async postInvoicesInvoiceLinesLineItemId( params: stripe.PostInvoicesInvoiceLinesLineItemIdParams ): Promise { return this.ky - .post(`/v1/invoices/${params.invoice}/lines/${params.line_item_id}`) + .post( + `/v1/invoices/${params.invoice}/lines/${params.line_item_id}`, + {} + ) .json() } @@ -65891,11 +63922,10 @@ Updating an invoice’s line item is only possible before the invoice is finaliz */ @aiFunction({ name: 'post_invoices_invoice_mark_uncollectible', - description: - '

Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.

.', + description: `

Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.

.`, inputSchema: stripe.PostInvoicesInvoiceMarkUncollectibleParamsSchema }) - async PostInvoicesInvoiceMarkUncollectible( + async postInvoicesInvoiceMarkUncollectible( params: stripe.PostInvoicesInvoiceMarkUncollectibleParams ): Promise { return this.ky @@ -65908,11 +63938,10 @@ Updating an invoice’s line item is only possible before the invoice is finaliz */ @aiFunction({ name: 'post_invoices_invoice_pay', - description: - '

Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your subscriptions settings. However, if you’d like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so.

.', + description: `

Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your subscriptions settings. However, if you’d like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so.

.`, inputSchema: stripe.PostInvoicesInvoicePayParamsSchema }) - async PostInvoicesInvoicePay( + async postInvoicesInvoicePay( params: stripe.PostInvoicesInvoicePayParams ): Promise { return this.ky @@ -65925,11 +63954,10 @@ Updating an invoice’s line item is only possible before the invoice is finaliz */ @aiFunction({ name: 'post_invoices_invoice_remove_lines', - description: - '

Removes multiple line items from an invoice. This is only possible when an invoice is still a draft.

.', + description: `

Removes multiple line items from an invoice. This is only possible when an invoice is still a draft.

.`, inputSchema: stripe.PostInvoicesInvoiceRemoveLinesParamsSchema }) - async PostInvoicesInvoiceRemoveLines( + async postInvoicesInvoiceRemoveLines( params: stripe.PostInvoicesInvoiceRemoveLinesParams ): Promise { return this.ky @@ -65949,7 +63977,7 @@ Updating an invoice’s line item is only possible before the invoice is finaliz

Requests made in test-mode result in no emails being sent, despite sending an invoice.sent event.

.`, inputSchema: stripe.PostInvoicesInvoiceSendParamsSchema }) - async PostInvoicesInvoiceSend( + async postInvoicesInvoiceSend( params: stripe.PostInvoicesInvoiceSendParams ): Promise { return this.ky @@ -65962,11 +63990,10 @@ Updating an invoice’s line item is only possible before the invoice is finaliz */ @aiFunction({ name: 'post_invoices_invoice_update_lines', - description: - '

Updates multiple line items on an invoice. This is only possible when an invoice is still a draft.

.', + description: `

Updates multiple line items on an invoice. This is only possible when an invoice is still a draft.

.`, inputSchema: stripe.PostInvoicesInvoiceUpdateLinesParamsSchema }) - async PostInvoicesInvoiceUpdateLines( + async postInvoicesInvoiceUpdateLines( params: stripe.PostInvoicesInvoiceUpdateLinesParams ): Promise { return this.ky @@ -65986,7 +64013,7 @@ Updating an invoice’s line item is only possible before the invoice is finaliz

Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you’re doing business in. You might need to issue another invoice or credit note instead. Stripe recommends that you consult with your legal counsel for advice specific to your business.

.`, inputSchema: stripe.PostInvoicesInvoiceVoidParamsSchema }) - async PostInvoicesInvoiceVoid( + async postInvoicesInvoiceVoid( params: stripe.PostInvoicesInvoiceVoidParams ): Promise { return this.ky @@ -65999,16 +64026,27 @@ Updating an invoice’s line item is only possible before the invoice is finaliz */ @aiFunction({ name: 'get_issuing_authorizations', - description: - '

Returns a list of Issuing Authorization objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

.', + description: `

Returns a list of Issuing Authorization objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

.`, inputSchema: stripe.GetIssuingAuthorizationsParamsSchema }) - async GetIssuingAuthorizations( + async getIssuingAuthorizations( params: stripe.GetIssuingAuthorizationsParams ): Promise { return this.ky .get('/v1/issuing/authorizations', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'card', + 'cardholder', + 'created', + 'ending_before', + 'expand', + 'limit', + 'starting_after', + 'status' + ) + ) }) .json() } @@ -66018,11 +64056,10 @@ Updating an invoice’s line item is only possible before the invoice is finaliz */ @aiFunction({ name: 'get_issuing_authorizations_authorization', - description: - '

Retrieves an Issuing Authorization object.

.', + description: `

Retrieves an Issuing Authorization object.

.`, inputSchema: stripe.GetIssuingAuthorizationsAuthorizationParamsSchema }) - async GetIssuingAuthorizationsAuthorization( + async getIssuingAuthorizationsAuthorization( params: stripe.GetIssuingAuthorizationsAuthorizationParams ): Promise { return this.ky @@ -66037,11 +64074,10 @@ Updating an invoice’s line item is only possible before the invoice is finaliz */ @aiFunction({ name: 'post_issuing_authorizations_authorization', - description: - '

Updates the specified Issuing Authorization object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

.', + description: `

Updates the specified Issuing Authorization object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

.`, inputSchema: stripe.PostIssuingAuthorizationsAuthorizationParamsSchema }) - async PostIssuingAuthorizationsAuthorization( + async postIssuingAuthorizationsAuthorization( params: stripe.PostIssuingAuthorizationsAuthorizationParams ): Promise { return this.ky @@ -66060,7 +64096,7 @@ This method is deprecated. Instead, { return this.ky @@ -66092,16 +64128,28 @@ This method is deprecated. Instead, Creates a new Issuing Cardholder object that can be issued cards.

.', + description: `

Creates a new Issuing Cardholder object that can be issued cards.

.`, inputSchema: stripe.PostIssuingCardholdersParamsSchema }) - async PostIssuingCardholders( + async postIssuingCardholders( _params: stripe.PostIssuingCardholdersParams ): Promise { return this.ky @@ -66128,10 +64175,10 @@ This method is deprecated. Instead, Updates the specified Issuing Cardholder object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

.', + description: `

Updates the specified Issuing Cardholder object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

.`, inputSchema: stripe.PostIssuingCardholdersCardholderParamsSchema }) - async PostIssuingCardholdersCardholder( + async postIssuingCardholdersCardholder( params: stripe.PostIssuingCardholdersCardholderParams ): Promise { return this.ky @@ -66163,16 +64209,31 @@ This method is deprecated. Instead, Creates an Issuing Card object.

.', + description: `

Creates an Issuing Card object.

.`, inputSchema: stripe.PostIssuingCardsParamsSchema }) - async PostIssuingCards( + async postIssuingCards( _params: stripe.PostIssuingCardsParams ): Promise { return this.ky @@ -66198,10 +64259,10 @@ This method is deprecated. Instead, Updates the specified Issuing Card object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

.', + description: `

Updates the specified Issuing Card object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

.`, inputSchema: stripe.PostIssuingCardsCardParamsSchema }) - async PostIssuingCardsCard( + async postIssuingCardsCard( params: stripe.PostIssuingCardsCardParams ): Promise { return this.ky @@ -66233,16 +64293,26 @@ This method is deprecated. Instead, Creates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to Dispute reasons and evidence for more details about evidence requirements.

.', + description: `

Creates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to Dispute reasons and evidence for more details about evidence requirements.

.`, inputSchema: stripe.PostIssuingDisputesParamsSchema }) - async PostIssuingDisputes( + async postIssuingDisputes( _params: stripe.PostIssuingDisputesParams ): Promise { return this.ky @@ -66269,10 +64338,10 @@ This method is deprecated. Instead, Updates the specified Issuing Dispute object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Properties on the evidence object can be unset by passing in an empty string.

.', + description: `

Updates the specified Issuing Dispute object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Properties on the evidence object can be unset by passing in an empty string.

.`, inputSchema: stripe.PostIssuingDisputesDisputeParamsSchema }) - async PostIssuingDisputesDispute( + async postIssuingDisputesDispute( params: stripe.PostIssuingDisputesDisputeParams ): Promise { return this.ky @@ -66304,11 +64372,10 @@ This method is deprecated. Instead, Dispute reasons and evidence.

.', + description: `

Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute’s reason are present. For more details, see Dispute reasons and evidence.

.`, inputSchema: stripe.PostIssuingDisputesDisputeSubmitParamsSchema }) - async PostIssuingDisputesDisputeSubmit( + async postIssuingDisputesDisputeSubmit( params: stripe.PostIssuingDisputesDisputeSubmitParams ): Promise { return this.ky @@ -66321,16 +64388,26 @@ This method is deprecated. Instead, Creates a personalization design object.

.', + description: `

Creates a personalization design object.

.`, inputSchema: stripe.PostIssuingPersonalizationDesignsParamsSchema }) - async PostIssuingPersonalizationDesigns( + async postIssuingPersonalizationDesigns( _params: stripe.PostIssuingPersonalizationDesignsParams ): Promise { return this.ky @@ -66356,11 +64433,11 @@ This method is deprecated. Instead, Updates a card personalization object.

.', + description: `

Updates a card personalization object.

.`, inputSchema: stripe.PostIssuingPersonalizationDesignsPersonalizationDesignParamsSchema }) - async PostIssuingPersonalizationDesignsPersonalizationDesign( + async postIssuingPersonalizationDesignsPersonalizationDesign( params: stripe.PostIssuingPersonalizationDesignsPersonalizationDesignParams ): Promise { return this.ky @@ -66397,16 +64474,25 @@ This method is deprecated. Instead, Retrieves a physical bundle object.

.', + description: `

Retrieves a physical bundle object.

.`, inputSchema: stripe.GetIssuingPhysicalBundlesPhysicalBundleParamsSchema }) - async GetIssuingPhysicalBundlesPhysicalBundle( + async getIssuingPhysicalBundlesPhysicalBundle( params: stripe.GetIssuingPhysicalBundlesPhysicalBundleParams ): Promise { return this.ky @@ -66434,10 +64520,10 @@ This method is deprecated. Instead, Updates the specified Issuing Settlement object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

.', + description: `

Updates the specified Issuing Settlement object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

.`, inputSchema: stripe.PostIssuingSettlementsSettlementParamsSchema }) - async PostIssuingSettlementsSettlement( + async postIssuingSettlementsSettlement( params: stripe.PostIssuingSettlementsSettlementParams ): Promise { return this.ky @@ -66469,16 +64554,26 @@ This method is deprecated. Instead, Retrieves an Issuing Token object.

.', + description: `

Retrieves an Issuing Token object.

.`, inputSchema: stripe.GetIssuingTokensTokenParamsSchema }) - async GetIssuingTokensToken( + async getIssuingTokensToken( params: stripe.GetIssuingTokensTokenParams ): Promise { return this.ky @@ -66506,11 +64601,10 @@ This method is deprecated. Instead, Returns a list of Issuing Transaction objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

.', + description: `

Returns a list of Issuing Transaction objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

.`, inputSchema: stripe.GetIssuingTransactionsParamsSchema }) - async GetIssuingTransactions( + async getIssuingTransactions( params: stripe.GetIssuingTransactionsParams ): Promise { return this.ky .get('/v1/issuing/transactions', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'card', + 'cardholder', + 'created', + 'ending_before', + 'expand', + 'limit', + 'starting_after', + 'type' + ) + ) }) .json() } @@ -66542,11 +64647,10 @@ This method is deprecated. Instead, Updates the specified Issuing Transaction object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

.', + description: `

Updates the specified Issuing Transaction object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

.`, inputSchema: stripe.PostIssuingTransactionsTransactionParamsSchema }) - async PostIssuingTransactionsTransaction( + async postIssuingTransactionsTransaction( params: stripe.PostIssuingTransactionsTransactionParams ): Promise { return this.ky @@ -66578,11 +64681,10 @@ This method is deprecated. Instead, Retrieves the details of a Financial Connections Session

.', + description: `

Retrieves the details of a Financial Connections Session

.`, inputSchema: stripe.GetLinkAccountSessionsSessionParamsSchema }) - async GetLinkAccountSessionsSession( + async getLinkAccountSessionsSession( params: stripe.GetLinkAccountSessionsSessionParams ): Promise { return this.ky @@ -66614,16 +64715,25 @@ This method is deprecated. Instead, Retrieves the details of an Financial Connections Account.

.', + description: `

Retrieves the details of an Financial Connections Account.

.`, inputSchema: stripe.GetLinkedAccountsAccountParamsSchema }) - async GetLinkedAccountsAccount( + async getLinkedAccountsAccount( params: stripe.GetLinkedAccountsAccountParams ): Promise { return this.ky @@ -66652,11 +64761,10 @@ This method is deprecated. Instead, Lists all owners for a given Account

.', + description: `

Lists all owners for a given Account

.`, inputSchema: stripe.GetLinkedAccountsAccountOwnersParamsSchema }) - async GetLinkedAccountsAccountOwners( + async getLinkedAccountsAccountOwners( params: stripe.GetLinkedAccountsAccountOwnersParams ): Promise { return this.ky @@ -66696,11 +64804,10 @@ This method is deprecated. Instead, Retrieves a Mandate object.

.', + description: `

Retrieves a Mandate object.

.`, inputSchema: stripe.GetMandatesMandateParamsSchema }) - async GetMandatesMandate( + async getMandatesMandate( params: stripe.GetMandatesMandateParams ): Promise { return this.ky @@ -66731,15 +64838,25 @@ This method is deprecated. Instead, confirm API whe confirm=true.

.`, inputSchema: stripe.PostPaymentIntentsParamsSchema }) - async PostPaymentIntents( + async postPaymentIntents( _params: stripe.PostPaymentIntentsParams ): Promise { return this.ky @@ -66792,12 +64909,14 @@ conditions, data is searchable in less than a minute. Occasionally, propagation to an hour behind during outages. Search functionality is not available to merchants in India.

.`, inputSchema: stripe.GetPaymentIntentsSearchParamsSchema }) - async GetPaymentIntentsSearch( + async getPaymentIntentsSearch( params: stripe.GetPaymentIntentsSearchParams ): Promise { return this.ky .get('/v1/payment_intents/search', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick(params, 'expand', 'limit', 'page', 'query') + ) }) .json() } @@ -66818,7 +64937,7 @@ to an hour behind during outages. Search functionality is not available to merch

If you retrieve a PaymentIntent with a publishable key, it only returns a subset of properties. Refer to the payment intent object reference for more details.

.`, inputSchema: stripe.GetPaymentIntentsIntentParamsSchema }) - async GetPaymentIntentsIntent( + async getPaymentIntentsIntent( params: stripe.GetPaymentIntentsIntentParams ): Promise { return this.ky @@ -66850,7 +64969,7 @@ update and confirm at the same time, we recommend updating properties through the confirm API instead.

.`, inputSchema: stripe.PostPaymentIntentsIntentParamsSchema }) - async PostPaymentIntentsIntent( + async postPaymentIntentsIntent( params: stripe.PostPaymentIntentsIntentParams ): Promise { return this.ky @@ -66863,11 +64982,10 @@ the confirm API instead.

.`, */ @aiFunction({ name: 'post_payment_intents_intent_apply_customer_balance', - description: - '

Manually reconcile the remaining amount for a customer_balance PaymentIntent.

.', + description: `

Manually reconcile the remaining amount for a customer_balance PaymentIntent.

.`, inputSchema: stripe.PostPaymentIntentsIntentApplyCustomerBalanceParamsSchema }) - async PostPaymentIntentsIntentApplyCustomerBalance( + async postPaymentIntentsIntentApplyCustomerBalance( params: stripe.PostPaymentIntentsIntentApplyCustomerBalanceParams ): Promise { return this.ky @@ -66891,7 +65009,7 @@ the confirm API instead.

.`,

You can’t cancel the PaymentIntent for a Checkout Session. Expire the Checkout Session instead.

.`, inputSchema: stripe.PostPaymentIntentsIntentCancelParamsSchema }) - async PostPaymentIntentsIntentCancel( + async postPaymentIntentsIntentCancel( params: stripe.PostPaymentIntentsIntentCancelParams ): Promise { return this.ky @@ -66915,7 +65033,7 @@ the confirm API instead.

.`,

Learn more about separate authorization and capture.

.`, inputSchema: stripe.PostPaymentIntentsIntentCaptureParamsSchema }) - async PostPaymentIntentsIntentCapture( + async postPaymentIntentsIntentCapture( params: stripe.PostPaymentIntentsIntentCaptureParams ): Promise { return this.ky @@ -66979,7 +65097,7 @@ After this limit is reached, any further calls to this endpoint will transition the PaymentIntent to the canceled state.

.`, inputSchema: stripe.PostPaymentIntentsIntentConfirmParamsSchema }) - async PostPaymentIntentsIntentConfirm( + async postPaymentIntentsIntentConfirm( params: stripe.PostPaymentIntentsIntentConfirmParams ): Promise { return this.ky @@ -67042,7 +65160,7 @@ After it’s captured, a PaymentIntent can no longer be incremented.

inputSchema: stripe.PostPaymentIntentsIntentIncrementAuthorizationParamsSchema }) - async PostPaymentIntentsIntentIncrementAuthorization( + async postPaymentIntentsIntentIncrementAuthorization( params: stripe.PostPaymentIntentsIntentIncrementAuthorizationParams ): Promise { return this.ky @@ -67055,10 +65173,10 @@ After it’s captured, a PaymentIntent can no longer be incremented.

*/ @aiFunction({ name: 'post_payment_intents_intent_verify_microdeposits', - description: '

Verifies microdeposits on a PaymentIntent object.

.', + description: `

Verifies microdeposits on a PaymentIntent object.

.`, inputSchema: stripe.PostPaymentIntentsIntentVerifyMicrodepositsParamsSchema }) - async PostPaymentIntentsIntentVerifyMicrodeposits( + async postPaymentIntentsIntentVerifyMicrodeposits( params: stripe.PostPaymentIntentsIntentVerifyMicrodepositsParams ): Promise { return this.ky @@ -67071,15 +65189,24 @@ After it’s captured, a PaymentIntent can no longer be incremented.

*/ @aiFunction({ name: 'get_payment_links', - description: '

Returns a list of your payment links.

.', + description: `

Returns a list of your payment links.

.`, inputSchema: stripe.GetPaymentLinksParamsSchema }) - async GetPaymentLinks( + async getPaymentLinks( params: stripe.GetPaymentLinksParams ): Promise { return this.ky .get('/v1/payment_links', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'active', + 'ending_before', + 'expand', + 'limit', + 'starting_after' + ) + ) }) .json() } @@ -67089,10 +65216,10 @@ After it’s captured, a PaymentIntent can no longer be incremented.

*/ @aiFunction({ name: 'post_payment_links', - description: '

Creates a payment link.

.', + description: `

Creates a payment link.

.`, inputSchema: stripe.PostPaymentLinksParamsSchema }) - async PostPaymentLinks( + async postPaymentLinks( _params: stripe.PostPaymentLinksParams ): Promise { return this.ky @@ -67105,10 +65232,10 @@ After it’s captured, a PaymentIntent can no longer be incremented.

*/ @aiFunction({ name: 'get_payment_links_payment_link', - description: '

Retrieve a payment link.

.', + description: `

Retrieve a payment link.

.`, inputSchema: stripe.GetPaymentLinksPaymentLinkParamsSchema }) - async GetPaymentLinksPaymentLink( + async getPaymentLinksPaymentLink( params: stripe.GetPaymentLinksPaymentLinkParams ): Promise { return this.ky @@ -67123,10 +65250,10 @@ After it’s captured, a PaymentIntent can no longer be incremented.

*/ @aiFunction({ name: 'post_payment_links_payment_link', - description: '

Updates a payment link.

.', + description: `

Updates a payment link.

.`, inputSchema: stripe.PostPaymentLinksPaymentLinkParamsSchema }) - async PostPaymentLinksPaymentLink( + async postPaymentLinksPaymentLink( params: stripe.PostPaymentLinksPaymentLinkParams ): Promise { return this.ky @@ -67139,11 +65266,10 @@ After it’s captured, a PaymentIntent can no longer be incremented.

*/ @aiFunction({ name: 'get_payment_links_payment_link_line_items', - description: - '

When retrieving a payment link, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

.', + description: `

When retrieving a payment link, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

.`, inputSchema: stripe.GetPaymentLinksPaymentLinkLineItemsParamsSchema }) - async GetPaymentLinksPaymentLinkLineItems( + async getPaymentLinksPaymentLinkLineItems( params: stripe.GetPaymentLinksPaymentLinkLineItemsParams ): Promise { return this.ky @@ -67160,15 +65286,24 @@ After it’s captured, a PaymentIntent can no longer be incremented.

*/ @aiFunction({ name: 'get_payment_method_configurations', - description: '

List payment method configurations

.', + description: `

List payment method configurations

.`, inputSchema: stripe.GetPaymentMethodConfigurationsParamsSchema }) - async GetPaymentMethodConfigurations( + async getPaymentMethodConfigurations( params: stripe.GetPaymentMethodConfigurationsParams ): Promise { return this.ky .get('/v1/payment_method_configurations', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'application', + 'ending_before', + 'expand', + 'limit', + 'starting_after' + ) + ) }) .json() } @@ -67178,10 +65313,10 @@ After it’s captured, a PaymentIntent can no longer be incremented.

*/ @aiFunction({ name: 'post_payment_method_configurations', - description: '

Creates a payment method configuration

.', + description: `

Creates a payment method configuration

.`, inputSchema: stripe.PostPaymentMethodConfigurationsParamsSchema }) - async PostPaymentMethodConfigurations( + async postPaymentMethodConfigurations( _params: stripe.PostPaymentMethodConfigurationsParams ): Promise { return this.ky @@ -67194,10 +65329,10 @@ After it’s captured, a PaymentIntent can no longer be incremented.

*/ @aiFunction({ name: 'get_payment_method_configurations_configuration', - description: '

Retrieve payment method configuration

.', + description: `

Retrieve payment method configuration

.`, inputSchema: stripe.GetPaymentMethodConfigurationsConfigurationParamsSchema }) - async GetPaymentMethodConfigurationsConfiguration( + async getPaymentMethodConfigurationsConfiguration( params: stripe.GetPaymentMethodConfigurationsConfigurationParams ): Promise { return this.ky @@ -67212,10 +65347,10 @@ After it’s captured, a PaymentIntent can no longer be incremented.

*/ @aiFunction({ name: 'post_payment_method_configurations_configuration', - description: '

Update payment method configuration

.', + description: `

Update payment method configuration

.`, inputSchema: stripe.PostPaymentMethodConfigurationsConfigurationParamsSchema }) - async PostPaymentMethodConfigurationsConfiguration( + async postPaymentMethodConfigurationsConfiguration( params: stripe.PostPaymentMethodConfigurationsConfigurationParams ): Promise { return this.ky @@ -67228,16 +65363,25 @@ After it’s captured, a PaymentIntent can no longer be incremented.

*/ @aiFunction({ name: 'get_payment_method_domains', - description: - '

Lists the details of existing payment method domains.

.', + description: `

Lists the details of existing payment method domains.

.`, inputSchema: stripe.GetPaymentMethodDomainsParamsSchema }) - async GetPaymentMethodDomains( + async getPaymentMethodDomains( params: stripe.GetPaymentMethodDomainsParams ): Promise { return this.ky .get('/v1/payment_method_domains', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'domain_name', + 'enabled', + 'ending_before', + 'expand', + 'limit', + 'starting_after' + ) + ) }) .json() } @@ -67247,10 +65391,10 @@ After it’s captured, a PaymentIntent can no longer be incremented.

*/ @aiFunction({ name: 'post_payment_method_domains', - description: '

Creates a payment method domain.

.', + description: `

Creates a payment method domain.

.`, inputSchema: stripe.PostPaymentMethodDomainsParamsSchema }) - async PostPaymentMethodDomains( + async postPaymentMethodDomains( _params: stripe.PostPaymentMethodDomainsParams ): Promise { return this.ky @@ -67263,11 +65407,10 @@ After it’s captured, a PaymentIntent can no longer be incremented.

*/ @aiFunction({ name: 'get_payment_method_domains_payment_method_domain', - description: - '

Retrieves the details of an existing payment method domain.

.', + description: `

Retrieves the details of an existing payment method domain.

.`, inputSchema: stripe.GetPaymentMethodDomainsPaymentMethodDomainParamsSchema }) - async GetPaymentMethodDomainsPaymentMethodDomain( + async getPaymentMethodDomainsPaymentMethodDomain( params: stripe.GetPaymentMethodDomainsPaymentMethodDomainParams ): Promise { return this.ky @@ -67282,10 +65425,10 @@ After it’s captured, a PaymentIntent can no longer be incremented.

*/ @aiFunction({ name: 'post_payment_method_domains_payment_method_domain', - description: '

Updates an existing payment method domain.

.', + description: `

Updates an existing payment method domain.

.`, inputSchema: stripe.PostPaymentMethodDomainsPaymentMethodDomainParamsSchema }) - async PostPaymentMethodDomainsPaymentMethodDomain( + async postPaymentMethodDomainsPaymentMethodDomain( params: stripe.PostPaymentMethodDomainsPaymentMethodDomainParams ): Promise { return this.ky @@ -67312,7 +65455,7 @@ The payment method doesn’t appear in Elements for this domain until it is acti inputSchema: stripe.PostPaymentMethodDomainsPaymentMethodDomainValidateParamsSchema }) - async PostPaymentMethodDomainsPaymentMethodDomainValidate( + async postPaymentMethodDomainsPaymentMethodDomainValidate( params: stripe.PostPaymentMethodDomainsPaymentMethodDomainValidateParams ): Promise { return this.ky @@ -67327,16 +65470,25 @@ The payment method doesn’t appear in Elements for this domain until it is acti */ @aiFunction({ name: 'get_payment_methods', - description: - '

Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the List a Customer’s PaymentMethods API instead.

.', + description: `

Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the List a Customer’s PaymentMethods API instead.

.`, inputSchema: stripe.GetPaymentMethodsParamsSchema }) - async GetPaymentMethods( + async getPaymentMethods( params: stripe.GetPaymentMethodsParams ): Promise { return this.ky .get('/v1/payment_methods', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'customer', + 'ending_before', + 'expand', + 'limit', + 'starting_after', + 'type' + ) + ) }) .json() } @@ -67353,7 +65505,7 @@ The payment method doesn’t appear in Elements for this domain until it is acti

Instead of creating a PaymentMethod directly, we recommend using the PaymentIntents API to accept a payment immediately or the SetupIntent API to collect payment method details ahead of a future payment.

.`, inputSchema: stripe.PostPaymentMethodsParamsSchema }) - async PostPaymentMethods( + async postPaymentMethods( _params: stripe.PostPaymentMethodsParams ): Promise { return this.ky @@ -67366,11 +65518,10 @@ The payment method doesn’t appear in Elements for this domain until it is acti */ @aiFunction({ name: 'get_payment_methods_payment_method', - description: - '

Retrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use Retrieve a Customer’s PaymentMethods

.', + description: `

Retrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use Retrieve a Customer’s PaymentMethods

.`, inputSchema: stripe.GetPaymentMethodsPaymentMethodParamsSchema }) - async GetPaymentMethodsPaymentMethod( + async getPaymentMethodsPaymentMethod( params: stripe.GetPaymentMethodsPaymentMethodParams ): Promise { return this.ky @@ -67385,11 +65536,10 @@ The payment method doesn’t appear in Elements for this domain until it is acti */ @aiFunction({ name: 'post_payment_methods_payment_method', - description: - '

Updates a PaymentMethod object. A PaymentMethod must be attached a customer to be updated.

.', + description: `

Updates a PaymentMethod object. A PaymentMethod must be attached a customer to be updated.

.`, inputSchema: stripe.PostPaymentMethodsPaymentMethodParamsSchema }) - async PostPaymentMethodsPaymentMethod( + async postPaymentMethodsPaymentMethod( params: stripe.PostPaymentMethodsPaymentMethodParams ): Promise { return this.ky @@ -67429,7 +65579,7 @@ set balance object details available and pending amounts by source type.

.`, inputSchema: stripe.PostPayoutsParamsSchema }) - async PostPayouts( + async postPayouts( _params: stripe.PostPayoutsParams ): Promise { return this.ky.post('/v1/payouts').json() @@ -67500,11 +65660,10 @@ on the Customer to the PaymentMethod’s ID.

.`, */ @aiFunction({ name: 'get_payouts_payout', - description: - '

Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list. Stripe returns the corresponding payout information.

.', + description: `

Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list. Stripe returns the corresponding payout information.

.`, inputSchema: stripe.GetPayoutsPayoutParamsSchema }) - async GetPayoutsPayout( + async getPayoutsPayout( params: stripe.GetPayoutsPayoutParams ): Promise { return this.ky @@ -67519,11 +65678,10 @@ on the Customer to the PaymentMethod’s ID.

.`, */ @aiFunction({ name: 'post_payouts_payout', - description: - '

Updates the specified payout by setting the values of the parameters you pass. We don’t change parameters that you don’t provide. This request only accepts the metadata as arguments.

.', + description: `

Updates the specified payout by setting the values of the parameters you pass. We don’t change parameters that you don’t provide. This request only accepts the metadata as arguments.

.`, inputSchema: stripe.PostPayoutsPayoutParamsSchema }) - async PostPayoutsPayout( + async postPayoutsPayout( params: stripe.PostPayoutsPayoutParams ): Promise { return this.ky @@ -67536,11 +65694,10 @@ on the Customer to the PaymentMethod’s ID.

.`, */ @aiFunction({ name: 'post_payouts_payout_cancel', - description: - '

You can cancel a previously created payout if its status is pending. Stripe refunds the funds to your available balance. You can’t cancel automatic Stripe payouts.

.', + description: `

You can cancel a previously created payout if its status is pending. Stripe refunds the funds to your available balance. You can’t cancel automatic Stripe payouts.

.`, inputSchema: stripe.PostPayoutsPayoutCancelParamsSchema }) - async PostPayoutsPayoutCancel( + async postPayoutsPayoutCancel( params: stripe.PostPayoutsPayoutCancelParams ): Promise { return this.ky @@ -67560,7 +65717,7 @@ on the Customer to the PaymentMethod’s ID.

.`,

By requesting a reversal through /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account authorizes the debit on the bank account and that no other authorization is required.

.`, inputSchema: stripe.PostPayoutsPayoutReverseParamsSchema }) - async PostPayoutsPayoutReverse( + async postPayoutsPayoutReverse( params: stripe.PostPayoutsPayoutReverseParams ): Promise { return this.ky @@ -67573,15 +65730,26 @@ on the Customer to the PaymentMethod’s ID.

.`, */ @aiFunction({ name: 'get_plans', - description: '

Returns a list of your plans.

.', + description: `

Returns a list of your plans.

.`, inputSchema: stripe.GetPlansParamsSchema }) - async GetPlans( + async getPlans( params: stripe.GetPlansParams ): Promise { return this.ky .get('/v1/plans', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'active', + 'created', + 'ending_before', + 'expand', + 'limit', + 'product', + 'starting_after' + ) + ) }) .json() } @@ -67591,11 +65759,10 @@ on the Customer to the PaymentMethod’s ID.

.`, */ @aiFunction({ name: 'post_plans', - description: - '

You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.

.', + description: `

You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.

.`, inputSchema: stripe.PostPlansParamsSchema }) - async PostPlans( + async postPlans( _params: stripe.PostPlansParams ): Promise { return this.ky.post('/v1/plans').json() @@ -67606,10 +65773,10 @@ on the Customer to the PaymentMethod’s ID.

.`, */ @aiFunction({ name: 'get_plans_plan', - description: '

Retrieves the plan with the given ID.

.', + description: `

Retrieves the plan with the given ID.

.`, inputSchema: stripe.GetPlansPlanParamsSchema }) - async GetPlansPlan( + async getPlansPlan( params: stripe.GetPlansPlanParams ): Promise { return this.ky @@ -67624,11 +65791,10 @@ on the Customer to the PaymentMethod’s ID.

.`, */ @aiFunction({ name: 'post_plans_plan', - description: - '

Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan’s ID, amount, currency, or billing cycle.

.', + description: `

Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan’s ID, amount, currency, or billing cycle.

.`, inputSchema: stripe.PostPlansPlanParamsSchema }) - async PostPlansPlan( + async postPlansPlan( params: stripe.PostPlansPlanParams ): Promise { return this.ky @@ -67641,11 +65807,10 @@ on the Customer to the PaymentMethod’s ID.

.`, */ @aiFunction({ name: 'delete_plans_plan', - description: - '

Deleting plans means new subscribers can’t be added. Existing subscribers aren’t affected.

.', + description: `

Deleting plans means new subscribers can’t be added. Existing subscribers aren’t affected.

.`, inputSchema: stripe.DeletePlansPlanParamsSchema }) - async DeletePlansPlan( + async deletePlansPlan( params: stripe.DeletePlansPlanParams ): Promise { return this.ky @@ -67658,16 +65823,30 @@ on the Customer to the PaymentMethod’s ID.

.`, */ @aiFunction({ name: 'get_prices', - description: - '

Returns a list of your active prices, excluding inline prices. For the list of inactive prices, set active to false.

.', + description: `

Returns a list of your active prices, excluding inline prices. For the list of inactive prices, set active to false.

.`, inputSchema: stripe.GetPricesParamsSchema }) - async GetPrices( + async getPrices( params: stripe.GetPricesParams ): Promise { return this.ky .get('/v1/prices', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'active', + 'created', + 'currency', + 'ending_before', + 'expand', + 'limit', + 'lookup_keys', + 'product', + 'recurring', + 'starting_after', + 'type' + ) + ) }) .json() } @@ -67677,11 +65856,10 @@ on the Customer to the PaymentMethod’s ID.

.`, */ @aiFunction({ name: 'post_prices', - description: - '

Creates a new price for an existing product. The price can be recurring or one-time.

.', + description: `

Creates a new price for an existing product. The price can be recurring or one-time.

.`, inputSchema: stripe.PostPricesParamsSchema }) - async PostPrices( + async postPrices( _params: stripe.PostPricesParams ): Promise { return this.ky.post('/v1/prices').json() @@ -67701,12 +65879,14 @@ conditions, data is searchable in less than a minute. Occasionally, propagation to an hour behind during outages. Search functionality is not available to merchants in India.

.`, inputSchema: stripe.GetPricesSearchParamsSchema }) - async GetPricesSearch( + async getPricesSearch( params: stripe.GetPricesSearchParams ): Promise { return this.ky .get('/v1/prices/search', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick(params, 'expand', 'limit', 'page', 'query') + ) }) .json() } @@ -67716,10 +65896,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'get_prices_price', - description: '

Retrieves the price with the given ID.

.', + description: `

Retrieves the price with the given ID.

.`, inputSchema: stripe.GetPricesPriceParamsSchema }) - async GetPricesPrice( + async getPricesPrice( params: stripe.GetPricesPriceParams ): Promise { return this.ky @@ -67734,11 +65914,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'post_prices_price', - description: - '

Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.

.', + description: `

Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.

.`, inputSchema: stripe.PostPricesPriceParamsSchema }) - async PostPricesPrice( + async postPricesPrice( params: stripe.PostPricesPriceParams ): Promise { return this.ky @@ -67751,16 +65930,28 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'get_products', - description: - '

Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.

.', + description: `

Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.

.`, inputSchema: stripe.GetProductsParamsSchema }) - async GetProducts( + async getProducts( params: stripe.GetProductsParams ): Promise { return this.ky .get('/v1/products', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'active', + 'created', + 'ending_before', + 'expand', + 'ids', + 'limit', + 'shippable', + 'starting_after', + 'url' + ) + ) }) .json() } @@ -67770,10 +65961,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'post_products', - description: '

Creates a new product object.

.', + description: `

Creates a new product object.

.`, inputSchema: stripe.PostProductsParamsSchema }) - async PostProducts( + async postProducts( _params: stripe.PostProductsParams ): Promise { return this.ky.post('/v1/products').json() @@ -67793,12 +65984,14 @@ conditions, data is searchable in less than a minute. Occasionally, propagation to an hour behind during outages. Search functionality is not available to merchants in India.

.`, inputSchema: stripe.GetProductsSearchParamsSchema }) - async GetProductsSearch( + async getProductsSearch( params: stripe.GetProductsSearchParams ): Promise { return this.ky .get('/v1/products/search', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick(params, 'expand', 'limit', 'page', 'query') + ) }) .json() } @@ -67808,11 +66001,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'get_products_id', - description: - '

Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information.

.', + description: `

Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information.

.`, inputSchema: stripe.GetProductsIdParamsSchema }) - async GetProductsId( + async getProductsId( params: stripe.GetProductsIdParams ): Promise { return this.ky @@ -67827,11 +66019,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'post_products_id', - description: - '

Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

.', + description: `

Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

.`, inputSchema: stripe.PostProductsIdParamsSchema }) - async PostProductsId( + async postProductsId( params: stripe.PostProductsIdParams ): Promise { return this.ky @@ -67844,11 +66035,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'delete_products_id', - description: - '

Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with type=good is only possible if it has no SKUs associated with it.

.', + description: `

Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with type=good is only possible if it has no SKUs associated with it.

.`, inputSchema: stripe.DeleteProductsIdParamsSchema }) - async DeleteProductsId( + async deleteProductsId( params: stripe.DeleteProductsIdParams ): Promise { return this.ky @@ -67861,10 +66051,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'get_products_product_features', - description: '

Retrieve a list of features for a product

.', + description: `

Retrieve a list of features for a product

.`, inputSchema: stripe.GetProductsProductFeaturesParamsSchema }) - async GetProductsProductFeatures( + async getProductsProductFeatures( params: stripe.GetProductsProductFeaturesParams ): Promise { return this.ky @@ -67881,11 +66071,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'post_products_product_features', - description: - '

Creates a product_feature, which represents a feature attachment to a product

.', + description: `

Creates a product_feature, which represents a feature attachment to a product

.`, inputSchema: stripe.PostProductsProductFeaturesParamsSchema }) - async PostProductsProductFeatures( + async postProductsProductFeatures( params: stripe.PostProductsProductFeaturesParams ): Promise { return this.ky @@ -67898,11 +66087,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'get_products_product_features_id', - description: - '

Retrieves a product_feature, which represents a feature attachment to a product

.', + description: `

Retrieves a product_feature, which represents a feature attachment to a product

.`, inputSchema: stripe.GetProductsProductFeaturesIdParamsSchema }) - async GetProductsProductFeaturesId( + async getProductsProductFeaturesId( params: stripe.GetProductsProductFeaturesIdParams ): Promise { return this.ky @@ -67917,14 +66105,14 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'delete_products_product_features_id', - description: '

Deletes the feature attachment to a product

.', + description: `

Deletes the feature attachment to a product

.`, inputSchema: stripe.DeleteProductsProductFeaturesIdParamsSchema }) - async DeleteProductsProductFeaturesId( + async deleteProductsProductFeaturesId( params: stripe.DeleteProductsProductFeaturesIdParams ): Promise { return this.ky - .delete(`/v1/products/${params.product}/features/${params.id}`) + .delete(`/v1/products/${params.product}/features/${params.id}`, {}) .json() } @@ -67933,15 +66121,28 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'get_promotion_codes', - description: '

Returns a list of your promotion codes.

.', + description: `

Returns a list of your promotion codes.

.`, inputSchema: stripe.GetPromotionCodesParamsSchema }) - async GetPromotionCodes( + async getPromotionCodes( params: stripe.GetPromotionCodesParams ): Promise { return this.ky .get('/v1/promotion_codes', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'active', + 'code', + 'coupon', + 'created', + 'customer', + 'ending_before', + 'expand', + 'limit', + 'starting_after' + ) + ) }) .json() } @@ -67951,11 +66152,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'post_promotion_codes', - description: - '

A promotion code points to a coupon. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.

.', + description: `

A promotion code points to a coupon. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.

.`, inputSchema: stripe.PostPromotionCodesParamsSchema }) - async PostPromotionCodes( + async postPromotionCodes( _params: stripe.PostPromotionCodesParams ): Promise { return this.ky @@ -67968,11 +66168,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'get_promotion_codes_promotion_code', - description: - '

Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing code use list with the desired code.

.', + description: `

Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing code use list with the desired code.

.`, inputSchema: stripe.GetPromotionCodesPromotionCodeParamsSchema }) - async GetPromotionCodesPromotionCode( + async getPromotionCodesPromotionCode( params: stripe.GetPromotionCodesPromotionCodeParams ): Promise { return this.ky @@ -67987,11 +66186,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'post_promotion_codes_promotion_code', - description: - '

Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.

.', + description: `

Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.

.`, inputSchema: stripe.PostPromotionCodesPromotionCodeParamsSchema }) - async PostPromotionCodesPromotionCode( + async postPromotionCodesPromotionCode( params: stripe.PostPromotionCodesPromotionCodeParams ): Promise { return this.ky @@ -68004,15 +66202,26 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'get_quotes', - description: '

Returns a list of your quotes.

.', + description: `

Returns a list of your quotes.

.`, inputSchema: stripe.GetQuotesParamsSchema }) - async GetQuotes( + async getQuotes( params: stripe.GetQuotesParams ): Promise { return this.ky .get('/v1/quotes', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'customer', + 'ending_before', + 'expand', + 'limit', + 'starting_after', + 'status', + 'test_clock' + ) + ) }) .json() } @@ -68022,11 +66231,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'post_quotes', - description: - '

A quote models prices and services for a customer. Default options for header, description, footer, and expires_at can be set in the dashboard via the quote template.

.', + description: `

A quote models prices and services for a customer. Default options for header, description, footer, and expires_at can be set in the dashboard via the quote template.

.`, inputSchema: stripe.PostQuotesParamsSchema }) - async PostQuotes( + async postQuotes( _params: stripe.PostQuotesParams ): Promise { return this.ky.post('/v1/quotes').json() @@ -68037,10 +66245,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'get_quotes_quote', - description: '

Retrieves the quote with the given ID.

.', + description: `

Retrieves the quote with the given ID.

.`, inputSchema: stripe.GetQuotesQuoteParamsSchema }) - async GetQuotesQuote( + async getQuotesQuote( params: stripe.GetQuotesQuoteParams ): Promise { return this.ky @@ -68055,10 +66263,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'post_quotes_quote', - description: '

A quote models prices and services for a customer.

.', + description: `

A quote models prices and services for a customer.

.`, inputSchema: stripe.PostQuotesQuoteParamsSchema }) - async PostQuotesQuote( + async postQuotesQuote( params: stripe.PostQuotesQuoteParams ): Promise { return this.ky @@ -68071,10 +66279,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'post_quotes_quote_accept', - description: '

Accepts the specified quote.

.', + description: `

Accepts the specified quote.

.`, inputSchema: stripe.PostQuotesQuoteAcceptParamsSchema }) - async PostQuotesQuoteAccept( + async postQuotesQuoteAccept( params: stripe.PostQuotesQuoteAcceptParams ): Promise { return this.ky @@ -68087,10 +66295,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'post_quotes_quote_cancel', - description: '

Cancels the quote.

.', + description: `

Cancels the quote.

.`, inputSchema: stripe.PostQuotesQuoteCancelParamsSchema }) - async PostQuotesQuoteCancel( + async postQuotesQuoteCancel( params: stripe.PostQuotesQuoteCancelParams ): Promise { return this.ky @@ -68103,11 +66311,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'get_quotes_quote_computed_upfront_line_items', - description: - '

When retrieving a quote, there is an includable computed.upfront.line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of upfront line items.

.', + description: `

When retrieving a quote, there is an includable computed.upfront.line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of upfront line items.

.`, inputSchema: stripe.GetQuotesQuoteComputedUpfrontLineItemsParamsSchema }) - async GetQuotesQuoteComputedUpfrontLineItems( + async getQuotesQuoteComputedUpfrontLineItems( params: stripe.GetQuotesQuoteComputedUpfrontLineItemsParams ): Promise { return this.ky @@ -68124,10 +66331,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'post_quotes_quote_finalize', - description: '

Finalizes the quote.

.', + description: `

Finalizes the quote.

.`, inputSchema: stripe.PostQuotesQuoteFinalizeParamsSchema }) - async PostQuotesQuoteFinalize( + async postQuotesQuoteFinalize( params: stripe.PostQuotesQuoteFinalizeParams ): Promise { return this.ky @@ -68140,11 +66347,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'get_quotes_quote_line_items', - description: - '

When retrieving a quote, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

.', + description: `

When retrieving a quote, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

.`, inputSchema: stripe.GetQuotesQuoteLineItemsParamsSchema }) - async GetQuotesQuoteLineItems( + async getQuotesQuoteLineItems( params: stripe.GetQuotesQuoteLineItemsParams ): Promise { return this.ky @@ -68161,11 +66367,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'get_quotes_quote_pdf', - description: - '

Download the PDF for a finalized quote. Explanation for special handling can be found here

.', + description: `

Download the PDF for a finalized quote. Explanation for special handling can be found here

.`, inputSchema: stripe.GetQuotesQuotePdfParamsSchema }) - async GetQuotesQuotePdf( + async getQuotesQuotePdf( params: stripe.GetQuotesQuotePdfParams ): Promise { return this.ky @@ -68180,15 +66385,26 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'get_radar_early_fraud_warnings', - description: '

Returns a list of early fraud warnings.

.', + description: `

Returns a list of early fraud warnings.

.`, inputSchema: stripe.GetRadarEarlyFraudWarningsParamsSchema }) - async GetRadarEarlyFraudWarnings( + async getRadarEarlyFraudWarnings( params: stripe.GetRadarEarlyFraudWarningsParams ): Promise { return this.ky .get('/v1/radar/early_fraud_warnings', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'charge', + 'created', + 'ending_before', + 'expand', + 'limit', + 'payment_intent', + 'starting_after' + ) + ) }) .json() } @@ -68205,7 +66421,7 @@ to an hour behind during outages. Search functionality is not available to merch

Please refer to the early fraud warning object reference for more details.

.`, inputSchema: stripe.GetRadarEarlyFraudWarningsEarlyFraudWarningParamsSchema }) - async GetRadarEarlyFraudWarningsEarlyFraudWarning( + async getRadarEarlyFraudWarningsEarlyFraudWarning( params: stripe.GetRadarEarlyFraudWarningsEarlyFraudWarningParams ): Promise { return this.ky @@ -68220,16 +66436,26 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'get_radar_value_list_items', - description: - '

Returns a list of ValueListItem objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

.', + description: `

Returns a list of ValueListItem objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

.`, inputSchema: stripe.GetRadarValueListItemsParamsSchema }) - async GetRadarValueListItems( + async getRadarValueListItems( params: stripe.GetRadarValueListItemsParams ): Promise { return this.ky .get('/v1/radar/value_list_items', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'created', + 'ending_before', + 'expand', + 'limit', + 'starting_after', + 'value', + 'value_list' + ) + ) }) .json() } @@ -68239,11 +66465,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'post_radar_value_list_items', - description: - '

Creates a new ValueListItem object, which is added to the specified parent value list.

.', + description: `

Creates a new ValueListItem object, which is added to the specified parent value list.

.`, inputSchema: stripe.PostRadarValueListItemsParamsSchema }) - async PostRadarValueListItems( + async postRadarValueListItems( _params: stripe.PostRadarValueListItemsParams ): Promise { return this.ky @@ -68256,10 +66481,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'get_radar_value_list_items_item', - description: '

Retrieves a ValueListItem object.

.', + description: `

Retrieves a ValueListItem object.

.`, inputSchema: stripe.GetRadarValueListItemsItemParamsSchema }) - async GetRadarValueListItemsItem( + async getRadarValueListItemsItem( params: stripe.GetRadarValueListItemsItemParams ): Promise { return this.ky @@ -68274,11 +66499,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'delete_radar_value_list_items_item', - description: - '

Deletes a ValueListItem object, removing it from its parent value list.

.', + description: `

Deletes a ValueListItem object, removing it from its parent value list.

.`, inputSchema: stripe.DeleteRadarValueListItemsItemParamsSchema }) - async DeleteRadarValueListItemsItem( + async deleteRadarValueListItemsItem( params: stripe.DeleteRadarValueListItemsItemParams ): Promise { return this.ky @@ -68291,16 +66515,26 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'get_radar_value_lists', - description: - '

Returns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

.', + description: `

Returns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

.`, inputSchema: stripe.GetRadarValueListsParamsSchema }) - async GetRadarValueLists( + async getRadarValueLists( params: stripe.GetRadarValueListsParams ): Promise { return this.ky .get('/v1/radar/value_lists', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'alias', + 'contains', + 'created', + 'ending_before', + 'expand', + 'limit', + 'starting_after' + ) + ) }) .json() } @@ -68310,11 +66544,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'post_radar_value_lists', - description: - '

Creates a new ValueList object, which can then be referenced in rules.

.', + description: `

Creates a new ValueList object, which can then be referenced in rules.

.`, inputSchema: stripe.PostRadarValueListsParamsSchema }) - async PostRadarValueLists( + async postRadarValueLists( _params: stripe.PostRadarValueListsParams ): Promise { return this.ky @@ -68327,10 +66560,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'get_radar_value_lists_value_list', - description: '

Retrieves a ValueList object.

.', + description: `

Retrieves a ValueList object.

.`, inputSchema: stripe.GetRadarValueListsValueListParamsSchema }) - async GetRadarValueListsValueList( + async getRadarValueListsValueList( params: stripe.GetRadarValueListsValueListParams ): Promise { return this.ky @@ -68345,11 +66578,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'post_radar_value_lists_value_list', - description: - '

Updates a ValueList object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that item_type is immutable.

.', + description: `

Updates a ValueList object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that item_type is immutable.

.`, inputSchema: stripe.PostRadarValueListsValueListParamsSchema }) - async PostRadarValueListsValueList( + async postRadarValueListsValueList( params: stripe.PostRadarValueListsValueListParams ): Promise { return this.ky @@ -68362,11 +66594,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'delete_radar_value_lists_value_list', - description: - '

Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.

.', + description: `

Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.

.`, inputSchema: stripe.DeleteRadarValueListsValueListParamsSchema }) - async DeleteRadarValueListsValueList( + async deleteRadarValueListsValueList( params: stripe.DeleteRadarValueListsValueListParams ): Promise { return this.ky @@ -68379,16 +66610,26 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'get_refunds', - description: - '

Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first. The 10 most recent refunds are always available by default on the Charge object.

.', + description: `

Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first. The 10 most recent refunds are always available by default on the Charge object.

.`, inputSchema: stripe.GetRefundsParamsSchema }) - async GetRefunds( + async getRefunds( params: stripe.GetRefundsParams ): Promise { return this.ky .get('/v1/refunds', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'charge', + 'created', + 'ending_before', + 'expand', + 'limit', + 'payment_intent', + 'starting_after' + ) + ) }) .json() } @@ -68421,7 +66662,7 @@ This method will raise an error when called on an already-refunded charge, or when trying to refund more money than is left on a charge.

.`, inputSchema: stripe.PostRefundsParamsSchema }) - async PostRefunds( + async postRefunds( _params: stripe.PostRefundsParams ): Promise { return this.ky.post('/v1/refunds').json() @@ -68432,10 +66673,10 @@ or when trying to refund more money than is left on a charge.

.`, */ @aiFunction({ name: 'get_refunds_refund', - description: '

Retrieves the details of an existing refund.

.', + description: `

Retrieves the details of an existing refund.

.`, inputSchema: stripe.GetRefundsRefundParamsSchema }) - async GetRefundsRefund( + async getRefundsRefund( params: stripe.GetRefundsRefundParams ): Promise { return this.ky @@ -68457,7 +66698,7 @@ or when trying to refund more money than is left on a charge.

.`,

This request only accepts metadata as an argument.

.`, inputSchema: stripe.PostRefundsRefundParamsSchema }) - async PostRefundsRefund( + async postRefundsRefund( params: stripe.PostRefundsRefundParams ): Promise { return this.ky @@ -68477,7 +66718,7 @@ or when trying to refund more money than is left on a charge.

.`,

You can’t cancel refunds in other states. Only refunds for payment methods that require customer action can enter the requires_action state.

.`, inputSchema: stripe.PostRefundsRefundCancelParamsSchema }) - async PostRefundsRefundCancel( + async postRefundsRefundCancel( params: stripe.PostRefundsRefundCancelParams ): Promise { return this.ky @@ -68490,16 +66731,24 @@ or when trying to refund more money than is left on a charge.

.`, */ @aiFunction({ name: 'get_reporting_report_runs', - description: - '

Returns a list of Report Runs, with the most recent appearing first.

.', + description: `

Returns a list of Report Runs, with the most recent appearing first.

.`, inputSchema: stripe.GetReportingReportRunsParamsSchema }) - async GetReportingReportRuns( + async getReportingReportRuns( params: stripe.GetReportingReportRunsParams ): Promise { return this.ky .get('/v1/reporting/report_runs', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'created', + 'ending_before', + 'expand', + 'limit', + 'starting_after' + ) + ) }) .json() } @@ -68509,11 +66758,10 @@ or when trying to refund more money than is left on a charge.

.`, */ @aiFunction({ name: 'post_reporting_report_runs', - description: - '

Creates a new object and begin running the report. (Certain report types require a live-mode API key.)

.', + description: `

Creates a new object and begin running the report. (Certain report types require a live-mode API key.)

.`, inputSchema: stripe.PostReportingReportRunsParamsSchema }) - async PostReportingReportRuns( + async postReportingReportRuns( _params: stripe.PostReportingReportRunsParams ): Promise { return this.ky @@ -68526,10 +66774,10 @@ or when trying to refund more money than is left on a charge.

.`, */ @aiFunction({ name: 'get_reporting_report_runs_report_run', - description: '

Retrieves the details of an existing Report Run.

.', + description: `

Retrieves the details of an existing Report Run.

.`, inputSchema: stripe.GetReportingReportRunsReportRunParamsSchema }) - async GetReportingReportRunsReportRun( + async getReportingReportRunsReportRun( params: stripe.GetReportingReportRunsReportRunParams ): Promise { return this.ky @@ -68544,10 +66792,10 @@ or when trying to refund more money than is left on a charge.

.`, */ @aiFunction({ name: 'get_reporting_report_types', - description: '

Returns a full list of Report Types.

.', + description: `

Returns a full list of Report Types.

.`, inputSchema: stripe.GetReportingReportTypesParamsSchema }) - async GetReportingReportTypes( + async getReportingReportTypes( params: stripe.GetReportingReportTypesParams ): Promise { return this.ky @@ -68562,11 +66810,10 @@ or when trying to refund more money than is left on a charge.

.`, */ @aiFunction({ name: 'get_reporting_report_types_report_type', - description: - '

Retrieves the details of a Report Type. (Certain report types require a live-mode API key.)

.', + description: `

Retrieves the details of a Report Type. (Certain report types require a live-mode API key.)

.`, inputSchema: stripe.GetReportingReportTypesReportTypeParamsSchema }) - async GetReportingReportTypesReportType( + async getReportingReportTypesReportType( params: stripe.GetReportingReportTypesReportTypeParams ): Promise { return this.ky @@ -68581,16 +66828,24 @@ or when trying to refund more money than is left on a charge.

.`, */ @aiFunction({ name: 'get_reviews', - description: - '

Returns a list of Review objects that have open set to true. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

.', + description: `

Returns a list of Review objects that have open set to true. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

.`, inputSchema: stripe.GetReviewsParamsSchema }) - async GetReviews( + async getReviews( params: stripe.GetReviewsParams ): Promise { return this.ky .get('/v1/reviews', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'created', + 'ending_before', + 'expand', + 'limit', + 'starting_after' + ) + ) }) .json() } @@ -68600,10 +66855,10 @@ or when trying to refund more money than is left on a charge.

.`, */ @aiFunction({ name: 'get_reviews_review', - description: '

Retrieves a Review object.

.', + description: `

Retrieves a Review object.

.`, inputSchema: stripe.GetReviewsReviewParamsSchema }) - async GetReviewsReview( + async getReviewsReview( params: stripe.GetReviewsReviewParams ): Promise { return this.ky @@ -68618,11 +66873,10 @@ or when trying to refund more money than is left on a charge.

.`, */ @aiFunction({ name: 'post_reviews_review_approve', - description: - '

Approves a Review object, closing it and removing it from the list of reviews.

.', + description: `

Approves a Review object, closing it and removing it from the list of reviews.

.`, inputSchema: stripe.PostReviewsReviewApproveParamsSchema }) - async PostReviewsReviewApprove( + async postReviewsReviewApprove( params: stripe.PostReviewsReviewApproveParams ): Promise { return this.ky @@ -68635,16 +66889,25 @@ or when trying to refund more money than is left on a charge.

.`, */ @aiFunction({ name: 'get_setup_attempts', - description: - '

Returns a list of SetupAttempts that associate with a provided SetupIntent.

.', + description: `

Returns a list of SetupAttempts that associate with a provided SetupIntent.

.`, inputSchema: stripe.GetSetupAttemptsParamsSchema }) - async GetSetupAttempts( + async getSetupAttempts( params: stripe.GetSetupAttemptsParams ): Promise { return this.ky .get('/v1/setup_attempts', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'created', + 'ending_before', + 'expand', + 'limit', + 'setup_intent', + 'starting_after' + ) + ) }) .json() } @@ -68654,15 +66917,27 @@ or when trying to refund more money than is left on a charge.

.`, */ @aiFunction({ name: 'get_setup_intents', - description: '

Returns a list of SetupIntents.

.', + description: `

Returns a list of SetupIntents.

.`, inputSchema: stripe.GetSetupIntentsParamsSchema }) - async GetSetupIntents( + async getSetupIntents( params: stripe.GetSetupIntentsParams ): Promise { return this.ky .get('/v1/setup_intents', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'attach_to_self', + 'created', + 'customer', + 'ending_before', + 'expand', + 'limit', + 'payment_method', + 'starting_after' + ) + ) }) .json() } @@ -68681,7 +66956,7 @@ it to collect any required permissions to charge the payment method later.

. it to collect any required permissions to charge the payment method later.

.`, inputSchema: stripe.PostSetupIntentsParamsSchema }) - async PostSetupIntents( + async postSetupIntents( _params: stripe.PostSetupIntentsParams ): Promise { return this.ky @@ -68705,7 +66980,7 @@ it to collect any required permissions to charge the payment method later.

.`

When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the SetupIntent object reference for more details.

.`, inputSchema: stripe.GetSetupIntentsIntentParamsSchema }) - async GetSetupIntentsIntent( + async getSetupIntentsIntent( params: stripe.GetSetupIntentsIntentParams ): Promise { return this.ky @@ -68722,10 +66997,10 @@ it to collect any required permissions to charge the payment method later.

.` */ @aiFunction({ name: 'post_setup_intents_intent', - description: '

Updates a SetupIntent object.

.', + description: `

Updates a SetupIntent object.

.`, inputSchema: stripe.PostSetupIntentsIntentParamsSchema }) - async PostSetupIntentsIntent( + async postSetupIntentsIntent( params: stripe.PostSetupIntentsIntentParams ): Promise { return this.ky @@ -68745,7 +67020,7 @@ it to collect any required permissions to charge the payment method later.

.`

After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can’t cancel the SetupIntent for a Checkout Session. Expire the Checkout Session instead.

.`, inputSchema: stripe.PostSetupIntentsIntentCancelParamsSchema }) - async PostSetupIntentsIntentCancel( + async postSetupIntentsIntentCancel( params: stripe.PostSetupIntentsIntentCancelParams ): Promise { return this.ky @@ -68787,7 +67062,7 @@ the SetupIntent will transition to the confirmation limit is reached.

.`, inputSchema: stripe.PostSetupIntentsIntentConfirmParamsSchema }) - async PostSetupIntentsIntentConfirm( + async postSetupIntentsIntentConfirm( params: stripe.PostSetupIntentsIntentConfirmParams ): Promise { return this.ky @@ -68800,10 +67075,10 @@ confirmation limit is reached.

.`, */ @aiFunction({ name: 'post_setup_intents_intent_verify_microdeposits', - description: '

Verifies microdeposits on a SetupIntent object.

.', + description: `

Verifies microdeposits on a SetupIntent object.

.`, inputSchema: stripe.PostSetupIntentsIntentVerifyMicrodepositsParamsSchema }) - async PostSetupIntentsIntentVerifyMicrodeposits( + async postSetupIntentsIntentVerifyMicrodeposits( params: stripe.PostSetupIntentsIntentVerifyMicrodepositsParams ): Promise { return this.ky @@ -68816,15 +67091,26 @@ confirmation limit is reached.

.`, */ @aiFunction({ name: 'get_shipping_rates', - description: '

Returns a list of your shipping rates.

.', + description: `

Returns a list of your shipping rates.

.`, inputSchema: stripe.GetShippingRatesParamsSchema }) - async GetShippingRates( + async getShippingRates( params: stripe.GetShippingRatesParams ): Promise { return this.ky .get('/v1/shipping_rates', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'active', + 'created', + 'currency', + 'ending_before', + 'expand', + 'limit', + 'starting_after' + ) + ) }) .json() } @@ -68834,10 +67120,10 @@ confirmation limit is reached.

.`, */ @aiFunction({ name: 'post_shipping_rates', - description: '

Creates a new shipping rate object.

.', + description: `

Creates a new shipping rate object.

.`, inputSchema: stripe.PostShippingRatesParamsSchema }) - async PostShippingRates( + async postShippingRates( _params: stripe.PostShippingRatesParams ): Promise { return this.ky @@ -68850,10 +67136,10 @@ confirmation limit is reached.

.`, */ @aiFunction({ name: 'get_shipping_rates_shipping_rate_token', - description: '

Returns the shipping rate object with the given ID.

.', + description: `

Returns the shipping rate object with the given ID.

.`, inputSchema: stripe.GetShippingRatesShippingRateTokenParamsSchema }) - async GetShippingRatesShippingRateToken( + async getShippingRatesShippingRateToken( params: stripe.GetShippingRatesShippingRateTokenParams ): Promise { return this.ky @@ -68868,10 +67154,10 @@ confirmation limit is reached.

.`, */ @aiFunction({ name: 'post_shipping_rates_shipping_rate_token', - description: '

Updates an existing shipping rate object.

.', + description: `

Updates an existing shipping rate object.

.`, inputSchema: stripe.PostShippingRatesShippingRateTokenParamsSchema }) - async PostShippingRatesShippingRateToken( + async postShippingRatesShippingRateToken( params: stripe.PostShippingRatesShippingRateTokenParams ): Promise { return this.ky @@ -68884,15 +67170,17 @@ confirmation limit is reached.

.`, */ @aiFunction({ name: 'get_sigma_scheduled_query_runs', - description: '

Returns a list of scheduled query runs.

.', + description: `

Returns a list of scheduled query runs.

.`, inputSchema: stripe.GetSigmaScheduledQueryRunsParamsSchema }) - async GetSigmaScheduledQueryRuns( + async getSigmaScheduledQueryRuns( params: stripe.GetSigmaScheduledQueryRunsParams ): Promise { return this.ky .get('/v1/sigma/scheduled_query_runs', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick(params, 'ending_before', 'expand', 'limit', 'starting_after') + ) }) .json() } @@ -68902,10 +67190,10 @@ confirmation limit is reached.

.`, */ @aiFunction({ name: 'get_sigma_scheduled_query_runs_scheduled_query_run', - description: '

Retrieves the details of an scheduled query run.

.', + description: `

Retrieves the details of an scheduled query run.

.`, inputSchema: stripe.GetSigmaScheduledQueryRunsScheduledQueryRunParamsSchema }) - async GetSigmaScheduledQueryRunsScheduledQueryRun( + async getSigmaScheduledQueryRunsScheduledQueryRun( params: stripe.GetSigmaScheduledQueryRunsScheduledQueryRunParams ): Promise { return this.ky @@ -68920,10 +67208,10 @@ confirmation limit is reached.

.`, */ @aiFunction({ name: 'post_sources', - description: '

Creates a new source object.

.', + description: `

Creates a new source object.

.`, inputSchema: stripe.PostSourcesParamsSchema }) - async PostSources( + async postSources( _params: stripe.PostSourcesParams ): Promise { return this.ky.post('/v1/sources').json() @@ -68934,11 +67222,10 @@ confirmation limit is reached.

.`, */ @aiFunction({ name: 'get_sources_source', - description: - '

Retrieves an existing source object. Supply the unique source ID from a source creation request and Stripe will return the corresponding up-to-date source object information.

.', + description: `

Retrieves an existing source object. Supply the unique source ID from a source creation request and Stripe will return the corresponding up-to-date source object information.

.`, inputSchema: stripe.GetSourcesSourceParamsSchema }) - async GetSourcesSource( + async getSourcesSource( params: stripe.GetSourcesSourceParams ): Promise { return this.ky @@ -68962,7 +67249,7 @@ confirmation limit is reached.

.`,

This request accepts the metadata and owner as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our payment method guides for more detail.

.`, inputSchema: stripe.PostSourcesSourceParamsSchema }) - async PostSourcesSource( + async postSourcesSource( params: stripe.PostSourcesSourceParams ): Promise { return this.ky @@ -68975,11 +67262,11 @@ confirmation limit is reached.

.`, */ @aiFunction({ name: 'get_sources_source_mandate_notifications_mandate_notification', - description: '

Retrieves a new Source MandateNotification.

.', + description: `

Retrieves a new Source MandateNotification.

.`, inputSchema: stripe.GetSourcesSourceMandateNotificationsMandateNotificationParamsSchema }) - async GetSourcesSourceMandateNotificationsMandateNotification( + async getSourcesSourceMandateNotificationsMandateNotification( params: stripe.GetSourcesSourceMandateNotificationsMandateNotificationParams ): Promise { return this.ky @@ -68997,10 +67284,10 @@ confirmation limit is reached.

.`, */ @aiFunction({ name: 'get_sources_source_source_transactions', - description: '

List source transactions for a given source.

.', + description: `

List source transactions for a given source.

.`, inputSchema: stripe.GetSourcesSourceSourceTransactionsParamsSchema }) - async GetSourcesSourceSourceTransactions( + async getSourcesSourceSourceTransactions( params: stripe.GetSourcesSourceSourceTransactionsParams ): Promise { return this.ky @@ -69017,12 +67304,11 @@ confirmation limit is reached.

.`, */ @aiFunction({ name: 'get_sources_source_source_transactions_source_transaction', - description: - '

Retrieve an existing source transaction object. Supply the unique source ID from a source creation request and the source transaction ID and Stripe will return the corresponding up-to-date source object information.

.', + description: `

Retrieve an existing source transaction object. Supply the unique source ID from a source creation request and the source transaction ID and Stripe will return the corresponding up-to-date source object information.

.`, inputSchema: stripe.GetSourcesSourceSourceTransactionsSourceTransactionParamsSchema }) - async GetSourcesSourceSourceTransactionsSourceTransaction( + async getSourcesSourceSourceTransactionsSourceTransaction( params: stripe.GetSourcesSourceSourceTransactionsSourceTransactionParams ): Promise { return this.ky @@ -69040,10 +67326,10 @@ confirmation limit is reached.

.`, */ @aiFunction({ name: 'post_sources_source_verify', - description: '

Verify a given source.

.', + description: `

Verify a given source.

.`, inputSchema: stripe.PostSourcesSourceVerifyParamsSchema }) - async PostSourcesSourceVerify( + async postSourcesSourceVerify( params: stripe.PostSourcesSourceVerifyParams ): Promise { return this.ky @@ -69056,16 +67342,24 @@ confirmation limit is reached.

.`, */ @aiFunction({ name: 'get_subscription_items', - description: - '

Returns a list of your subscription items for a given subscription.

.', + description: `

Returns a list of your subscription items for a given subscription.

.`, inputSchema: stripe.GetSubscriptionItemsParamsSchema }) - async GetSubscriptionItems( + async getSubscriptionItems( params: stripe.GetSubscriptionItemsParams ): Promise { return this.ky .get('/v1/subscription_items', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'ending_before', + 'expand', + 'limit', + 'starting_after', + 'subscription' + ) + ) }) .json() } @@ -69075,11 +67369,10 @@ confirmation limit is reached.

.`, */ @aiFunction({ name: 'post_subscription_items', - description: - '

Adds a new item to an existing subscription. No existing items will be changed or replaced.

.', + description: `

Adds a new item to an existing subscription. No existing items will be changed or replaced.

.`, inputSchema: stripe.PostSubscriptionItemsParamsSchema }) - async PostSubscriptionItems( + async postSubscriptionItems( _params: stripe.PostSubscriptionItemsParams ): Promise { return this.ky @@ -69092,10 +67385,10 @@ confirmation limit is reached.

.`, */ @aiFunction({ name: 'get_subscription_items_item', - description: '

Retrieves the subscription item with the given ID.

.', + description: `

Retrieves the subscription item with the given ID.

.`, inputSchema: stripe.GetSubscriptionItemsItemParamsSchema }) - async GetSubscriptionItemsItem( + async getSubscriptionItemsItem( params: stripe.GetSubscriptionItemsItemParams ): Promise { return this.ky @@ -69110,11 +67403,10 @@ confirmation limit is reached.

.`, */ @aiFunction({ name: 'post_subscription_items_item', - description: - '

Updates the plan or quantity of an item on a current subscription.

.', + description: `

Updates the plan or quantity of an item on a current subscription.

.`, inputSchema: stripe.PostSubscriptionItemsItemParamsSchema }) - async PostSubscriptionItemsItem( + async postSubscriptionItemsItem( params: stripe.PostSubscriptionItemsItemParams ): Promise { return this.ky @@ -69127,11 +67419,10 @@ confirmation limit is reached.

.`, */ @aiFunction({ name: 'delete_subscription_items_item', - description: - '

Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.

.', + description: `

Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription.

.`, inputSchema: stripe.DeleteSubscriptionItemsItemParamsSchema }) - async DeleteSubscriptionItemsItem( + async deleteSubscriptionItemsItem( params: stripe.DeleteSubscriptionItemsItemParams ): Promise { return this.ky @@ -69152,7 +67443,7 @@ confirmation limit is reached.

.`, inputSchema: stripe.GetSubscriptionItemsSubscriptionItemUsageRecordSummariesParamsSchema }) - async GetSubscriptionItemsSubscriptionItemUsageRecordSummaries( + async getSubscriptionItemsSubscriptionItemUsageRecordSummaries( params: stripe.GetSubscriptionItemsSubscriptionItemUsageRecordSummariesParams ): Promise { return this.ky @@ -69188,7 +67479,7 @@ confirmation limit is reached.

.`, inputSchema: stripe.PostSubscriptionItemsSubscriptionItemUsageRecordsParamsSchema }) - async PostSubscriptionItemsSubscriptionItemUsageRecords( + async postSubscriptionItemsSubscriptionItemUsageRecords( params: stripe.PostSubscriptionItemsSubscriptionItemUsageRecordsParams ): Promise { return this.ky @@ -69203,15 +67494,29 @@ confirmation limit is reached.

.`, */ @aiFunction({ name: 'get_subscription_schedules', - description: '

Retrieves the list of your subscription schedules.

.', + description: `

Retrieves the list of your subscription schedules.

.`, inputSchema: stripe.GetSubscriptionSchedulesParamsSchema }) - async GetSubscriptionSchedules( + async getSubscriptionSchedules( params: stripe.GetSubscriptionSchedulesParams ): Promise { return this.ky .get('/v1/subscription_schedules', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'canceled_at', + 'completed_at', + 'created', + 'customer', + 'ending_before', + 'expand', + 'limit', + 'released_at', + 'scheduled', + 'starting_after' + ) + ) }) .json() } @@ -69221,11 +67526,10 @@ confirmation limit is reached.

.`, */ @aiFunction({ name: 'post_subscription_schedules', - description: - '

Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.

.', + description: `

Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions.

.`, inputSchema: stripe.PostSubscriptionSchedulesParamsSchema }) - async PostSubscriptionSchedules( + async postSubscriptionSchedules( _params: stripe.PostSubscriptionSchedulesParams ): Promise { return this.ky @@ -69238,11 +67542,10 @@ confirmation limit is reached.

.`, */ @aiFunction({ name: 'get_subscription_schedules_schedule', - description: - '

Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.

.', + description: `

Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.

.`, inputSchema: stripe.GetSubscriptionSchedulesScheduleParamsSchema }) - async GetSubscriptionSchedulesSchedule( + async getSubscriptionSchedulesSchedule( params: stripe.GetSubscriptionSchedulesScheduleParams ): Promise { return this.ky @@ -69257,10 +67560,10 @@ confirmation limit is reached.

.`, */ @aiFunction({ name: 'post_subscription_schedules_schedule', - description: '

Updates an existing subscription schedule.

.', + description: `

Updates an existing subscription schedule.

.`, inputSchema: stripe.PostSubscriptionSchedulesScheduleParamsSchema }) - async PostSubscriptionSchedulesSchedule( + async postSubscriptionSchedulesSchedule( params: stripe.PostSubscriptionSchedulesScheduleParams ): Promise { return this.ky @@ -69273,11 +67576,10 @@ confirmation limit is reached.

.`, */ @aiFunction({ name: 'post_subscription_schedules_schedule_cancel', - description: - '

Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.

.', + description: `

Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.

.`, inputSchema: stripe.PostSubscriptionSchedulesScheduleCancelParamsSchema }) - async PostSubscriptionSchedulesScheduleCancel( + async postSubscriptionSchedulesScheduleCancel( params: stripe.PostSubscriptionSchedulesScheduleCancelParams ): Promise { return this.ky @@ -69290,11 +67592,10 @@ confirmation limit is reached.

.`, */ @aiFunction({ name: 'post_subscription_schedules_schedule_release', - description: - '

Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription’s ID to the released_subscription property.

.', + description: `

Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription’s ID to the released_subscription property.

.`, inputSchema: stripe.PostSubscriptionSchedulesScheduleReleaseParamsSchema }) - async PostSubscriptionSchedulesScheduleRelease( + async postSubscriptionSchedulesScheduleRelease( params: stripe.PostSubscriptionSchedulesScheduleReleaseParams ): Promise { return this.ky @@ -69307,16 +67608,32 @@ confirmation limit is reached.

.`, */ @aiFunction({ name: 'get_subscriptions', - description: - '

By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.

.', + description: `

By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.

.`, inputSchema: stripe.GetSubscriptionsParamsSchema }) - async GetSubscriptions( + async getSubscriptions( params: stripe.GetSubscriptionsParams ): Promise { return this.ky .get('/v1/subscriptions', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'automatic_tax', + 'collection_method', + 'created', + 'current_period_end', + 'current_period_start', + 'customer', + 'ending_before', + 'expand', + 'limit', + 'price', + 'starting_after', + 'status', + 'test_clock' + ) + ) }) .json() } @@ -69341,7 +67658,7 @@ The payment_behavior parameter determines the exact behavior of the Schedules provide the flexibility to model more complex billing configurations that change over time.

.`, inputSchema: stripe.PostSubscriptionsParamsSchema }) - async PostSubscriptions( + async postSubscriptions( _params: stripe.PostSubscriptionsParams ): Promise { return this.ky @@ -69363,12 +67680,14 @@ conditions, data is searchable in less than a minute. Occasionally, propagation to an hour behind during outages. Search functionality is not available to merchants in India.

.`, inputSchema: stripe.GetSubscriptionsSearchParamsSchema }) - async GetSubscriptionsSearch( + async getSubscriptionsSearch( params: stripe.GetSubscriptionsSearchParams ): Promise { return this.ky .get('/v1/subscriptions/search', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick(params, 'expand', 'limit', 'page', 'query') + ) }) .json() } @@ -69378,10 +67697,10 @@ to an hour behind during outages. Search functionality is not available to merch */ @aiFunction({ name: 'get_subscriptions_subscription_exposed_id', - description: '

Retrieves the subscription with the given ID.

.', + description: `

Retrieves the subscription with the given ID.

.`, inputSchema: stripe.GetSubscriptionsSubscriptionExposedIdParamsSchema }) - async GetSubscriptionsSubscriptionExposedId( + async getSubscriptionsSubscriptionExposedId( params: stripe.GetSubscriptionsSubscriptionExposedIdParams ): Promise { return this.ky @@ -69439,7 +67758,7 @@ To preview how the proration is calculated, use the rate limiting. If you need to bill for a frequently changing quantity, consider integrating usage-based billing instead.

.`, inputSchema: stripe.PostSubscriptionsSubscriptionExposedIdParamsSchema }) - async PostSubscriptionsSubscriptionExposedId( + async postSubscriptionsSubscriptionExposedId( params: stripe.PostSubscriptionsSubscriptionExposedIdParams ): Promise { return this.ky @@ -69463,7 +67782,7 @@ To preview how the proration is calculated, use the Removes the currently applied discount on a subscription.

.', + description: `

Removes the currently applied discount on a subscription.

.`, inputSchema: stripe.DeleteSubscriptionsSubscriptionExposedIdDiscountParamsSchema }) - async DeleteSubscriptionsSubscriptionExposedIdDiscount( + async deleteSubscriptionsSubscriptionExposedIdDiscount( params: stripe.DeleteSubscriptionsSubscriptionExposedIdDiscountParams ): Promise { return this.ky @@ -69494,11 +67812,10 @@ To preview how the proration is calculated, use the Calculates tax based on the input and returns a Tax Calculation object.

.', + description: `

Calculates tax based on the input and returns a Tax Calculation object.

.`, inputSchema: stripe.PostTaxCalculationsParamsSchema }) - async PostTaxCalculations( + async postTaxCalculations( _params: stripe.PostTaxCalculationsParams ): Promise { return this.ky @@ -69528,11 +67844,10 @@ To preview how the proration is calculated, use the Retrieves the line items of a tax calculation as a collection, if the calculation hasn’t expired.

.', + description: `

Retrieves the line items of a tax calculation as a collection, if the calculation hasn’t expired.

.`, inputSchema: stripe.GetTaxCalculationsCalculationLineItemsParamsSchema }) - async GetTaxCalculationsCalculationLineItems( + async getTaxCalculationsCalculationLineItems( params: stripe.GetTaxCalculationsCalculationLineItemsParams ): Promise { return this.ky @@ -69568,16 +67882,24 @@ To preview how the proration is calculated, use the Creates a new Tax Registration object.

.', + description: `

Creates a new Tax Registration object.

.`, inputSchema: stripe.PostTaxRegistrationsParamsSchema }) - async PostTaxRegistrations( + async postTaxRegistrations( _params: stripe.PostTaxRegistrationsParams ): Promise { return this.ky @@ -69603,10 +67925,10 @@ To preview how the proration is calculated, use the A registration cannot be deleted after it has been created. If you wish to end a registration you may do so by setting expires_at.

.`, inputSchema: stripe.PostTaxRegistrationsIdParamsSchema }) - async PostTaxRegistrationsId( + async postTaxRegistrationsId( params: stripe.PostTaxRegistrationsIdParams ): Promise { return this.ky @@ -69641,10 +67963,10 @@ To preview how the proration is calculated, use the Updates Tax Settings parameters used in tax calculations. All parameters are editable but none can be removed once set.

.', + description: `

Updates Tax Settings parameters used in tax calculations. All parameters are editable but none can be removed once set.

.`, inputSchema: stripe.PostTaxSettingsParamsSchema }) - async PostTaxSettings( + async postTaxSettings( _params: stripe.PostTaxSettingsParams ): Promise { return this.ky @@ -69676,11 +67997,10 @@ To preview how the proration is calculated, use the Partially or fully reverses a previously created Transaction.

.', + description: `

Partially or fully reverses a previously created Transaction.

.`, inputSchema: stripe.PostTaxTransactionsCreateReversalParamsSchema }) - async PostTaxTransactionsCreateReversal( + async postTaxTransactionsCreateReversal( _params: stripe.PostTaxTransactionsCreateReversalParams ): Promise { return this.ky @@ -69710,10 +68029,10 @@ To preview how the proration is calculated, use the Retrieves the line items of a committed standalone transaction as a collection.

.', + description: `

Retrieves the line items of a committed standalone transaction as a collection.

.`, inputSchema: stripe.GetTaxTransactionsTransactionLineItemsParamsSchema }) - async GetTaxTransactionsTransactionLineItems( + async getTaxTransactionsTransactionLineItems( params: stripe.GetTaxTransactionsTransactionLineItemsParams ): Promise { return this.ky @@ -69749,16 +68067,17 @@ To preview how the proration is calculated, use the all tax codes available to add to Products in order to allow specific tax calculations.

.', + description: `

A list of all tax codes available to add to Products in order to allow specific tax calculations.

.`, inputSchema: stripe.GetTaxCodesParamsSchema }) - async GetTaxCodes( + async getTaxCodes( params: stripe.GetTaxCodesParams ): Promise { return this.ky .get('/v1/tax_codes', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick(params, 'ending_before', 'expand', 'limit', 'starting_after') + ) }) .json() } @@ -69768,11 +68087,10 @@ To preview how the proration is calculated, use the Returns a list of tax IDs.

.', + description: `

Returns a list of tax IDs.

.`, inputSchema: stripe.GetTaxIdsParamsSchema }) - async GetTaxIds( + async getTaxIds( params: stripe.GetTaxIdsParams ): Promise { return this.ky .get('/v1/tax_ids', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'ending_before', + 'expand', + 'limit', + 'owner', + 'starting_after' + ) + ) }) .json() } @@ -69805,11 +68132,10 @@ To preview how the proration is calculated, use the Retrieves an account or customer tax_id object.

.', + description: `

Retrieves an account or customer tax_id object.

.`, inputSchema: stripe.GetTaxIdsIdParamsSchema }) - async GetTaxIdsId( + async getTaxIdsId( params: stripe.GetTaxIdsIdParams ): Promise { return this.ky @@ -69839,11 +68164,10 @@ To preview how the proration is calculated, use the Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.

.', + description: `

Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.

.`, inputSchema: stripe.GetTaxRatesParamsSchema }) - async GetTaxRates( + async getTaxRates( params: stripe.GetTaxRatesParams ): Promise { return this.ky .get('/v1/tax_rates', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'active', + 'created', + 'ending_before', + 'expand', + 'inclusive', + 'limit', + 'starting_after' + ) + ) }) .json() } @@ -69875,10 +68209,10 @@ To preview how the proration is calculated, use the Retrieves a tax rate with the given ID

.', + description: `

Retrieves a tax rate with the given ID

.`, inputSchema: stripe.GetTaxRatesTaxRateParamsSchema }) - async GetTaxRatesTaxRate( + async getTaxRatesTaxRate( params: stripe.GetTaxRatesTaxRateParams ): Promise { return this.ky @@ -69907,10 +68241,10 @@ To preview how the proration is calculated, use the Returns a list of Configuration objects.

.', + description: `

Returns a list of Configuration objects.

.`, inputSchema: stripe.GetTerminalConfigurationsParamsSchema }) - async GetTerminalConfigurations( + async getTerminalConfigurations( params: stripe.GetTerminalConfigurationsParams ): Promise { return this.ky .get('/v1/terminal/configurations', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'ending_before', + 'expand', + 'is_account_default', + 'limit', + 'starting_after' + ) + ) }) .json() } @@ -69942,10 +68284,10 @@ To preview how the proration is calculated, use the Retrieves a Configuration object.

.', + description: `

Retrieves a Configuration object.

.`, inputSchema: stripe.GetTerminalConfigurationsConfigurationParamsSchema }) - async GetTerminalConfigurationsConfiguration( + async getTerminalConfigurationsConfiguration( params: stripe.GetTerminalConfigurationsConfigurationParams ): Promise { return this.ky @@ -69976,10 +68318,10 @@ To preview how the proration is calculated, use the Deletes a Configuration object.

.', + description: `

Deletes a Configuration object.

.`, inputSchema: stripe.DeleteTerminalConfigurationsConfigurationParamsSchema }) - async DeleteTerminalConfigurationsConfiguration( + async deleteTerminalConfigurationsConfiguration( params: stripe.DeleteTerminalConfigurationsConfigurationParams ): Promise { return this.ky @@ -70008,11 +68350,10 @@ To preview how the proration is calculated, use the Returns a list of Location objects.

.', + description: `

Returns a list of Location objects.

.`, inputSchema: stripe.GetTerminalLocationsParamsSchema }) - async GetTerminalLocations( + async getTerminalLocations( params: stripe.GetTerminalLocationsParams ): Promise { return this.ky .get('/v1/terminal/locations', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick(params, 'ending_before', 'expand', 'limit', 'starting_after') + ) }) .json() } @@ -70048,7 +68391,7 @@ For further details, including which address fields are required in each country For further details, including which address fields are required in each country, see the Manage locations guide.

.`, inputSchema: stripe.PostTerminalLocationsParamsSchema }) - async PostTerminalLocations( + async postTerminalLocations( _params: stripe.PostTerminalLocationsParams ): Promise { return this.ky @@ -70061,10 +68404,10 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'get_terminal_locations_location', - description: '

Retrieves a Location object.

.', + description: `

Retrieves a Location object.

.`, inputSchema: stripe.GetTerminalLocationsLocationParamsSchema }) - async GetTerminalLocationsLocation( + async getTerminalLocationsLocation( params: stripe.GetTerminalLocationsLocationParams ): Promise { return this.ky @@ -70079,11 +68422,10 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_terminal_locations_location', - description: - '

Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

.', + description: `

Updates a Location object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

.`, inputSchema: stripe.PostTerminalLocationsLocationParamsSchema }) - async PostTerminalLocationsLocation( + async postTerminalLocationsLocation( params: stripe.PostTerminalLocationsLocationParams ): Promise { return this.ky @@ -70096,10 +68438,10 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'delete_terminal_locations_location', - description: '

Deletes a Location object.

.', + description: `

Deletes a Location object.

.`, inputSchema: stripe.DeleteTerminalLocationsLocationParamsSchema }) - async DeleteTerminalLocationsLocation( + async deleteTerminalLocationsLocation( params: stripe.DeleteTerminalLocationsLocationParams ): Promise { return this.ky @@ -70112,15 +68454,27 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'get_terminal_readers', - description: '

Returns a list of Reader objects.

.', + description: `

Returns a list of Reader objects.

.`, inputSchema: stripe.GetTerminalReadersParamsSchema }) - async GetTerminalReaders( + async getTerminalReaders( params: stripe.GetTerminalReadersParams ): Promise { return this.ky .get('/v1/terminal/readers', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'device_type', + 'ending_before', + 'expand', + 'limit', + 'location', + 'serial_number', + 'starting_after', + 'status' + ) + ) }) .json() } @@ -70130,10 +68484,10 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_terminal_readers', - description: '

Creates a new Reader object.

.', + description: `

Creates a new Reader object.

.`, inputSchema: stripe.PostTerminalReadersParamsSchema }) - async PostTerminalReaders( + async postTerminalReaders( _params: stripe.PostTerminalReadersParams ): Promise { return this.ky @@ -70146,10 +68500,10 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'get_terminal_readers_reader', - description: '

Retrieves a Reader object.

.', + description: `

Retrieves a Reader object.

.`, inputSchema: stripe.GetTerminalReadersReaderParamsSchema }) - async GetTerminalReadersReader( + async getTerminalReadersReader( params: stripe.GetTerminalReadersReaderParams ): Promise { return this.ky @@ -70164,11 +68518,10 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_terminal_readers_reader', - description: - '

Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

.', + description: `

Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

.`, inputSchema: stripe.PostTerminalReadersReaderParamsSchema }) - async PostTerminalReadersReader( + async postTerminalReadersReader( params: stripe.PostTerminalReadersReaderParams ): Promise { return this.ky @@ -70181,10 +68534,10 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'delete_terminal_readers_reader', - description: '

Deletes a Reader object.

.', + description: `

Deletes a Reader object.

.`, inputSchema: stripe.DeleteTerminalReadersReaderParamsSchema }) - async DeleteTerminalReadersReader( + async deleteTerminalReadersReader( params: stripe.DeleteTerminalReadersReaderParams ): Promise { return this.ky @@ -70197,10 +68550,10 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_terminal_readers_reader_cancel_action', - description: '

Cancels the current reader action.

.', + description: `

Cancels the current reader action.

.`, inputSchema: stripe.PostTerminalReadersReaderCancelActionParamsSchema }) - async PostTerminalReadersReaderCancelAction( + async postTerminalReadersReaderCancelAction( params: stripe.PostTerminalReadersReaderCancelActionParams ): Promise { return this.ky @@ -70213,11 +68566,11 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_terminal_readers_reader_process_payment_intent', - description: '

Initiates a payment flow on a Reader.

.', + description: `

Initiates a payment flow on a Reader.

.`, inputSchema: stripe.PostTerminalReadersReaderProcessPaymentIntentParamsSchema }) - async PostTerminalReadersReaderProcessPaymentIntent( + async postTerminalReadersReaderProcessPaymentIntent( params: stripe.PostTerminalReadersReaderProcessPaymentIntentParams ): Promise { return this.ky @@ -70230,10 +68583,10 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_terminal_readers_reader_process_setup_intent', - description: '

Initiates a setup intent flow on a Reader.

.', + description: `

Initiates a setup intent flow on a Reader.

.`, inputSchema: stripe.PostTerminalReadersReaderProcessSetupIntentParamsSchema }) - async PostTerminalReadersReaderProcessSetupIntent( + async postTerminalReadersReaderProcessSetupIntent( params: stripe.PostTerminalReadersReaderProcessSetupIntentParams ): Promise { return this.ky @@ -70246,10 +68599,10 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_terminal_readers_reader_refund_payment', - description: '

Initiates a refund on a Reader

.', + description: `

Initiates a refund on a Reader

.`, inputSchema: stripe.PostTerminalReadersReaderRefundPaymentParamsSchema }) - async PostTerminalReadersReaderRefundPayment( + async postTerminalReadersReaderRefundPayment( params: stripe.PostTerminalReadersReaderRefundPaymentParams ): Promise { return this.ky @@ -70262,10 +68615,10 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_terminal_readers_reader_set_reader_display', - description: '

Sets reader display to show cart details.

.', + description: `

Sets reader display to show cart details.

.`, inputSchema: stripe.PostTerminalReadersReaderSetReaderDisplayParamsSchema }) - async PostTerminalReadersReaderSetReaderDisplay( + async postTerminalReadersReaderSetReaderDisplay( params: stripe.PostTerminalReadersReaderSetReaderDisplayParams ): Promise { return this.ky @@ -70278,11 +68631,10 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_confirmation_tokens', - description: - '

Creates a test mode Confirmation Token server side for your integration tests.

.', + description: `

Creates a test mode Confirmation Token server side for your integration tests.

.`, inputSchema: stripe.PostTestHelpersConfirmationTokensParamsSchema }) - async PostTestHelpersConfirmationTokens( + async postTestHelpersConfirmationTokens( _params: stripe.PostTestHelpersConfirmationTokensParams ): Promise { return this.ky @@ -70295,11 +68647,11 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_customers_customer_fund_cash_balance', - description: '

Create an incoming testmode bank transfer

.', + description: `

Create an incoming testmode bank transfer

.`, inputSchema: stripe.PostTestHelpersCustomersCustomerFundCashBalanceParamsSchema }) - async PostTestHelpersCustomersCustomerFundCashBalance( + async postTestHelpersCustomersCustomerFundCashBalance( params: stripe.PostTestHelpersCustomersCustomerFundCashBalanceParams ): Promise { return this.ky @@ -70314,10 +68666,10 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_issuing_authorizations', - description: '

Create a test-mode authorization.

.', + description: `

Create a test-mode authorization.

.`, inputSchema: stripe.PostTestHelpersIssuingAuthorizationsParamsSchema }) - async PostTestHelpersIssuingAuthorizations( + async postTestHelpersIssuingAuthorizations( _params: stripe.PostTestHelpersIssuingAuthorizationsParams ): Promise { return this.ky @@ -70330,11 +68682,11 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_issuing_authorizations_authorization_capture', - description: '

Capture a test-mode authorization.

.', + description: `

Capture a test-mode authorization.

.`, inputSchema: stripe.PostTestHelpersIssuingAuthorizationsAuthorizationCaptureParamsSchema }) - async PostTestHelpersIssuingAuthorizationsAuthorizationCapture( + async postTestHelpersIssuingAuthorizationsAuthorizationCapture( params: stripe.PostTestHelpersIssuingAuthorizationsAuthorizationCaptureParams ): Promise { return this.ky @@ -70349,11 +68701,11 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_issuing_authorizations_authorization_expire', - description: '

Expire a test-mode Authorization.

.', + description: `

Expire a test-mode Authorization.

.`, inputSchema: stripe.PostTestHelpersIssuingAuthorizationsAuthorizationExpireParamsSchema }) - async PostTestHelpersIssuingAuthorizationsAuthorizationExpire( + async postTestHelpersIssuingAuthorizationsAuthorizationExpire( params: stripe.PostTestHelpersIssuingAuthorizationsAuthorizationExpireParams ): Promise { return this.ky @@ -70368,12 +68720,11 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_issuing_authorizations_authorization_finalize_amount', - description: - '

Finalize the amount on an Authorization prior to capture, when the initial authorization was for an estimated amount.

.', + description: `

Finalize the amount on an Authorization prior to capture, when the initial authorization was for an estimated amount.

.`, inputSchema: stripe.PostTestHelpersIssuingAuthorizationsAuthorizationFinalizeAmountParamsSchema }) - async PostTestHelpersIssuingAuthorizationsAuthorizationFinalizeAmount( + async postTestHelpersIssuingAuthorizationsAuthorizationFinalizeAmount( params: stripe.PostTestHelpersIssuingAuthorizationsAuthorizationFinalizeAmountParams ): Promise { return this.ky @@ -70388,12 +68739,11 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_issuing_authorizations_authorization_fraud_challenges_respond', - description: - '

Respond to a fraud challenge on a testmode Issuing authorization, simulating either a confirmation of fraud or a correction of legitimacy.

.', + description: `

Respond to a fraud challenge on a testmode Issuing authorization, simulating either a confirmation of fraud or a correction of legitimacy.

.`, inputSchema: stripe.PostTestHelpersIssuingAuthorizationsAuthorizationFraudChallengesRespondParamsSchema }) - async PostTestHelpersIssuingAuthorizationsAuthorizationFraudChallengesRespond( + async postTestHelpersIssuingAuthorizationsAuthorizationFraudChallengesRespond( params: stripe.PostTestHelpersIssuingAuthorizationsAuthorizationFraudChallengesRespondParams ): Promise { return this.ky @@ -70408,11 +68758,11 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_issuing_authorizations_authorization_increment', - description: '

Increment a test-mode Authorization.

.', + description: `

Increment a test-mode Authorization.

.`, inputSchema: stripe.PostTestHelpersIssuingAuthorizationsAuthorizationIncrementParamsSchema }) - async PostTestHelpersIssuingAuthorizationsAuthorizationIncrement( + async postTestHelpersIssuingAuthorizationsAuthorizationIncrement( params: stripe.PostTestHelpersIssuingAuthorizationsAuthorizationIncrementParams ): Promise { return this.ky @@ -70427,11 +68777,11 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_issuing_authorizations_authorization_reverse', - description: '

Reverse a test-mode Authorization.

.', + description: `

Reverse a test-mode Authorization.

.`, inputSchema: stripe.PostTestHelpersIssuingAuthorizationsAuthorizationReverseParamsSchema }) - async PostTestHelpersIssuingAuthorizationsAuthorizationReverse( + async postTestHelpersIssuingAuthorizationsAuthorizationReverse( params: stripe.PostTestHelpersIssuingAuthorizationsAuthorizationReverseParams ): Promise { return this.ky @@ -70446,12 +68796,11 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_issuing_cards_card_shipping_deliver', - description: - '

Updates the shipping status of the specified Issuing Card object to delivered.

.', + description: `

Updates the shipping status of the specified Issuing Card object to delivered.

.`, inputSchema: stripe.PostTestHelpersIssuingCardsCardShippingDeliverParamsSchema }) - async PostTestHelpersIssuingCardsCardShippingDeliver( + async postTestHelpersIssuingCardsCardShippingDeliver( params: stripe.PostTestHelpersIssuingCardsCardShippingDeliverParams ): Promise { return this.ky @@ -70464,11 +68813,10 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_issuing_cards_card_shipping_fail', - description: - '

Updates the shipping status of the specified Issuing Card object to failure.

.', + description: `

Updates the shipping status of the specified Issuing Card object to failure.

.`, inputSchema: stripe.PostTestHelpersIssuingCardsCardShippingFailParamsSchema }) - async PostTestHelpersIssuingCardsCardShippingFail( + async postTestHelpersIssuingCardsCardShippingFail( params: stripe.PostTestHelpersIssuingCardsCardShippingFailParams ): Promise { return this.ky @@ -70481,12 +68829,11 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_issuing_cards_card_shipping_return', - description: - '

Updates the shipping status of the specified Issuing Card object to returned.

.', + description: `

Updates the shipping status of the specified Issuing Card object to returned.

.`, inputSchema: stripe.PostTestHelpersIssuingCardsCardShippingReturnParamsSchema }) - async PostTestHelpersIssuingCardsCardShippingReturn( + async postTestHelpersIssuingCardsCardShippingReturn( params: stripe.PostTestHelpersIssuingCardsCardShippingReturnParams ): Promise { return this.ky @@ -70499,11 +68846,10 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_issuing_cards_card_shipping_ship', - description: - '

Updates the shipping status of the specified Issuing Card object to shipped.

.', + description: `

Updates the shipping status of the specified Issuing Card object to shipped.

.`, inputSchema: stripe.PostTestHelpersIssuingCardsCardShippingShipParamsSchema }) - async PostTestHelpersIssuingCardsCardShippingShip( + async postTestHelpersIssuingCardsCardShippingShip( params: stripe.PostTestHelpersIssuingCardsCardShippingShipParams ): Promise { return this.ky @@ -70516,12 +68862,11 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_issuing_cards_card_shipping_submit', - description: - '

Updates the shipping status of the specified Issuing Card object to submitted. This method requires Stripe Version ‘2024-09-30.acacia’ or later.

.', + description: `

Updates the shipping status of the specified Issuing Card object to submitted. This method requires Stripe Version ‘2024-09-30.acacia’ or later.

.`, inputSchema: stripe.PostTestHelpersIssuingCardsCardShippingSubmitParamsSchema }) - async PostTestHelpersIssuingCardsCardShippingSubmit( + async postTestHelpersIssuingCardsCardShippingSubmit( params: stripe.PostTestHelpersIssuingCardsCardShippingSubmitParams ): Promise { return this.ky @@ -70534,12 +68879,11 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_issuing_personalization_designs_personalization_design_activate', - description: - '

Updates the status of the specified testmode personalization design object to active.

.', + description: `

Updates the status of the specified testmode personalization design object to active.

.`, inputSchema: stripe.PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignActivateParamsSchema }) - async PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignActivate( + async postTestHelpersIssuingPersonalizationDesignsPersonalizationDesignActivate( params: stripe.PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignActivateParams ): Promise { return this.ky @@ -70554,12 +68898,11 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_issuing_personalization_designs_personalization_design_deactivate', - description: - '

Updates the status of the specified testmode personalization design object to inactive.

.', + description: `

Updates the status of the specified testmode personalization design object to inactive.

.`, inputSchema: stripe.PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignDeactivateParamsSchema }) - async PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignDeactivate( + async postTestHelpersIssuingPersonalizationDesignsPersonalizationDesignDeactivate( params: stripe.PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignDeactivateParams ): Promise { return this.ky @@ -70574,12 +68917,11 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_issuing_personalization_designs_personalization_design_reject', - description: - '

Updates the status of the specified testmode personalization design object to rejected.

.', + description: `

Updates the status of the specified testmode personalization design object to rejected.

.`, inputSchema: stripe.PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignRejectParamsSchema }) - async PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignReject( + async postTestHelpersIssuingPersonalizationDesignsPersonalizationDesignReject( params: stripe.PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignRejectParams ): Promise { return this.ky @@ -70594,10 +68936,10 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_issuing_settlements', - description: '

Allows the user to create an Issuing settlement.

.', + description: `

Allows the user to create an Issuing settlement.

.`, inputSchema: stripe.PostTestHelpersIssuingSettlementsParamsSchema }) - async PostTestHelpersIssuingSettlements( + async postTestHelpersIssuingSettlements( _params: stripe.PostTestHelpersIssuingSettlementsParams ): Promise { return this.ky @@ -70610,12 +68952,11 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_issuing_settlements_settlement_complete', - description: - '

Allows the user to mark an Issuing settlement as complete.

.', + description: `

Allows the user to mark an Issuing settlement as complete.

.`, inputSchema: stripe.PostTestHelpersIssuingSettlementsSettlementCompleteParamsSchema }) - async PostTestHelpersIssuingSettlementsSettlementComplete( + async postTestHelpersIssuingSettlementsSettlementComplete( params: stripe.PostTestHelpersIssuingSettlementsSettlementCompleteParams ): Promise { return this.ky @@ -70630,12 +68971,11 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_issuing_transactions_create_force_capture', - description: - '

Allows the user to capture an arbitrary amount, also known as a forced capture.

.', + description: `

Allows the user to capture an arbitrary amount, also known as a forced capture.

.`, inputSchema: stripe.PostTestHelpersIssuingTransactionsCreateForceCaptureParamsSchema }) - async PostTestHelpersIssuingTransactionsCreateForceCapture( + async postTestHelpersIssuingTransactionsCreateForceCapture( _params: stripe.PostTestHelpersIssuingTransactionsCreateForceCaptureParams ): Promise { return this.ky @@ -70648,12 +68988,11 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_issuing_transactions_create_unlinked_refund', - description: - '

Allows the user to refund an arbitrary amount, also known as a unlinked refund.

.', + description: `

Allows the user to refund an arbitrary amount, also known as a unlinked refund.

.`, inputSchema: stripe.PostTestHelpersIssuingTransactionsCreateUnlinkedRefundParamsSchema }) - async PostTestHelpersIssuingTransactionsCreateUnlinkedRefund( + async postTestHelpersIssuingTransactionsCreateUnlinkedRefund( _params: stripe.PostTestHelpersIssuingTransactionsCreateUnlinkedRefundParams ): Promise { return this.ky @@ -70666,11 +69005,11 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_issuing_transactions_transaction_refund', - description: '

Refund a test-mode Transaction.

.', + description: `

Refund a test-mode Transaction.

.`, inputSchema: stripe.PostTestHelpersIssuingTransactionsTransactionRefundParamsSchema }) - async PostTestHelpersIssuingTransactionsTransactionRefund( + async postTestHelpersIssuingTransactionsTransactionRefund( params: stripe.PostTestHelpersIssuingTransactionsTransactionRefundParams ): Promise { return this.ky @@ -70685,11 +69024,10 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_refunds_refund_expire', - description: - '

Expire a refund with a status of requires_action.

.', + description: `

Expire a refund with a status of requires_action.

.`, inputSchema: stripe.PostTestHelpersRefundsRefundExpireParamsSchema }) - async PostTestHelpersRefundsRefundExpire( + async postTestHelpersRefundsRefundExpire( params: stripe.PostTestHelpersRefundsRefundExpireParams ): Promise { return this.ky @@ -70702,12 +69040,11 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_terminal_readers_reader_present_payment_method', - description: - '

Presents a payment method on a simulated reader. Can be used to simulate accepting a payment, saving a card or refunding a transaction.

.', + description: `

Presents a payment method on a simulated reader. Can be used to simulate accepting a payment, saving a card or refunding a transaction.

.`, inputSchema: stripe.PostTestHelpersTerminalReadersReaderPresentPaymentMethodParamsSchema }) - async PostTestHelpersTerminalReadersReaderPresentPaymentMethod( + async postTestHelpersTerminalReadersReaderPresentPaymentMethod( params: stripe.PostTestHelpersTerminalReadersReaderPresentPaymentMethodParams ): Promise { return this.ky @@ -70722,15 +69059,17 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'get_test_helpers_test_clocks', - description: '

Returns a list of your test clocks.

.', + description: `

Returns a list of your test clocks.

.`, inputSchema: stripe.GetTestHelpersTestClocksParamsSchema }) - async GetTestHelpersTestClocks( + async getTestHelpersTestClocks( params: stripe.GetTestHelpersTestClocksParams ): Promise { return this.ky .get('/v1/test_helpers/test_clocks', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick(params, 'ending_before', 'expand', 'limit', 'starting_after') + ) }) .json() } @@ -70740,11 +69079,10 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_test_clocks', - description: - '

Creates a new test clock that can be attached to new customers and quotes.

.', + description: `

Creates a new test clock that can be attached to new customers and quotes.

.`, inputSchema: stripe.PostTestHelpersTestClocksParamsSchema }) - async PostTestHelpersTestClocks( + async postTestHelpersTestClocks( _params: stripe.PostTestHelpersTestClocksParams ): Promise { return this.ky @@ -70757,10 +69095,10 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'get_test_helpers_test_clocks_test_clock', - description: '

Retrieves a test clock.

.', + description: `

Retrieves a test clock.

.`, inputSchema: stripe.GetTestHelpersTestClocksTestClockParamsSchema }) - async GetTestHelpersTestClocksTestClock( + async getTestHelpersTestClocksTestClock( params: stripe.GetTestHelpersTestClocksTestClockParams ): Promise { return this.ky @@ -70775,10 +69113,10 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'delete_test_helpers_test_clocks_test_clock', - description: '

Deletes a test clock.

.', + description: `

Deletes a test clock.

.`, inputSchema: stripe.DeleteTestHelpersTestClocksTestClockParamsSchema }) - async DeleteTestHelpersTestClocksTestClock( + async deleteTestHelpersTestClocksTestClock( params: stripe.DeleteTestHelpersTestClocksTestClockParams ): Promise { return this.ky @@ -70791,11 +69129,10 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_test_clocks_test_clock_advance', - description: - '

Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.

.', + description: `

Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.

.`, inputSchema: stripe.PostTestHelpersTestClocksTestClockAdvanceParamsSchema }) - async PostTestHelpersTestClocksTestClockAdvance( + async postTestHelpersTestClocksTestClockAdvance( params: stripe.PostTestHelpersTestClocksTestClockAdvanceParams ): Promise { return this.ky @@ -70808,12 +69145,11 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_treasury_inbound_transfers_id_fail', - description: - '

Transitions a test mode created InboundTransfer to the failed status. The InboundTransfer must already be in the processing state.

.', + description: `

Transitions a test mode created InboundTransfer to the failed status. The InboundTransfer must already be in the processing state.

.`, inputSchema: stripe.PostTestHelpersTreasuryInboundTransfersIdFailParamsSchema }) - async PostTestHelpersTreasuryInboundTransfersIdFail( + async postTestHelpersTreasuryInboundTransfersIdFail( params: stripe.PostTestHelpersTreasuryInboundTransfersIdFailParams ): Promise { return this.ky @@ -70826,12 +69162,11 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_treasury_inbound_transfers_id_return', - description: - '

Marks the test mode InboundTransfer object as returned and links the InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the succeeded state.

.', + description: `

Marks the test mode InboundTransfer object as returned and links the InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the succeeded state.

.`, inputSchema: stripe.PostTestHelpersTreasuryInboundTransfersIdReturnParamsSchema }) - async PostTestHelpersTreasuryInboundTransfersIdReturn( + async postTestHelpersTreasuryInboundTransfersIdReturn( params: stripe.PostTestHelpersTreasuryInboundTransfersIdReturnParams ): Promise { return this.ky @@ -70846,12 +69181,11 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_treasury_inbound_transfers_id_succeed', - description: - '

Transitions a test mode created InboundTransfer to the succeeded status. The InboundTransfer must already be in the processing state.

.', + description: `

Transitions a test mode created InboundTransfer to the succeeded status. The InboundTransfer must already be in the processing state.

.`, inputSchema: stripe.PostTestHelpersTreasuryInboundTransfersIdSucceedParamsSchema }) - async PostTestHelpersTreasuryInboundTransfersIdSucceed( + async postTestHelpersTreasuryInboundTransfersIdSucceed( params: stripe.PostTestHelpersTreasuryInboundTransfersIdSucceedParams ): Promise { return this.ky @@ -70866,11 +69200,10 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_treasury_outbound_payments_id', - description: - '

Updates a test mode created OutboundPayment with tracking details. The OutboundPayment must not be cancelable, and cannot be in the canceled or failed states.

.', + description: `

Updates a test mode created OutboundPayment with tracking details. The OutboundPayment must not be cancelable, and cannot be in the canceled or failed states.

.`, inputSchema: stripe.PostTestHelpersTreasuryOutboundPaymentsIdParamsSchema }) - async PostTestHelpersTreasuryOutboundPaymentsId( + async postTestHelpersTreasuryOutboundPaymentsId( params: stripe.PostTestHelpersTreasuryOutboundPaymentsIdParams ): Promise { return this.ky @@ -70883,12 +69216,11 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_treasury_outbound_payments_id_fail', - description: - '

Transitions a test mode created OutboundPayment to the failed status. The OutboundPayment must already be in the processing state.

.', + description: `

Transitions a test mode created OutboundPayment to the failed status. The OutboundPayment must already be in the processing state.

.`, inputSchema: stripe.PostTestHelpersTreasuryOutboundPaymentsIdFailParamsSchema }) - async PostTestHelpersTreasuryOutboundPaymentsIdFail( + async postTestHelpersTreasuryOutboundPaymentsIdFail( params: stripe.PostTestHelpersTreasuryOutboundPaymentsIdFailParams ): Promise { return this.ky @@ -70901,12 +69233,11 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_treasury_outbound_payments_id_post', - description: - '

Transitions a test mode created OutboundPayment to the posted status. The OutboundPayment must already be in the processing state.

.', + description: `

Transitions a test mode created OutboundPayment to the posted status. The OutboundPayment must already be in the processing state.

.`, inputSchema: stripe.PostTestHelpersTreasuryOutboundPaymentsIdPostParamsSchema }) - async PostTestHelpersTreasuryOutboundPaymentsIdPost( + async postTestHelpersTreasuryOutboundPaymentsIdPost( params: stripe.PostTestHelpersTreasuryOutboundPaymentsIdPostParams ): Promise { return this.ky @@ -70919,12 +69250,11 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_treasury_outbound_payments_id_return', - description: - '

Transitions a test mode created OutboundPayment to the returned status. The OutboundPayment must already be in the processing state.

.', + description: `

Transitions a test mode created OutboundPayment to the returned status. The OutboundPayment must already be in the processing state.

.`, inputSchema: stripe.PostTestHelpersTreasuryOutboundPaymentsIdReturnParamsSchema }) - async PostTestHelpersTreasuryOutboundPaymentsIdReturn( + async postTestHelpersTreasuryOutboundPaymentsIdReturn( params: stripe.PostTestHelpersTreasuryOutboundPaymentsIdReturnParams ): Promise { return this.ky @@ -70939,12 +69269,11 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_treasury_outbound_transfers_outbound_transfer', - description: - '

Updates a test mode created OutboundTransfer with tracking details. The OutboundTransfer must not be cancelable, and cannot be in the canceled or failed states.

.', + description: `

Updates a test mode created OutboundTransfer with tracking details. The OutboundTransfer must not be cancelable, and cannot be in the canceled or failed states.

.`, inputSchema: stripe.PostTestHelpersTreasuryOutboundTransfersOutboundTransferParamsSchema }) - async PostTestHelpersTreasuryOutboundTransfersOutboundTransfer( + async postTestHelpersTreasuryOutboundTransfersOutboundTransfer( params: stripe.PostTestHelpersTreasuryOutboundTransfersOutboundTransferParams ): Promise { return this.ky @@ -70959,12 +69288,11 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_treasury_outbound_transfers_outbound_transfer_fail', - description: - '

Transitions a test mode created OutboundTransfer to the failed status. The OutboundTransfer must already be in the processing state.

.', + description: `

Transitions a test mode created OutboundTransfer to the failed status. The OutboundTransfer must already be in the processing state.

.`, inputSchema: stripe.PostTestHelpersTreasuryOutboundTransfersOutboundTransferFailParamsSchema }) - async PostTestHelpersTreasuryOutboundTransfersOutboundTransferFail( + async postTestHelpersTreasuryOutboundTransfersOutboundTransferFail( params: stripe.PostTestHelpersTreasuryOutboundTransfersOutboundTransferFailParams ): Promise { return this.ky @@ -70979,12 +69307,11 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_treasury_outbound_transfers_outbound_transfer_post', - description: - '

Transitions a test mode created OutboundTransfer to the posted status. The OutboundTransfer must already be in the processing state.

.', + description: `

Transitions a test mode created OutboundTransfer to the posted status. The OutboundTransfer must already be in the processing state.

.`, inputSchema: stripe.PostTestHelpersTreasuryOutboundTransfersOutboundTransferPostParamsSchema }) - async PostTestHelpersTreasuryOutboundTransfersOutboundTransferPost( + async postTestHelpersTreasuryOutboundTransfersOutboundTransferPost( params: stripe.PostTestHelpersTreasuryOutboundTransfersOutboundTransferPostParams ): Promise { return this.ky @@ -70999,12 +69326,11 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_treasury_outbound_transfers_outbound_transfer_return', - description: - '

Transitions a test mode created OutboundTransfer to the returned status. The OutboundTransfer must already be in the processing state.

.', + description: `

Transitions a test mode created OutboundTransfer to the returned status. The OutboundTransfer must already be in the processing state.

.`, inputSchema: stripe.PostTestHelpersTreasuryOutboundTransfersOutboundTransferReturnParamsSchema }) - async PostTestHelpersTreasuryOutboundTransfersOutboundTransferReturn( + async postTestHelpersTreasuryOutboundTransfersOutboundTransferReturn( params: stripe.PostTestHelpersTreasuryOutboundTransfersOutboundTransferReturnParams ): Promise { return this.ky @@ -71019,11 +69345,10 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_treasury_received_credits', - description: - '

Use this endpoint to simulate a test mode ReceivedCredit initiated by a third party. In live mode, you can’t directly create ReceivedCredits initiated by third parties.

.', + description: `

Use this endpoint to simulate a test mode ReceivedCredit initiated by a third party. In live mode, you can’t directly create ReceivedCredits initiated by third parties.

.`, inputSchema: stripe.PostTestHelpersTreasuryReceivedCreditsParamsSchema }) - async PostTestHelpersTreasuryReceivedCredits( + async postTestHelpersTreasuryReceivedCredits( _params: stripe.PostTestHelpersTreasuryReceivedCreditsParams ): Promise { return this.ky @@ -71036,11 +69361,10 @@ For further details, including which address fields are required in each country */ @aiFunction({ name: 'post_test_helpers_treasury_received_debits', - description: - '

Use this endpoint to simulate a test mode ReceivedDebit initiated by a third party. In live mode, you can’t directly create ReceivedDebits initiated by third parties.

.', + description: `

Use this endpoint to simulate a test mode ReceivedDebit initiated by a third party. In live mode, you can’t directly create ReceivedDebits initiated by third parties.

.`, inputSchema: stripe.PostTestHelpersTreasuryReceivedDebitsParamsSchema }) - async PostTestHelpersTreasuryReceivedDebits( + async postTestHelpersTreasuryReceivedDebits( _params: stripe.PostTestHelpersTreasuryReceivedDebitsParams ): Promise { return this.ky @@ -71058,7 +69382,7 @@ You can use this token with any v1 API method in place of a bank account diction You can use this token with any v1 API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a connected account where controller.requirement_collection is application, which includes Custom accounts.

.`, inputSchema: stripe.PostTokensParamsSchema }) - async PostTokens( + async postTokens( _params: stripe.PostTokensParams ): Promise { return this.ky.post('/v1/tokens').json() @@ -71069,10 +69393,10 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'get_tokens_token', - description: '

Retrieves the token with the given ID.

.', + description: `

Retrieves the token with the given ID.

.`, inputSchema: stripe.GetTokensTokenParamsSchema }) - async GetTokensToken( + async getTokensToken( params: stripe.GetTokensTokenParams ): Promise { return this.ky @@ -71087,15 +69411,26 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'get_topups', - description: '

Returns a list of top-ups.

.', + description: `

Returns a list of top-ups.

.`, inputSchema: stripe.GetTopupsParamsSchema }) - async GetTopups( + async getTopups( params: stripe.GetTopupsParams ): Promise { return this.ky .get('/v1/topups', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'amount', + 'created', + 'ending_before', + 'expand', + 'limit', + 'starting_after', + 'status' + ) + ) }) .json() } @@ -71105,10 +69440,10 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'post_topups', - description: '

Top up the balance of an account

.', + description: `

Top up the balance of an account

.`, inputSchema: stripe.PostTopupsParamsSchema }) - async PostTopups( + async postTopups( _params: stripe.PostTopupsParams ): Promise { return this.ky.post('/v1/topups').json() @@ -71119,11 +69454,10 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'get_topups_topup', - description: - '

Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information.

.', + description: `

Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information.

.`, inputSchema: stripe.GetTopupsTopupParamsSchema }) - async GetTopupsTopup( + async getTopupsTopup( params: stripe.GetTopupsTopupParams ): Promise { return this.ky @@ -71138,11 +69472,10 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'post_topups_topup', - description: - '

Updates the metadata of a top-up. Other top-up details are not editable by design.

.', + description: `

Updates the metadata of a top-up. Other top-up details are not editable by design.

.`, inputSchema: stripe.PostTopupsTopupParamsSchema }) - async PostTopupsTopup( + async postTopupsTopup( params: stripe.PostTopupsTopupParams ): Promise { return this.ky @@ -71155,11 +69488,10 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'post_topups_topup_cancel', - description: - '

Cancels a top-up. Only pending top-ups can be canceled.

.', + description: `

Cancels a top-up. Only pending top-ups can be canceled.

.`, inputSchema: stripe.PostTopupsTopupCancelParamsSchema }) - async PostTopupsTopupCancel( + async postTopupsTopupCancel( params: stripe.PostTopupsTopupCancelParams ): Promise { return this.ky @@ -71172,16 +69504,26 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'get_transfers', - description: - '

Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.

.', + description: `

Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.

.`, inputSchema: stripe.GetTransfersParamsSchema }) - async GetTransfers( + async getTransfers( params: stripe.GetTransfersParams ): Promise { return this.ky .get('/v1/transfers', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'created', + 'destination', + 'ending_before', + 'expand', + 'limit', + 'starting_after', + 'transfer_group' + ) + ) }) .json() } @@ -71191,11 +69533,10 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'post_transfers', - description: - '

To send funds from your Stripe account to a connected account, you create a new transfer object. Your Stripe balance must be able to cover the transfer amount, or you’ll receive an “Insufficient Funds” error.

.', + description: `

To send funds from your Stripe account to a connected account, you create a new transfer object. Your Stripe balance must be able to cover the transfer amount, or you’ll receive an “Insufficient Funds” error.

.`, inputSchema: stripe.PostTransfersParamsSchema }) - async PostTransfers( + async postTransfers( _params: stripe.PostTransfersParams ): Promise { return this.ky.post('/v1/transfers').json() @@ -71206,11 +69547,10 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'get_transfers_id_reversals', - description: - '

You can see a list of the reversals belonging to a specific transfer. Note that the 10 most recent reversals are always available by default on the transfer object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional reversals.

.', + description: `

You can see a list of the reversals belonging to a specific transfer. Note that the 10 most recent reversals are always available by default on the transfer object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional reversals.

.`, inputSchema: stripe.GetTransfersIdReversalsParamsSchema }) - async GetTransfersIdReversals( + async getTransfersIdReversals( params: stripe.GetTransfersIdReversalsParams ): Promise { return this.ky @@ -71238,7 +69578,7 @@ You can use this token with any v1 API method in place of a bank account diction

Once entirely reversed, a transfer can’t be reversed again. This method will return an error when called on an already-reversed transfer, or when trying to reverse more money than is left on a transfer.

.`, inputSchema: stripe.PostTransfersIdReversalsParamsSchema }) - async PostTransfersIdReversals( + async postTransfersIdReversals( params: stripe.PostTransfersIdReversalsParams ): Promise { return this.ky @@ -71251,11 +69591,10 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'get_transfers_transfer', - description: - '

Retrieves the details of an existing transfer. Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer information.

.', + description: `

Retrieves the details of an existing transfer. Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer information.

.`, inputSchema: stripe.GetTransfersTransferParamsSchema }) - async GetTransfersTransfer( + async getTransfersTransfer( params: stripe.GetTransfersTransferParams ): Promise { return this.ky @@ -71277,7 +69616,7 @@ You can use this token with any v1 API method in place of a bank account diction

This request accepts only metadata as an argument.

.`, inputSchema: stripe.PostTransfersTransferParamsSchema }) - async PostTransfersTransfer( + async postTransfersTransfer( params: stripe.PostTransfersTransferParams ): Promise { return this.ky @@ -71290,11 +69629,10 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'get_transfers_transfer_reversals_id', - description: - '

By default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specific reversal stored on the transfer.

.', + description: `

By default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specific reversal stored on the transfer.

.`, inputSchema: stripe.GetTransfersTransferReversalsIdParamsSchema }) - async GetTransfersTransferReversalsId( + async getTransfersTransferReversalsId( params: stripe.GetTransfersTransferReversalsIdParams ): Promise { return this.ky @@ -71316,11 +69654,11 @@ You can use this token with any v1 API method in place of a bank account diction

This request only accepts metadata and description as arguments.

.`, inputSchema: stripe.PostTransfersTransferReversalsIdParamsSchema }) - async PostTransfersTransferReversalsId( + async postTransfersTransferReversalsId( params: stripe.PostTransfersTransferReversalsIdParams ): Promise { return this.ky - .post(`/v1/transfers/${params.transfer}/reversals/${params.id}`) + .post(`/v1/transfers/${params.transfer}/reversals/${params.id}`, {}) .json() } @@ -71329,15 +69667,26 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'get_treasury_credit_reversals', - description: '

Returns a list of CreditReversals.

.', + description: `

Returns a list of CreditReversals.

.`, inputSchema: stripe.GetTreasuryCreditReversalsParamsSchema }) - async GetTreasuryCreditReversals( + async getTreasuryCreditReversals( params: stripe.GetTreasuryCreditReversalsParams ): Promise { return this.ky .get('/v1/treasury/credit_reversals', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'ending_before', + 'expand', + 'financial_account', + 'limit', + 'received_credit', + 'starting_after', + 'status' + ) + ) }) .json() } @@ -71347,11 +69696,10 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'post_treasury_credit_reversals', - description: - '

Reverses a ReceivedCredit and creates a CreditReversal object.

.', + description: `

Reverses a ReceivedCredit and creates a CreditReversal object.

.`, inputSchema: stripe.PostTreasuryCreditReversalsParamsSchema }) - async PostTreasuryCreditReversals( + async postTreasuryCreditReversals( _params: stripe.PostTreasuryCreditReversalsParams ): Promise { return this.ky @@ -71364,11 +69712,10 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'get_treasury_credit_reversals_credit_reversal', - description: - '

Retrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list

.', + description: `

Retrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list

.`, inputSchema: stripe.GetTreasuryCreditReversalsCreditReversalParamsSchema }) - async GetTreasuryCreditReversalsCreditReversal( + async getTreasuryCreditReversalsCreditReversal( params: stripe.GetTreasuryCreditReversalsCreditReversalParams ): Promise { return this.ky @@ -71383,15 +69730,27 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'get_treasury_debit_reversals', - description: '

Returns a list of DebitReversals.

.', + description: `

Returns a list of DebitReversals.

.`, inputSchema: stripe.GetTreasuryDebitReversalsParamsSchema }) - async GetTreasuryDebitReversals( + async getTreasuryDebitReversals( params: stripe.GetTreasuryDebitReversalsParams ): Promise { return this.ky .get('/v1/treasury/debit_reversals', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'ending_before', + 'expand', + 'financial_account', + 'limit', + 'received_debit', + 'resolution', + 'starting_after', + 'status' + ) + ) }) .json() } @@ -71401,11 +69760,10 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'post_treasury_debit_reversals', - description: - '

Reverses a ReceivedDebit and creates a DebitReversal object.

.', + description: `

Reverses a ReceivedDebit and creates a DebitReversal object.

.`, inputSchema: stripe.PostTreasuryDebitReversalsParamsSchema }) - async PostTreasuryDebitReversals( + async postTreasuryDebitReversals( _params: stripe.PostTreasuryDebitReversalsParams ): Promise { return this.ky @@ -71418,10 +69776,10 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'get_treasury_debit_reversals_debit_reversal', - description: '

Retrieves a DebitReversal object.

.', + description: `

Retrieves a DebitReversal object.

.`, inputSchema: stripe.GetTreasuryDebitReversalsDebitReversalParamsSchema }) - async GetTreasuryDebitReversalsDebitReversal( + async getTreasuryDebitReversalsDebitReversal( params: stripe.GetTreasuryDebitReversalsDebitReversalParams ): Promise { return this.ky @@ -71436,15 +69794,24 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'get_treasury_financial_accounts', - description: '

Returns a list of FinancialAccounts.

.', + description: `

Returns a list of FinancialAccounts.

.`, inputSchema: stripe.GetTreasuryFinancialAccountsParamsSchema }) - async GetTreasuryFinancialAccounts( + async getTreasuryFinancialAccounts( params: stripe.GetTreasuryFinancialAccountsParams ): Promise { return this.ky .get('/v1/treasury/financial_accounts', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'created', + 'ending_before', + 'expand', + 'limit', + 'starting_after' + ) + ) }) .json() } @@ -71454,11 +69821,10 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'post_treasury_financial_accounts', - description: - '

Creates a new FinancialAccount. For now, each connected account can only have one FinancialAccount.

.', + description: `

Creates a new FinancialAccount. For now, each connected account can only have one FinancialAccount.

.`, inputSchema: stripe.PostTreasuryFinancialAccountsParamsSchema }) - async PostTreasuryFinancialAccounts( + async postTreasuryFinancialAccounts( _params: stripe.PostTreasuryFinancialAccountsParams ): Promise { return this.ky @@ -71471,10 +69837,10 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'get_treasury_financial_accounts_financial_account', - description: '

Retrieves the details of a FinancialAccount.

.', + description: `

Retrieves the details of a FinancialAccount.

.`, inputSchema: stripe.GetTreasuryFinancialAccountsFinancialAccountParamsSchema }) - async GetTreasuryFinancialAccountsFinancialAccount( + async getTreasuryFinancialAccountsFinancialAccount( params: stripe.GetTreasuryFinancialAccountsFinancialAccountParams ): Promise { return this.ky @@ -71489,11 +69855,11 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'post_treasury_financial_accounts_financial_account', - description: '

Updates the details of a FinancialAccount.

.', + description: `

Updates the details of a FinancialAccount.

.`, inputSchema: stripe.PostTreasuryFinancialAccountsFinancialAccountParamsSchema }) - async PostTreasuryFinancialAccountsFinancialAccount( + async postTreasuryFinancialAccountsFinancialAccount( params: stripe.PostTreasuryFinancialAccountsFinancialAccountParams ): Promise { return this.ky @@ -71506,12 +69872,11 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'post_treasury_financial_accounts_financial_account_close', - description: - '

Closes a FinancialAccount. A FinancialAccount can only be closed if it has a zero balance, has no pending InboundTransfers, and has canceled all attached Issuing cards.

.', + description: `

Closes a FinancialAccount. A FinancialAccount can only be closed if it has a zero balance, has no pending InboundTransfers, and has canceled all attached Issuing cards.

.`, inputSchema: stripe.PostTreasuryFinancialAccountsFinancialAccountCloseParamsSchema }) - async PostTreasuryFinancialAccountsFinancialAccountClose( + async postTreasuryFinancialAccountsFinancialAccountClose( params: stripe.PostTreasuryFinancialAccountsFinancialAccountCloseParams ): Promise { return this.ky @@ -71526,12 +69891,11 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'get_treasury_financial_accounts_financial_account_features', - description: - '

Retrieves Features information associated with the FinancialAccount.

.', + description: `

Retrieves Features information associated with the FinancialAccount.

.`, inputSchema: stripe.GetTreasuryFinancialAccountsFinancialAccountFeaturesParamsSchema }) - async GetTreasuryFinancialAccountsFinancialAccountFeatures( + async getTreasuryFinancialAccountsFinancialAccountFeatures( params: stripe.GetTreasuryFinancialAccountsFinancialAccountFeaturesParams ): Promise { return this.ky @@ -71549,12 +69913,11 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'post_treasury_financial_accounts_financial_account_features', - description: - '

Updates the Features associated with a FinancialAccount.

.', + description: `

Updates the Features associated with a FinancialAccount.

.`, inputSchema: stripe.PostTreasuryFinancialAccountsFinancialAccountFeaturesParamsSchema }) - async PostTreasuryFinancialAccountsFinancialAccountFeatures( + async postTreasuryFinancialAccountsFinancialAccountFeatures( params: stripe.PostTreasuryFinancialAccountsFinancialAccountFeaturesParams ): Promise { return this.ky @@ -71569,16 +69932,25 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'get_treasury_inbound_transfers', - description: - '

Returns a list of InboundTransfers sent from the specified FinancialAccount.

.', + description: `

Returns a list of InboundTransfers sent from the specified FinancialAccount.

.`, inputSchema: stripe.GetTreasuryInboundTransfersParamsSchema }) - async GetTreasuryInboundTransfers( + async getTreasuryInboundTransfers( params: stripe.GetTreasuryInboundTransfersParams ): Promise { return this.ky .get('/v1/treasury/inbound_transfers', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'ending_before', + 'expand', + 'financial_account', + 'limit', + 'starting_after', + 'status' + ) + ) }) .json() } @@ -71588,10 +69960,10 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'post_treasury_inbound_transfers', - description: '

Creates an InboundTransfer.

.', + description: `

Creates an InboundTransfer.

.`, inputSchema: stripe.PostTreasuryInboundTransfersParamsSchema }) - async PostTreasuryInboundTransfers( + async postTreasuryInboundTransfers( _params: stripe.PostTreasuryInboundTransfersParams ): Promise { return this.ky @@ -71604,11 +69976,10 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'get_treasury_inbound_transfers_id', - description: - '

Retrieves the details of an existing InboundTransfer.

.', + description: `

Retrieves the details of an existing InboundTransfer.

.`, inputSchema: stripe.GetTreasuryInboundTransfersIdParamsSchema }) - async GetTreasuryInboundTransfersId( + async getTreasuryInboundTransfersId( params: stripe.GetTreasuryInboundTransfersIdParams ): Promise { return this.ky @@ -71623,11 +69994,11 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'post_treasury_inbound_transfers_inbound_transfer_cancel', - description: '

Cancels an InboundTransfer.

.', + description: `

Cancels an InboundTransfer.

.`, inputSchema: stripe.PostTreasuryInboundTransfersInboundTransferCancelParamsSchema }) - async PostTreasuryInboundTransfersInboundTransferCancel( + async postTreasuryInboundTransfersInboundTransferCancel( params: stripe.PostTreasuryInboundTransfersInboundTransferCancelParams ): Promise { return this.ky @@ -71642,16 +70013,27 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'get_treasury_outbound_payments', - description: - '

Returns a list of OutboundPayments sent from the specified FinancialAccount.

.', + description: `

Returns a list of OutboundPayments sent from the specified FinancialAccount.

.`, inputSchema: stripe.GetTreasuryOutboundPaymentsParamsSchema }) - async GetTreasuryOutboundPayments( + async getTreasuryOutboundPayments( params: stripe.GetTreasuryOutboundPaymentsParams ): Promise { return this.ky .get('/v1/treasury/outbound_payments', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'created', + 'customer', + 'ending_before', + 'expand', + 'financial_account', + 'limit', + 'starting_after', + 'status' + ) + ) }) .json() } @@ -71661,10 +70043,10 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'post_treasury_outbound_payments', - description: '

Creates an OutboundPayment.

.', + description: `

Creates an OutboundPayment.

.`, inputSchema: stripe.PostTreasuryOutboundPaymentsParamsSchema }) - async PostTreasuryOutboundPayments( + async postTreasuryOutboundPayments( _params: stripe.PostTreasuryOutboundPaymentsParams ): Promise { return this.ky @@ -71677,11 +70059,10 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'get_treasury_outbound_payments_id', - description: - '

Retrieves the details of an existing OutboundPayment by passing the unique OutboundPayment ID from either the OutboundPayment creation request or OutboundPayment list.

.', + description: `

Retrieves the details of an existing OutboundPayment by passing the unique OutboundPayment ID from either the OutboundPayment creation request or OutboundPayment list.

.`, inputSchema: stripe.GetTreasuryOutboundPaymentsIdParamsSchema }) - async GetTreasuryOutboundPaymentsId( + async getTreasuryOutboundPaymentsId( params: stripe.GetTreasuryOutboundPaymentsIdParams ): Promise { return this.ky @@ -71696,10 +70077,10 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'post_treasury_outbound_payments_id_cancel', - description: '

Cancel an OutboundPayment.

.', + description: `

Cancel an OutboundPayment.

.`, inputSchema: stripe.PostTreasuryOutboundPaymentsIdCancelParamsSchema }) - async PostTreasuryOutboundPaymentsIdCancel( + async postTreasuryOutboundPaymentsIdCancel( params: stripe.PostTreasuryOutboundPaymentsIdCancelParams ): Promise { return this.ky @@ -71712,16 +70093,25 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'get_treasury_outbound_transfers', - description: - '

Returns a list of OutboundTransfers sent from the specified FinancialAccount.

.', + description: `

Returns a list of OutboundTransfers sent from the specified FinancialAccount.

.`, inputSchema: stripe.GetTreasuryOutboundTransfersParamsSchema }) - async GetTreasuryOutboundTransfers( + async getTreasuryOutboundTransfers( params: stripe.GetTreasuryOutboundTransfersParams ): Promise { return this.ky .get('/v1/treasury/outbound_transfers', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'ending_before', + 'expand', + 'financial_account', + 'limit', + 'starting_after', + 'status' + ) + ) }) .json() } @@ -71731,10 +70121,10 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'post_treasury_outbound_transfers', - description: '

Creates an OutboundTransfer.

.', + description: `

Creates an OutboundTransfer.

.`, inputSchema: stripe.PostTreasuryOutboundTransfersParamsSchema }) - async PostTreasuryOutboundTransfers( + async postTreasuryOutboundTransfers( _params: stripe.PostTreasuryOutboundTransfersParams ): Promise { return this.ky @@ -71747,11 +70137,10 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'get_treasury_outbound_transfers_outbound_transfer', - description: - '

Retrieves the details of an existing OutboundTransfer by passing the unique OutboundTransfer ID from either the OutboundTransfer creation request or OutboundTransfer list.

.', + description: `

Retrieves the details of an existing OutboundTransfer by passing the unique OutboundTransfer ID from either the OutboundTransfer creation request or OutboundTransfer list.

.`, inputSchema: stripe.GetTreasuryOutboundTransfersOutboundTransferParamsSchema }) - async GetTreasuryOutboundTransfersOutboundTransfer( + async getTreasuryOutboundTransfersOutboundTransfer( params: stripe.GetTreasuryOutboundTransfersOutboundTransferParams ): Promise { return this.ky @@ -71766,12 +70155,11 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'post_treasury_outbound_transfers_outbound_transfer_cancel', - description: - '

An OutboundTransfer can be canceled if the funds have not yet been paid out.

.', + description: `

An OutboundTransfer can be canceled if the funds have not yet been paid out.

.`, inputSchema: stripe.PostTreasuryOutboundTransfersOutboundTransferCancelParamsSchema }) - async PostTreasuryOutboundTransfersOutboundTransferCancel( + async postTreasuryOutboundTransfersOutboundTransferCancel( params: stripe.PostTreasuryOutboundTransfersOutboundTransferCancelParams ): Promise { return this.ky @@ -71786,15 +70174,26 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'get_treasury_received_credits', - description: '

Returns a list of ReceivedCredits.

.', + description: `

Returns a list of ReceivedCredits.

.`, inputSchema: stripe.GetTreasuryReceivedCreditsParamsSchema }) - async GetTreasuryReceivedCredits( + async getTreasuryReceivedCredits( params: stripe.GetTreasuryReceivedCreditsParams ): Promise { return this.ky .get('/v1/treasury/received_credits', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'ending_before', + 'expand', + 'financial_account', + 'limit', + 'linked_flows', + 'starting_after', + 'status' + ) + ) }) .json() } @@ -71804,11 +70203,10 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'get_treasury_received_credits_id', - description: - '

Retrieves the details of an existing ReceivedCredit by passing the unique ReceivedCredit ID from the ReceivedCredit list.

.', + description: `

Retrieves the details of an existing ReceivedCredit by passing the unique ReceivedCredit ID from the ReceivedCredit list.

.`, inputSchema: stripe.GetTreasuryReceivedCreditsIdParamsSchema }) - async GetTreasuryReceivedCreditsId( + async getTreasuryReceivedCreditsId( params: stripe.GetTreasuryReceivedCreditsIdParams ): Promise { return this.ky @@ -71823,15 +70221,25 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'get_treasury_received_debits', - description: '

Returns a list of ReceivedDebits.

.', + description: `

Returns a list of ReceivedDebits.

.`, inputSchema: stripe.GetTreasuryReceivedDebitsParamsSchema }) - async GetTreasuryReceivedDebits( + async getTreasuryReceivedDebits( params: stripe.GetTreasuryReceivedDebitsParams ): Promise { return this.ky .get('/v1/treasury/received_debits', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'ending_before', + 'expand', + 'financial_account', + 'limit', + 'starting_after', + 'status' + ) + ) }) .json() } @@ -71841,11 +70249,10 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'get_treasury_received_debits_id', - description: - '

Retrieves the details of an existing ReceivedDebit by passing the unique ReceivedDebit ID from the ReceivedDebit list

.', + description: `

Retrieves the details of an existing ReceivedDebit by passing the unique ReceivedDebit ID from the ReceivedDebit list

.`, inputSchema: stripe.GetTreasuryReceivedDebitsIdParamsSchema }) - async GetTreasuryReceivedDebitsId( + async getTreasuryReceivedDebitsId( params: stripe.GetTreasuryReceivedDebitsIdParams ): Promise { return this.ky @@ -71860,15 +70267,28 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'get_treasury_transaction_entries', - description: '

Retrieves a list of TransactionEntry objects.

.', + description: `

Retrieves a list of TransactionEntry objects.

.`, inputSchema: stripe.GetTreasuryTransactionEntriesParamsSchema }) - async GetTreasuryTransactionEntries( + async getTreasuryTransactionEntries( params: stripe.GetTreasuryTransactionEntriesParams ): Promise { return this.ky .get('/v1/treasury/transaction_entries', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'created', + 'effective_at', + 'ending_before', + 'expand', + 'financial_account', + 'limit', + 'order_by', + 'starting_after', + 'transaction' + ) + ) }) .json() } @@ -71878,10 +70298,10 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'get_treasury_transaction_entries_id', - description: '

Retrieves a TransactionEntry object.

.', + description: `

Retrieves a TransactionEntry object.

.`, inputSchema: stripe.GetTreasuryTransactionEntriesIdParamsSchema }) - async GetTreasuryTransactionEntriesId( + async getTreasuryTransactionEntriesId( params: stripe.GetTreasuryTransactionEntriesIdParams ): Promise { return this.ky @@ -71896,15 +70316,28 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'get_treasury_transactions', - description: '

Retrieves a list of Transaction objects.

.', + description: `

Retrieves a list of Transaction objects.

.`, inputSchema: stripe.GetTreasuryTransactionsParamsSchema }) - async GetTreasuryTransactions( + async getTreasuryTransactions( params: stripe.GetTreasuryTransactionsParams ): Promise { return this.ky .get('/v1/treasury/transactions', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick( + params, + 'created', + 'ending_before', + 'expand', + 'financial_account', + 'limit', + 'order_by', + 'starting_after', + 'status', + 'status_transitions' + ) + ) }) .json() } @@ -71914,10 +70347,10 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'get_treasury_transactions_id', - description: '

Retrieves the details of an existing Transaction.

.', + description: `

Retrieves the details of an existing Transaction.

.`, inputSchema: stripe.GetTreasuryTransactionsIdParamsSchema }) - async GetTreasuryTransactionsId( + async getTreasuryTransactionsId( params: stripe.GetTreasuryTransactionsIdParams ): Promise { return this.ky @@ -71932,15 +70365,17 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'get_webhook_endpoints', - description: '

Returns a list of your webhook endpoints.

.', + description: `

Returns a list of your webhook endpoints.

.`, inputSchema: stripe.GetWebhookEndpointsParamsSchema }) - async GetWebhookEndpoints( + async getWebhookEndpoints( params: stripe.GetWebhookEndpointsParams ): Promise { return this.ky .get('/v1/webhook_endpoints', { - searchParams: sanitizeSearchParams(params) + searchParams: sanitizeSearchParams( + pick(params, 'ending_before', 'expand', 'limit', 'starting_after') + ) }) .json() } @@ -71950,11 +70385,10 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'post_webhook_endpoints', - description: - '

A webhook endpoint must have a url and a list of enabled_events. You may optionally specify the Boolean connect parameter. If set to true, then a Connect webhook endpoint that notifies the specified url about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specified url only about events from your account is created. You can also create webhook endpoints in the webhooks settings section of the Dashboard.

.', + description: `

A webhook endpoint must have a url and a list of enabled_events. You may optionally specify the Boolean connect parameter. If set to true, then a Connect webhook endpoint that notifies the specified url about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specified url only about events from your account is created. You can also create webhook endpoints in the webhooks settings section of the Dashboard.

.`, inputSchema: stripe.PostWebhookEndpointsParamsSchema }) - async PostWebhookEndpoints( + async postWebhookEndpoints( _params: stripe.PostWebhookEndpointsParams ): Promise { return this.ky @@ -71967,10 +70401,10 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'get_webhook_endpoints_webhook_endpoint', - description: '

Retrieves the webhook endpoint with the given ID.

.', + description: `

Retrieves the webhook endpoint with the given ID.

.`, inputSchema: stripe.GetWebhookEndpointsWebhookEndpointParamsSchema }) - async GetWebhookEndpointsWebhookEndpoint( + async getWebhookEndpointsWebhookEndpoint( params: stripe.GetWebhookEndpointsWebhookEndpointParams ): Promise { return this.ky @@ -71985,11 +70419,10 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'post_webhook_endpoints_webhook_endpoint', - description: - '

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

.', + description: `

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.

.`, inputSchema: stripe.PostWebhookEndpointsWebhookEndpointParamsSchema }) - async PostWebhookEndpointsWebhookEndpoint( + async postWebhookEndpointsWebhookEndpoint( params: stripe.PostWebhookEndpointsWebhookEndpointParams ): Promise { return this.ky @@ -72002,11 +70435,10 @@ You can use this token with any v1 API method in place of a bank account diction */ @aiFunction({ name: 'delete_webhook_endpoints_webhook_endpoint', - description: - '

You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.

.', + description: `

You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard.

.`, inputSchema: stripe.DeleteWebhookEndpointsWebhookEndpointParamsSchema }) - async DeleteWebhookEndpointsWebhookEndpoint( + async deleteWebhookEndpointsWebhookEndpoint( params: stripe.DeleteWebhookEndpointsWebhookEndpointParams ): Promise { return this.ky diff --git a/packages/openapi-to-ts/fixtures/generated/tic-tac-toe-client.ts b/packages/openapi-to-ts/fixtures/generated/tic-tac-toe-client.ts new file mode 100644 index 0000000..da719a8 --- /dev/null +++ b/packages/openapi-to-ts/fixtures/generated/tic-tac-toe-client.ts @@ -0,0 +1,138 @@ +/* eslint-disable unicorn/no-unreadable-iife */ +/* eslint-disable unicorn/no-array-reduce */ + +/** + * This file was auto-generated from an OpenAPI spec. + */ + +import { aiFunction,AIFunctionsProvider } from '@agentic/core' +import defaultKy, { type KyInstance } from 'ky' +import { z } from 'zod' + +export namespace tictactoe { + // ----------------------------------------------------------------------------- + // Component schemas + // ----------------------------------------------------------------------------- + + /** Winner of the game. `.` means nobody has won yet. */ + export const WinnerSchema = z + .enum(['.', 'X', 'O']) + .describe('Winner of the game. `.` means nobody has won yet.') + export type Winner = z.infer + + /** Possible values for a board square. `.` means empty square. */ + export const MarkSchema = z + .enum(['.', 'X', 'O']) + .describe('Possible values for a board square. `.` means empty square.') + export type Mark = z.infer + + export const BoardSchema = z + .array(z.array(MarkSchema).min(3).max(3)) + .min(3) + .max(3) + export type Board = z.infer + + export const StatusSchema = z.object({ + winner: WinnerSchema.optional(), + board: BoardSchema.optional() + }) + export type Status = z.infer + + // ----------------------------------------------------------------------------- + // Operation schemas + // ----------------------------------------------------------------------------- + + export const GetBoardParamsSchema = z.object({}) + export type GetBoardParams = z.infer + + export const GetBoardResponseSchema = StatusSchema + export type GetBoardResponse = z.infer + + export const GetSquareParamsSchema = z.object({}) + export type GetSquareParams = z.infer + + export const GetSquareResponseSchema = MarkSchema + export type GetSquareResponse = z.infer + + export const PutSquareParamsSchema = MarkSchema + export type PutSquareParams = z.infer + + export const PutSquareResponseSchema = StatusSchema + export type PutSquareResponse = z.infer +} + +/** + * Agentic TicTacToe client. + * + * This API allows writing down marks on a Tic Tac Toe board +and requesting the state of the board or of individual squares. +. + */ +export class TicTacToeClient extends AIFunctionsProvider { + protected readonly ky: KyInstance + + protected readonly apiBaseUrl: string + + constructor({ + apiBaseUrl, + ky = defaultKy + }: { + apiKey?: string + apiBaseUrl?: string + ky?: KyInstance + } = {}) { + super() + + this.apiBaseUrl = apiBaseUrl + + this.ky = ky.extend({ + prefixUrl: apiBaseUrl + }) + } + + /** + * Retrieves the current state of the board and the winner. + */ + @aiFunction({ + name: 'get_board', + description: `Retrieves the current state of the board and the winner.`, + inputSchema: tictactoe.GetBoardParamsSchema + }) + async getBoard( + _params: tictactoe.GetBoardParams + ): Promise { + return this.ky.get('/board').json() + } + + /** + * Retrieves the requested square. + */ + @aiFunction({ + name: 'get_square', + description: `Retrieves the requested square.`, + inputSchema: tictactoe.GetSquareParamsSchema + }) + async getSquare( + _params: tictactoe.GetSquareParams + ): Promise { + return this.ky + .get('/board/{row}/{column}') + .json() + } + + /** + * Places a mark on the board and retrieves the whole board and the winner (if any). + */ + @aiFunction({ + name: 'put_square', + description: `Places a mark on the board and retrieves the whole board and the winner (if any).`, + inputSchema: tictactoe.PutSquareParamsSchema + }) + async putSquare( + _params: tictactoe.PutSquareParams + ): Promise { + return this.ky + .put('/board/{row}/{column}') + .json() + } +} diff --git a/packages/openapi-to-ts/fixtures/openapi/3.1/pet-store.json b/packages/openapi-to-ts/fixtures/openapi/3.1/pet-store.json deleted file mode 100644 index 6c24125..0000000 --- a/packages/openapi-to-ts/fixtures/openapi/3.1/pet-store.json +++ /dev/null @@ -1,988 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "description": "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.", - "version": "1.0.0", - "title": "Swagger Petstore", - "termsOfService": "http://swagger.io/terms/", - "contact": { - "email": "apiteam@swagger.io" - }, - "license": { - "name": "Apache 2.0", - "url": "http://www.apache.org/licenses/LICENSE-2.0.html" - } - }, - "servers": [ - { - "url": "http://petstore.swagger.io/v2" - } - ], - "externalDocs": { - "description": "Find out more about Swagger", - "url": "http://swagger.io" - }, - "tags": [ - { - "name": "pet", - "description": "Everything about your Pets", - "externalDocs": { - "description": "Find out more", - "url": "http://swagger.io" - } - }, - { - "name": "store", - "description": "Access to Petstore orders" - }, - { - "name": "user", - "description": "Operations about user", - "externalDocs": { - "description": "Find out more about our store", - "url": "http://swagger.io" - } - } - ], - "paths": { - "/pet": { - "post": { - "tags": ["pet"], - "summary": "Add a new pet to the store", - "description": "", - "operationId": "addPet", - "parameters": [], - "responses": { - "405": { - "description": "Invalid input" - } - }, - "security": [ - { - "petstore_auth": ["write:pets", "read:pets"] - } - ], - "requestBody": { - "$ref": "#/components/requestBodies/Pet" - } - }, - "put": { - "tags": ["pet"], - "summary": "Update an existing pet", - "description": "", - "operationId": "updatePet", - "parameters": [], - "responses": { - "400": { - "description": "Invalid ID supplied" - }, - "404": { - "description": "Pet not found" - }, - "405": { - "description": "Validation exception" - } - }, - "security": [ - { - "petstore_auth": ["write:pets", "read:pets"] - } - ], - "requestBody": { - "$ref": "#/components/requestBodies/Pet" - } - } - }, - "/pet/findByStatus": { - "get": { - "tags": ["pet"], - "summary": "Finds Pets by status", - "description": "Multiple status values can be provided with comma separated strings", - "operationId": "findPetsByStatus", - "parameters": [ - { - "name": "status", - "in": "query", - "description": "Status values that need to be considered for filter", - "required": true, - "explode": true, - "schema": { - "type": "array", - "items": { - "type": "string", - "enum": ["available", "pending", "sold"], - "default": "available" - } - } - } - ], - "responses": { - "200": { - "description": "successful operation", - "content": { - "application/xml": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Pet" - } - } - }, - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Pet" - } - } - } - } - }, - "400": { - "description": "Invalid status value" - } - }, - "security": [ - { - "petstore_auth": ["write:pets", "read:pets"] - } - ] - } - }, - "/pet/findByTags": { - "get": { - "tags": ["pet"], - "summary": "Finds Pets by tags", - "description": "Muliple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.", - "operationId": "findPetsByTags", - "parameters": [ - { - "name": "tags", - "in": "query", - "description": "Tags to filter by", - "required": true, - "explode": true, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - } - ], - "responses": { - "200": { - "description": "successful operation", - "content": { - "application/xml": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Pet" - } - } - }, - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Pet" - } - } - } - } - }, - "400": { - "description": "Invalid tag value" - } - }, - "security": [ - { - "petstore_auth": ["write:pets", "read:pets"] - } - ], - "deprecated": true - } - }, - "/pet/{petId}": { - "get": { - "tags": ["pet"], - "summary": "Find pet by ID", - "description": "Returns a single pet", - "operationId": "getPetById", - "parameters": [ - { - "name": "petId", - "in": "path", - "description": "ID of pet to return", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "200": { - "description": "successful operation", - "content": { - "application/xml": { - "schema": { - "$ref": "#/components/schemas/Pet" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Pet" - } - } - } - }, - "400": { - "description": "Invalid ID supplied" - }, - "404": { - "description": "Pet not found" - }, - "default": { - "description": "successful response" - } - }, - "security": [ - { - "api_key": [] - } - ] - }, - "post": { - "tags": ["pet"], - "summary": "Updates a pet in the store with form data", - "description": "", - "operationId": "updatePetWithForm", - "parameters": [ - { - "name": "petId", - "in": "path", - "description": "ID of pet that needs to be updated", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "405": { - "description": "Invalid input" - } - }, - "security": [ - { - "petstore_auth": ["write:pets", "read:pets"] - } - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "properties": { - "name": { - "description": "Updated name of the pet", - "type": "string" - }, - "status": { - "description": "Updated status of the pet", - "type": "string" - } - } - } - } - } - } - }, - "delete": { - "tags": ["pet"], - "summary": "Deletes a pet", - "description": "", - "operationId": "deletePet", - "parameters": [ - { - "name": "api_key", - "in": "header", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "petId", - "in": "path", - "description": "Pet id to delete", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "400": { - "description": "Invalid ID supplied" - }, - "404": { - "description": "Pet not found" - } - }, - "security": [ - { - "petstore_auth": ["write:pets", "read:pets"] - } - ] - } - }, - "/pet/{petId}/uploadImage": { - "post": { - "tags": ["pet"], - "summary": "uploads an image", - "description": "", - "operationId": "uploadFile", - "parameters": [ - { - "name": "petId", - "in": "path", - "description": "ID of pet to update", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "200": { - "description": "successful operation", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiResponse" - } - } - } - } - }, - "security": [ - { - "petstore_auth": ["write:pets", "read:pets"] - } - ], - "requestBody": { - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - } - } - } - } - }, - "/store/inventory": { - "get": { - "tags": ["store"], - "summary": "Returns pet inventories by status", - "description": "Returns a map of status codes to quantities", - "operationId": "getInventory", - "parameters": [], - "responses": { - "200": { - "description": "successful operation", - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": { - "type": "integer", - "format": "int32" - } - } - } - } - } - }, - "security": [ - { - "api_key": [] - } - ] - } - }, - "/store/order": { - "post": { - "tags": ["store"], - "summary": "Place an order for a pet", - "description": "", - "operationId": "placeOrder", - "parameters": [], - "responses": { - "200": { - "description": "successful operation", - "content": { - "application/xml": { - "schema": { - "$ref": "#/components/schemas/Order" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Order" - } - } - } - }, - "400": { - "description": "Invalid Order" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Order" - } - } - }, - "description": "order placed for purchasing the pet", - "required": true - } - } - }, - "/store/order/{orderId}": { - "get": { - "tags": ["store"], - "summary": "Find purchase order by ID", - "description": "For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions", - "operationId": "getOrderById", - "parameters": [ - { - "name": "orderId", - "in": "path", - "description": "ID of pet that needs to be fetched", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "minimum": 1, - "maximum": 10 - } - } - ], - "responses": { - "200": { - "description": "successful operation", - "content": { - "application/xml": { - "schema": { - "$ref": "#/components/schemas/Order" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Order" - } - } - } - }, - "400": { - "description": "Invalid ID supplied" - }, - "404": { - "description": "Order not found" - } - } - }, - "delete": { - "tags": ["store"], - "summary": "Delete purchase order by ID", - "description": "For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors", - "operationId": "deleteOrder", - "parameters": [ - { - "name": "orderId", - "in": "path", - "description": "ID of the order that needs to be deleted", - "required": true, - "schema": { - "type": "integer", - "format": "int64", - "minimum": 1 - } - } - ], - "responses": { - "400": { - "description": "Invalid ID supplied" - }, - "404": { - "description": "Order not found" - } - } - } - }, - "/user": { - "post": { - "tags": ["user"], - "summary": "Create user", - "description": "This can only be done by the logged in user.", - "operationId": "createUser", - "parameters": [], - "responses": { - "default": { - "description": "successful operation" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/User" - } - } - }, - "description": "Created user object", - "required": true - } - } - }, - "/user/createWithArray": { - "post": { - "tags": ["user"], - "summary": "Creates list of users with given input array", - "description": "", - "operationId": "createUsersWithArrayInput", - "parameters": [], - "responses": { - "default": { - "description": "successful operation" - } - }, - "requestBody": { - "$ref": "#/components/requestBodies/UserArray" - } - } - }, - "/user/createWithList": { - "post": { - "tags": ["user"], - "summary": "Creates list of users with given input array", - "description": "", - "operationId": "createUsersWithListInput", - "parameters": [], - "responses": { - "default": { - "description": "successful operation" - } - }, - "requestBody": { - "$ref": "#/components/requestBodies/UserArray" - } - } - }, - "/user/login": { - "get": { - "tags": ["user"], - "summary": "Logs user into the system", - "description": "", - "operationId": "loginUser", - "parameters": [ - { - "name": "username", - "in": "query", - "description": "The user name for login", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "password", - "in": "query", - "description": "The password for login in clear text", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "successful operation", - "headers": { - "X-Rate-Limit": { - "description": "calls per hour allowed by the user", - "schema": { - "type": "integer", - "format": "int32" - } - }, - "X-Expires-After": { - "description": "date in UTC when token expires", - "schema": { - "type": "string", - "format": "date-time" - } - } - }, - "content": { - "application/xml": { - "schema": { - "type": "string" - } - }, - "application/json": { - "schema": { - "type": "string" - } - } - } - }, - "400": { - "description": "Invalid username/password supplied" - } - } - } - }, - "/user/logout": { - "get": { - "tags": ["user"], - "summary": "Logs out current logged in user session", - "description": "", - "operationId": "logoutUser", - "parameters": [], - "responses": { - "default": { - "description": "successful operation" - } - } - } - }, - "/user/{username}": { - "get": { - "tags": ["user"], - "summary": "Get user by user name", - "description": "", - "operationId": "getUserByName", - "parameters": [ - { - "name": "username", - "in": "path", - "description": "The name that needs to be fetched. Use user1 for testing. ", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "successful operation", - "content": { - "application/xml": { - "schema": { - "$ref": "#/components/schemas/User" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/User" - } - } - } - }, - "400": { - "description": "Invalid username supplied" - }, - "404": { - "description": "User not found" - } - } - }, - "put": { - "tags": ["user"], - "summary": "Updated user", - "description": "This can only be done by the logged in user.", - "operationId": "updateUser", - "parameters": [ - { - "name": "username", - "in": "path", - "description": "name that need to be updated", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "400": { - "description": "Invalid user supplied" - }, - "404": { - "description": "User not found" - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/User" - } - } - }, - "description": "Updated user object", - "required": true - } - }, - "delete": { - "tags": ["user"], - "summary": "Delete user", - "description": "This can only be done by the logged in user.", - "operationId": "deleteUser", - "parameters": [ - { - "name": "username", - "in": "path", - "description": "The name that needs to be deleted", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "400": { - "description": "Invalid username supplied" - }, - "404": { - "description": "User not found" - } - } - } - } - }, - "components": { - "schemas": { - "Order": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "petId": { - "type": "integer", - "format": "int64" - }, - "quantity": { - "type": "integer", - "format": "int32" - }, - "shipDate": { - "type": "string", - "format": "date-time" - }, - "status": { - "type": "string", - "description": "Order Status", - "enum": ["placed", "approved", "delivered"] - }, - "complete": { - "type": "boolean", - "default": false - } - }, - "xml": { - "name": "Order" - } - }, - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - }, - "xml": { - "name": "Category" - } - }, - "User": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "username": { - "type": "string" - }, - "firstName": { - "type": "string" - }, - "lastName": { - "type": "string" - }, - "email": { - "type": "string" - }, - "password": { - "type": "string" - }, - "phone": { - "type": "string" - }, - "userStatus": { - "type": "integer", - "format": "int32", - "description": "User Status" - } - }, - "xml": { - "name": "User" - } - }, - "Tag": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - }, - "xml": { - "name": "Tag" - } - }, - "Pet": { - "type": "object", - "required": ["name", "photoUrls"], - "properties": { - "id": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "category": { - "$ref": "#/components/schemas/Category" - }, - "name": { - "type": "string", - "example": "doggie" - }, - "photoUrls": { - "type": "array", - "xml": { - "name": "photoUrl", - "wrapped": true - }, - "items": { - "type": "string" - } - }, - "tags": { - "type": "array", - "xml": { - "name": "tag", - "wrapped": true - }, - "items": { - "$ref": "#/components/schemas/Tag" - } - }, - "status": { - "type": "string", - "description": "pet status in the store", - "enum": ["available", "pending", "sold"] - } - }, - "xml": { - "name": "Pet" - } - }, - "ApiResponse": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "type": { - "type": "string" - }, - "message": { - "type": "string" - } - } - } - }, - "requestBodies": { - "Pet": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Pet" - } - }, - "application/xml": { - "schema": { - "$ref": "#/components/schemas/Pet" - } - } - }, - "description": "Pet object that needs to be added to the store", - "required": true - }, - "UserArray": { - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/User" - } - } - } - }, - "description": "List of user object", - "required": true - } - }, - "securitySchemes": { - "petstore_auth": { - "type": "oauth2", - "flows": { - "implicit": { - "authorizationUrl": "http://petstore.swagger.io/oauth/dialog", - "scopes": { - "write:pets": "modify pets in your account", - "read:pets": "read your pets" - } - } - } - }, - "api_key": { - "type": "apiKey", - "name": "api_key", - "in": "header" - } - } - } -} diff --git a/packages/openapi-to-ts/fixtures/openapi/3.1/security.json b/packages/openapi-to-ts/fixtures/openapi/3.1/security.json deleted file mode 100644 index e5fc59c..0000000 --- a/packages/openapi-to-ts/fixtures/openapi/3.1/security.json +++ /dev/null @@ -1,397 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "version": "1.0.0", - "title": "Support for different security types", - "description": "https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#securitySchemeObject" - }, - "servers": [ - { - "url": "https://httpbin.org" - } - ], - "tags": [ - { - "name": "API Key" - }, - { - "name": "HTTP" - }, - { - "name": "Mutual TLS" - }, - { - "name": "OAuth 2" - }, - { - "name": "OpenID Connect" - }, - { - "name": "Other" - } - ], - "paths": { - "/anything/apiKey": { - "get": { - "summary": "Query parameter", - "description": "`apiKey` auth will be supplied within an `apiKey` query parameter.", - "tags": ["API Key"], - "responses": { - "200": { - "description": "OK" - } - }, - "security": [ - { - "apiKey_query": [] - } - ] - }, - "post": { - "summary": "Cookie", - "description": "`apiKey` auth will be supplied within an `api_key` cookie.", - "tags": ["API Key"], - "responses": { - "200": { - "description": "OK" - } - }, - "security": [ - { - "apiKey_cookie": [] - } - ] - }, - "put": { - "summary": "Header", - "description": "`apiKey` auth will be supplied within an `X-API-KEY` header.", - "tags": ["API Key"], - "responses": { - "200": { - "description": "OK" - } - }, - "security": [ - { - "apiKey_header": [] - } - ] - } - }, - "/anything/basic": { - "post": { - "summary": "Basic", - "description": "Authentication credentials will be supplied within a `Basic` `Authorization` header.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#basic-authentication-sample", - "tags": ["HTTP"], - "responses": { - "200": { - "description": "OK" - } - }, - "security": [ - { - "basic": [] - } - ] - } - }, - "/anything/bearer": { - "post": { - "summary": "Bearer", - "description": "Authentication credentials will be supplied within a `Bearer` `Authorization` header.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#basic-authentication-sample", - "tags": ["HTTP"], - "responses": { - "200": { - "description": "OK" - } - }, - "security": [ - { - "bearer": [] - } - ] - }, - "put": { - "summary": "Bearer (`jwt` format)", - "description": "Authentication credentials will be supplied within a `Bearer` `Authorization` header, but its data should be controlled as a JWT.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#basic-authentication-sample\n\n> ℹ️We currently do not support any special handling for this so they're handled as a standard `Bearer` authentication token.", - "responses": { - "200": { - "description": "OK" - } - }, - "security": [ - { - "bearer_jwt": [] - } - ] - } - }, - "/anything/mutualTLS": { - "post": { - "summary": "`mutualTLS` auth", - "description": "🚧 This is not supported.", - "tags": ["Mutual TLS"], - "responses": { - "200": { - "description": "OK" - } - }, - "security": [ - { - "mutualTLS": [] - } - ] - } - }, - "/anything/oauth2": { - "post": { - "summary": "General support (all flow types)", - "description": "> ℹ️\n> We currently do not handle OAuth 2 authentication flows so if an operation has an `oauth2` requirement we assume that the user, or the projects JWT, has a qualified `bearer` token and will use that.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#fixed-fields-23", - "tags": ["OAuth 2"], - "responses": { - "200": { - "description": "OK" - } - }, - "security": [ - { - "oauth2": ["write:things"] - } - ] - }, - "get": { - "summary": "General support (authorizationCode flow type)", - "description": "> ℹ️\n> We currently do not handle OAuth 2 authentication flows so if an operation has an `oauth2` requirement we assume that the user, or the projects JWT, has a qualified `bearer` token and will use that.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#fixed-fields-23", - "tags": ["OAuth 2"], - "responses": { - "200": { - "description": "OK" - } - }, - "security": [ - { - "oauth2_authorizationCode": ["write:things"] - } - ] - }, - "put": { - "summary": "General support (clientCredentials flow type)", - "description": "> ℹ️\n> We currently do not handle OAuth 2 authentication flows so if an operation has an `oauth2` requirement we assume that the user, or the projects JWT, has a qualified `bearer` token and will use that.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#fixed-fields-23", - "tags": ["OAuth 2"], - "responses": { - "200": { - "description": "OK" - } - }, - "security": [ - { - "oauth2_clientCredentials": ["write:things"] - } - ] - }, - "patch": { - "summary": "General support (implicit flow type)", - "description": "> ℹ️\n> We currently do not handle OAuth 2 authentication flows so if an operation has an `oauth2` requirement we assume that the user, or the projects JWT, has a qualified `bearer` token and will use that.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#fixed-fields-23", - "tags": ["OAuth 2"], - "responses": { - "200": { - "description": "OK" - } - }, - "security": [ - { - "oauth2_implicit": ["write:things"] - } - ] - }, - "delete": { - "summary": "General support (password flow type)", - "description": "> ℹ️\n> We currently do not handle OAuth 2 authentication flows so if an operation has an `oauth2` requirement we assume that the user, or the projects JWT, has a qualified `bearer` token and will use that.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#fixed-fields-23", - "tags": ["OAuth 2"], - "responses": { - "200": { - "description": "OK" - } - }, - "security": [ - { - "oauth2_password": ["write:things"] - } - ] - } - }, - "/anything/openIdConnect": { - "post": { - "summary": "General support", - "description": "🚧 This is not supported.", - "tags": ["OpenID Connect"], - "responses": { - "200": { - "description": "OK" - } - }, - "security": [ - { - "openIdConnect": [] - } - ] - } - }, - "/anything/no-auth": { - "post": { - "summary": "No auth requirements", - "description": "This operation does not have any authentication requirements.", - "tags": ["Other"], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/status/401": { - "post": { - "summary": "Forced invalid authentication", - "description": "This endpoint requires an authentication header but making any request to it will forcefully return a 401 status code for invalid auth.", - "tags": ["Other"], - "responses": { - "401": { - "description": "Unauthorized" - } - }, - "security": [ - { - "apiKey_header": [] - } - ] - } - } - }, - "components": { - "securitySchemes": { - "apiKey_cookie": { - "type": "apiKey", - "in": "cookie", - "name": "api_key", - "description": "An API key that will be supplied in a named cookie. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#security-scheme-object" - }, - "apiKey_header": { - "type": "apiKey", - "in": "header", - "name": "X-API-KEY", - "description": "An API key that will be supplied in a named header. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#security-scheme-object" - }, - "apiKey_query": { - "type": "apiKey", - "in": "query", - "name": "apiKey", - "description": "An API key that will be supplied in a named query parameter. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#security-scheme-object" - }, - "basic": { - "type": "http", - "scheme": "basic", - "description": "Basic auth that takes a base64'd combination of `user:password`. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#basic-authentication-sample" - }, - "bearer": { - "type": "http", - "scheme": "bearer", - "description": "A bearer token that will be supplied within an `Authentication` header as `bearer `. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#basic-authentication-sample" - }, - "bearer_jwt": { - "type": "http", - "scheme": "bearer", - "bearerFormat": "JWT", - "description": "A bearer token that will be supplied within an `Authentication` header as `bearer `. In this case, the format of the token is specified as JWT. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#jwt-bearer-sample" - }, - "mutualTLS": { - "type": "mutualTLS", - "description": "Requires a specific mutual TLS certificate to use when making a HTTP request. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#fixed-fields-23" - }, - "oauth2": { - "type": "oauth2", - "description": "An OAuth 2 security flow. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#fixed-fields-23", - "flows": { - "authorizationCode": { - "authorizationUrl": "http://example.com/oauth/dialog", - "tokenUrl": "http://example.com/oauth/token", - "scopes": { - "write:things": "Add things to your account" - } - }, - "clientCredentials": { - "tokenUrl": "http://example.com/oauth/token", - "scopes": { - "write:things": "Add things to your account" - } - }, - "implicit": { - "authorizationUrl": "http://example.com/oauth/dialog", - "scopes": { - "write:things": "Add things to your account" - } - }, - "password": { - "tokenUrl": "http://example.com/oauth/token", - "scopes": { - "write:things": "Add things to your account" - } - } - } - }, - "oauth2_authorizationCode": { - "type": "oauth2", - "description": "An OAuth 2 security flow that only supports the `authorizationCode` flow type. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#oauth-flows-object", - "flows": { - "authorizationCode": { - "authorizationUrl": "http://alt.example.com/oauth/dialog", - "tokenUrl": "http://alt.example.com/oauth/token", - "scopes": { - "write:things": "Add things to your account" - } - } - } - }, - "oauth2_clientCredentials": { - "type": "oauth2", - "description": "An OAuth 2 security flow that only supports the `clientCredentials` flow type. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#oauth-flows-object", - "flows": { - "clientCredentials": { - "tokenUrl": "http://alt.example.com/oauth/token", - "scopes": { - "write:things": "Add things to your account" - } - } - } - }, - "oauth2_implicit": { - "type": "oauth2", - "description": "An OAuth 2 security flow that only supports the `implicit` flow type. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#oauth-flows-object", - "flows": { - "implicit": { - "authorizationUrl": "http://alt.example.com/oauth/dialog", - "scopes": { - "write:things": "Add things to your account" - } - } - } - }, - "oauth2_password": { - "type": "oauth2", - "description": "An OAuth 2 security flow that only supports the `password` flow type. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#oauth-flows-object", - "flows": { - "password": { - "tokenUrl": "http://alt.example.com/oauth/token", - "scopes": { - "write:things": "Add things to your account" - } - } - } - }, - "openIdConnect": { - "type": "openIdConnect", - "openIdConnectUrl": "https://example.com/.well-known/openid-configuration", - "description": "OpenAPI authentication. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#fixed-fields-23" - } - } - } -} diff --git a/packages/openapi-to-ts/fixtures/openapi/3.0/firecrawl.json b/packages/openapi-to-ts/fixtures/openapi/firecrawl.json similarity index 100% rename from packages/openapi-to-ts/fixtures/openapi/3.0/firecrawl.json rename to packages/openapi-to-ts/fixtures/openapi/firecrawl.json diff --git a/packages/openapi-to-ts/fixtures/openapi/3.0/github.json b/packages/openapi-to-ts/fixtures/openapi/github.json similarity index 100% rename from packages/openapi-to-ts/fixtures/openapi/3.0/github.json rename to packages/openapi-to-ts/fixtures/openapi/github.json diff --git a/packages/openapi-to-ts/fixtures/openapi/3.0/notion.json b/packages/openapi-to-ts/fixtures/openapi/notion.json similarity index 100% rename from packages/openapi-to-ts/fixtures/openapi/3.0/notion.json rename to packages/openapi-to-ts/fixtures/openapi/notion.json diff --git a/packages/openapi-to-ts/fixtures/openapi/3.0/pet-store.json b/packages/openapi-to-ts/fixtures/openapi/pet-store.json similarity index 100% rename from packages/openapi-to-ts/fixtures/openapi/3.0/pet-store.json rename to packages/openapi-to-ts/fixtures/openapi/pet-store.json diff --git a/packages/openapi-to-ts/fixtures/openapi/3.0/petstore-expanded.json b/packages/openapi-to-ts/fixtures/openapi/petstore-expanded.json similarity index 100% rename from packages/openapi-to-ts/fixtures/openapi/3.0/petstore-expanded.json rename to packages/openapi-to-ts/fixtures/openapi/petstore-expanded.json diff --git a/packages/openapi-to-ts/fixtures/openapi/3.0/readme.json b/packages/openapi-to-ts/fixtures/openapi/readme.json similarity index 100% rename from packages/openapi-to-ts/fixtures/openapi/3.0/readme.json rename to packages/openapi-to-ts/fixtures/openapi/readme.json diff --git a/packages/openapi-to-ts/fixtures/openapi/3.0/security.json b/packages/openapi-to-ts/fixtures/openapi/security.json similarity index 100% rename from packages/openapi-to-ts/fixtures/openapi/3.0/security.json rename to packages/openapi-to-ts/fixtures/openapi/security.json diff --git a/packages/openapi-to-ts/fixtures/openapi/3.0/stripe.json b/packages/openapi-to-ts/fixtures/openapi/stripe.json similarity index 100% rename from packages/openapi-to-ts/fixtures/openapi/3.0/stripe.json rename to packages/openapi-to-ts/fixtures/openapi/stripe.json diff --git a/packages/openapi-to-ts/fixtures/openapi/3.0/tic-tac-toe.json b/packages/openapi-to-ts/fixtures/openapi/tic-tac-toe.json similarity index 100% rename from packages/openapi-to-ts/fixtures/openapi/3.0/tic-tac-toe.json rename to packages/openapi-to-ts/fixtures/openapi/tic-tac-toe.json diff --git a/packages/openapi-to-ts/package.json b/packages/openapi-to-ts/package.json index 63d9d5c..86e9ac0 100644 --- a/packages/openapi-to-ts/package.json +++ b/packages/openapi-to-ts/package.json @@ -24,7 +24,8 @@ "clean": "del dist", "test": "run-s test:*", "test:lint": "eslint .", - "test:typecheck": "tsc --noEmit" + "test:typecheck": "tsc --noEmit", + "test:unit": "vitest run" }, "dependencies": { "@agentic/core": "workspace:*", diff --git a/packages/openapi-to-ts/src/__snapshots__/generate-ts-from-openapi.test.ts.snap b/packages/openapi-to-ts/src/__snapshots__/generate-ts-from-openapi.test.ts.snap new file mode 100644 index 0000000..c37a67f --- /dev/null +++ b/packages/openapi-to-ts/src/__snapshots__/generate-ts-from-openapi.test.ts.snap @@ -0,0 +1,6963 @@ +// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html + +exports[`openapi-to-ts > 3.0/firecrawl.json 1`] = ` +"/* eslint-disable unicorn/no-unreadable-iife */ +/* eslint-disable unicorn/no-array-reduce */ + +/** + * This file was auto-generated from an OpenAPI spec. + */ + +import { + AIFunctionsProvider, + aiFunction, + assert, + getEnv, + pick +} from '@agentic/core' +import defaultKy, { type KyInstance } from 'ky' +import { z } from 'zod' + +export namespace firecrawl { + export const apiBaseUrl = 'https://api.firecrawl.dev/v0' + + // ----------------------------------------------------------------------------- + // Component schemas + // ----------------------------------------------------------------------------- + + export const ScrapeResponseSchema = z.object({ + success: z.boolean().optional(), + /**Warning message to let you know of any issues.*/ + warning: z + .string() + .describe('Warning message to let you know of any issues.') + .optional(), + data: z + .object({ + /**Markdown content of the page if the \`markdown\` format was specified (default)*/ + markdown: z + .string() + .describe( + 'Markdown content of the page if the \`markdown\` format was specified (default)' + ) + .optional(), + /**HTML version of the content on page if the \`html\` format was specified*/ + html: z + .string() + .describe( + 'HTML version of the content on page if the \`html\` format was specified' + ) + .optional(), + /**Raw HTML content of the page if the \`rawHtml\` format was specified*/ + rawHtml: z + .string() + .describe( + 'Raw HTML content of the page if the \`rawHtml\` format was specified' + ) + .optional(), + /**Links on the page if the \`links\` format was specified*/ + links: z + .array(z.string().url()) + .describe('Links on the page if the \`links\` format was specified') + .optional(), + /**URL of the screenshot of the page if the \`screenshot\` or \`screenshot@fullSize\` format was specified*/ + screenshot: z + .string() + .describe( + 'URL of the screenshot of the page if the \`screenshot\` or \`screenshot@fullSize\` format was specified' + ) + .optional(), + metadata: z + .object({ + title: z.string().optional(), + description: z.string().optional(), + language: z.string().optional(), + sourceURL: z.string().url().optional(), + ' ': z.string().optional(), + /**The status code of the page*/ + statusCode: z + .number() + .int() + .describe('The status code of the page') + .optional(), + /**The error message of the page*/ + error: z + .string() + .describe('The error message of the page') + .optional() + }) + .optional() + }) + .optional() + }) + export type ScrapeResponse = z.infer + + export const CrawlResponseSchema = z.object({ + success: z.boolean().optional(), + id: z.string().optional(), + url: z.string().url().optional() + }) + export type CrawlResponse = z.infer + + export const SearchResponseSchema = z.object({ + success: z.boolean().optional(), + data: z.array(z.any()).optional() + }) + export type SearchResponse = z.infer + + export const CrawlStatusResponseObjSchema = z.object({ + /**Markdown content of the page if the \`markdown\` format was specified (default)*/ + markdown: z + .string() + .describe( + 'Markdown content of the page if the \`markdown\` format was specified (default)' + ) + .optional(), + /**HTML version of the content on page if the \`html\` format was specified*/ + html: z + .string() + .describe( + 'HTML version of the content on page if the \`html\` format was specified' + ) + .optional(), + /**Raw HTML content of the page if the \`rawHtml\` format was specified*/ + rawHtml: z + .string() + .describe( + 'Raw HTML content of the page if the \`rawHtml\` format was specified' + ) + .optional(), + /**Links on the page if the \`links\` format was specified*/ + links: z + .array(z.string().url()) + .describe('Links on the page if the \`links\` format was specified') + .optional(), + /**URL of the screenshot of the page if the \`screenshot\` or \`screenshot@fullSize\` format was specified*/ + screenshot: z + .string() + .describe( + 'URL of the screenshot of the page if the \`screenshot\` or \`screenshot@fullSize\` format was specified' + ) + .optional(), + metadata: z + .object({ + title: z.string().optional(), + description: z.string().optional(), + language: z.string().optional(), + sourceURL: z.string().url().optional(), + ' ': z.string().optional(), + /**The status code of the page*/ + statusCode: z + .number() + .int() + .describe('The status code of the page') + .optional(), + /**The error message of the page*/ + error: z.string().describe('The error message of the page').optional() + }) + .optional() + }) + export type CrawlStatusResponseObj = z.infer< + typeof CrawlStatusResponseObjSchema + > + + // ----------------------------------------------------------------------------- + // Operation schemas + // ----------------------------------------------------------------------------- + + export const ScrapeParamsSchema = z.object({ + /**The URL to scrape*/ + url: z.string().url().describe('The URL to scrape'), + /** + * Specific formats to return. + * + * - markdown: The page in Markdown format. + * - html: The page's HTML, trimmed to include only meaningful content. + * - rawHtml: The page's original HTML. + * - links: The links on the page. + * - screenshot: A screenshot of the top of the page. + * - screenshot@fullPage: A screenshot of the full page. (overridden by screenshot if present) + */ + formats: z + .array( + z.enum([ + 'markdown', + 'html', + 'rawHtml', + 'links', + 'screenshot', + 'screenshot@fullPage' + ]) + ) + .describe( + "Specific formats to return.\\n\\n - markdown: The page in Markdown format.\\n - html: The page's HTML, trimmed to include only meaningful content.\\n - rawHtml: The page's original HTML.\\n - links: The links on the page.\\n - screenshot: A screenshot of the top of the page.\\n - screenshot@fullPage: A screenshot of the full page. (overridden by screenshot if present)" + ) + .default(['markdown']), + /**Headers to send with the request. Can be used to send cookies, user-agent, etc.*/ + headers: z + .record(z.any()) + .describe( + 'Headers to send with the request. Can be used to send cookies, user-agent, etc.' + ) + .optional(), + /**Only include tags, classes and ids from the page in the final output. Use comma separated values. Example: 'script, .ad, #footer'*/ + includeTags: z + .array(z.string()) + .describe( + "Only include tags, classes and ids from the page in the final output. Use comma separated values. Example: 'script, .ad, #footer'" + ) + .optional(), + /**Tags, classes and ids to remove from the page. Use comma separated values. Example: 'script, .ad, #footer'*/ + excludeTags: z + .array(z.string()) + .describe( + "Tags, classes and ids to remove from the page. Use comma separated values. Example: 'script, .ad, #footer'" + ) + .optional(), + /**Only return the main content of the page excluding headers, navs, footers, etc.*/ + onlyMainContent: z + .boolean() + .describe( + 'Only return the main content of the page excluding headers, navs, footers, etc.' + ) + .default(true), + /**Timeout in milliseconds for the request*/ + timeout: z + .number() + .int() + .describe('Timeout in milliseconds for the request') + .default(30000), + /**Wait x amount of milliseconds for the page to load to fetch content*/ + waitFor: z + .number() + .int() + .describe( + 'Wait x amount of milliseconds for the page to load to fetch content' + ) + .default(0) + }) + export type ScrapeParams = z.infer + + export const CrawlUrlsParamsSchema = z.object({ + /**The base URL to start crawling from*/ + url: z.string().url().describe('The base URL to start crawling from'), + crawlerOptions: z + .object({ + /**URL patterns to include*/ + includes: z + .array(z.string()) + .describe('URL patterns to include') + .optional(), + /**URL patterns to exclude*/ + excludes: z + .array(z.string()) + .describe('URL patterns to exclude') + .optional(), + /**Generate alt text for images using LLMs (must have a paid plan)*/ + generateImgAltText: z + .boolean() + .describe( + 'Generate alt text for images using LLMs (must have a paid plan)' + ) + .default(false), + /**If true, returns only the URLs as a list on the crawl status. Attention: the return response will be a list of URLs inside the data, not a list of documents.*/ + returnOnlyUrls: z + .boolean() + .describe( + 'If true, returns only the URLs as a list on the crawl status. Attention: the return response will be a list of URLs inside the data, not a list of documents.' + ) + .default(false), + /**Maximum depth to crawl relative to the entered URL. A maxDepth of 0 scrapes only the entered URL. A maxDepth of 1 scrapes the entered URL and all pages one level deep. A maxDepth of 2 scrapes the entered URL and all pages up to two levels deep. Higher values follow the same pattern.*/ + maxDepth: z + .number() + .int() + .describe( + 'Maximum depth to crawl relative to the entered URL. A maxDepth of 0 scrapes only the entered URL. A maxDepth of 1 scrapes the entered URL and all pages one level deep. A maxDepth of 2 scrapes the entered URL and all pages up to two levels deep. Higher values follow the same pattern.' + ) + .optional(), + /**The crawling mode to use. Fast mode crawls 4x faster websites without sitemap, but may not be as accurate and shouldn't be used in heavy js-rendered websites.*/ + mode: z + .enum(['default', 'fast']) + .describe( + "The crawling mode to use. Fast mode crawls 4x faster websites without sitemap, but may not be as accurate and shouldn't be used in heavy js-rendered websites." + ) + .default('default'), + /**Ignore the website sitemap when crawling*/ + ignoreSitemap: z + .boolean() + .describe('Ignore the website sitemap when crawling') + .default(false), + /**Maximum number of pages to crawl*/ + limit: z + .number() + .int() + .describe('Maximum number of pages to crawl') + .default(10000), + /**Enables the crawler to navigate from a specific URL to previously linked pages. For instance, from 'example.com/product/123' back to 'example.com/product'*/ + allowBackwardCrawling: z + .boolean() + .describe( + "Enables the crawler to navigate from a specific URL to previously linked pages. For instance, from 'example.com/product/123' back to 'example.com/product'" + ) + .default(false), + /**Allows the crawler to follow links to external websites.*/ + allowExternalContentLinks: z + .boolean() + .describe('Allows the crawler to follow links to external websites.') + .default(false) + }) + .optional(), + pageOptions: z + .object({ + /**Headers to send with the request. Can be used to send cookies, user-agent, etc.*/ + headers: z + .record(z.any()) + .describe( + 'Headers to send with the request. Can be used to send cookies, user-agent, etc.' + ) + .optional(), + /**Include the HTML version of the content on page. Will output a html key in the response.*/ + includeHtml: z + .boolean() + .describe( + 'Include the HTML version of the content on page. Will output a html key in the response.' + ) + .default(false), + /**Include the raw HTML content of the page. Will output a rawHtml key in the response.*/ + includeRawHtml: z + .boolean() + .describe( + 'Include the raw HTML content of the page. Will output a rawHtml key in the response.' + ) + .default(false), + /**Only include tags, classes and ids from the page in the final output. Use comma separated values. Example: 'script, .ad, #footer'*/ + onlyIncludeTags: z + .array(z.string()) + .describe( + "Only include tags, classes and ids from the page in the final output. Use comma separated values. Example: 'script, .ad, #footer'" + ) + .optional(), + /**Only return the main content of the page excluding headers, navs, footers, etc.*/ + onlyMainContent: z + .boolean() + .describe( + 'Only return the main content of the page excluding headers, navs, footers, etc.' + ) + .default(false), + /**Tags, classes and ids to remove from the page. Use comma separated values. Example: 'script, .ad, #footer'*/ + removeTags: z + .array(z.string()) + .describe( + "Tags, classes and ids to remove from the page. Use comma separated values. Example: 'script, .ad, #footer'" + ) + .optional(), + /**Replace all relative paths with absolute paths for images and links*/ + replaceAllPathsWithAbsolutePaths: z + .boolean() + .describe( + 'Replace all relative paths with absolute paths for images and links' + ) + .default(false), + /**Include a screenshot of the top of the page that you are scraping.*/ + screenshot: z + .boolean() + .describe( + 'Include a screenshot of the top of the page that you are scraping.' + ) + .default(false), + /**Include a full page screenshot of the page that you are scraping.*/ + fullPageScreenshot: z + .boolean() + .describe( + 'Include a full page screenshot of the page that you are scraping.' + ) + .default(false), + /**Wait x amount of milliseconds for the page to load to fetch content*/ + waitFor: z + .number() + .int() + .describe( + 'Wait x amount of milliseconds for the page to load to fetch content' + ) + .default(0) + }) + .optional() + }) + export type CrawlUrlsParams = z.infer + + export const CrawlUrlsResponseSchema = CrawlResponseSchema + export type CrawlUrlsResponse = z.infer + + export const SearchGoogleParamsSchema = z.object({ + /**The query to search for*/ + query: z.string().url().describe('The query to search for'), + pageOptions: z + .object({ + /**Only return the main content of the page excluding headers, navs, footers, etc.*/ + onlyMainContent: z + .boolean() + .describe( + 'Only return the main content of the page excluding headers, navs, footers, etc.' + ) + .default(false), + /**Fetch the content of each page. If false, defaults to a basic fast serp API.*/ + fetchPageContent: z + .boolean() + .describe( + 'Fetch the content of each page. If false, defaults to a basic fast serp API.' + ) + .default(true), + /**Include the HTML version of the content on page. Will output a html key in the response.*/ + includeHtml: z + .boolean() + .describe( + 'Include the HTML version of the content on page. Will output a html key in the response.' + ) + .default(false), + /**Include the raw HTML content of the page. Will output a rawHtml key in the response.*/ + includeRawHtml: z + .boolean() + .describe( + 'Include the raw HTML content of the page. Will output a rawHtml key in the response.' + ) + .default(false) + }) + .optional(), + searchOptions: z + .object({ + /**Maximum number of results. Max is 20 during beta.*/ + limit: z + .number() + .int() + .describe('Maximum number of results. Max is 20 during beta.') + .optional() + }) + .optional() + }) + export type SearchGoogleParams = z.infer + + export const SearchGoogleResponseSchema = SearchResponseSchema + export type SearchGoogleResponse = z.infer + + export const GetCrawlStatusParamsSchema = z.object({ + /**ID of the crawl job*/ + jobId: z.string().describe('ID of the crawl job') + }) + export type GetCrawlStatusParams = z.infer + + export const GetCrawlStatusResponseSchema = z.object({ + /**Status of the job (completed, active, failed, paused)*/ + status: z + .string() + .describe('Status of the job (completed, active, failed, paused)') + .optional(), + /**Current page number*/ + current: z.number().int().describe('Current page number').optional(), + /**Total number of pages*/ + total: z.number().int().describe('Total number of pages').optional(), + /**Data returned from the job (null when it is in progress)*/ + data: z + .array(CrawlStatusResponseObjSchema) + .describe('Data returned from the job (null when it is in progress)') + .optional(), + /**Partial documents returned as it is being crawled (streaming). **This feature is currently in alpha - expect breaking changes** When a page is ready, it will append to the partial_data array, so there is no need to wait for the entire website to be crawled. When the crawl is done, partial_data will become empty and the result will be available in \`data\`. There is a max of 50 items in the array response. The oldest item (top of the array) will be removed when the new item is added to the array.*/ + partial_data: z + .array(CrawlStatusResponseObjSchema) + .describe( + 'Partial documents returned as it is being crawled (streaming). **This feature is currently in alpha - expect breaking changes** When a page is ready, it will append to the partial_data array, so there is no need to wait for the entire website to be crawled. When the crawl is done, partial_data will become empty and the result will be available in \`data\`. There is a max of 50 items in the array response. The oldest item (top of the array) will be removed when the new item is added to the array.' + ) + .optional() + }) + export type GetCrawlStatusResponse = z.infer< + typeof GetCrawlStatusResponseSchema + > + + export const CancelCrawlJobParamsSchema = z.object({ + /**ID of the crawl job*/ + jobId: z.string().describe('ID of the crawl job') + }) + export type CancelCrawlJobParams = z.infer + + export const CancelCrawlJobResponseSchema = z.object({ + /**Returns cancelled.*/ + status: z.string().describe('Returns cancelled.').optional() + }) + export type CancelCrawlJobResponse = z.infer< + typeof CancelCrawlJobResponseSchema + > +} + +/** + * Agentic Firecrawl client. + * + * API for interacting with Firecrawl services to perform web scraping and crawling tasks. + */ +export class FirecrawlClient extends AIFunctionsProvider { + protected readonly ky: KyInstance + protected readonly apiKey: string + protected readonly apiBaseUrl: string + + constructor({ + apiKey = getEnv('FIRECRAWL_API_KEY'), + apiBaseUrl = firecrawl.apiBaseUrl, + ky = defaultKy + }: { + apiKey?: string + apiBaseUrl?: string + ky?: KyInstance + } = {}) { + assert( + apiKey, + 'FirecrawlClient missing required "apiKey" (defaults to "FIRECRAWL_API_KEY")' + ) + super() + + this.apiKey = apiKey + this.apiBaseUrl = apiBaseUrl + + this.ky = ky.extend({ + prefixUrl: apiBaseUrl, + headers: { + Authorization: apiKey + } + }) + } + + /** + * Scrape a single URL. + */ + @aiFunction({ + name: 'scrape', + description: \`Scrape a single URL.\`, + inputSchema: firecrawl.ScrapeParamsSchema + }) + async scrape( + params: firecrawl.ScrapeParams + ): Promise { + return this.ky + .post('/scrape', { + json: pick( + params, + 'url', + 'formats', + 'headers', + 'includeTags', + 'excludeTags', + 'onlyMainContent', + 'timeout', + 'waitFor' + ) + }) + .json() + } + + /** + * Crawl multiple URLs based on options. + */ + @aiFunction({ + name: 'crawl_urls', + description: \`Crawl multiple URLs based on options.\`, + inputSchema: firecrawl.CrawlUrlsParamsSchema + }) + async crawlUrls( + params: firecrawl.CrawlUrlsParams + ): Promise { + return this.ky + .post('/crawl', { + json: pick(params, 'url', 'crawlerOptions', 'pageOptions') + }) + .json() + } + + /** + * Search for a keyword in Google, returns top page results with markdown content for each page. + */ + @aiFunction({ + name: 'search_google', + description: \`Search for a keyword in Google, returns top page results with markdown content for each page.\`, + inputSchema: firecrawl.SearchGoogleParamsSchema + }) + async searchGoogle( + params: firecrawl.SearchGoogleParams + ): Promise { + return this.ky + .post('/search', { + json: pick(params, 'query', 'pageOptions', 'searchOptions') + }) + .json() + } + + /** + * Get the status of a crawl job. + */ + @aiFunction({ + name: 'get_crawl_status', + description: \`Get the status of a crawl job.\`, + inputSchema: firecrawl.GetCrawlStatusParamsSchema + }) + async getCrawlStatus( + params: firecrawl.GetCrawlStatusParams + ): Promise { + return this.ky + .get(\`/crawl/status/\${params['jobId']}\`) + .json() + } + + /** + * Cancel a crawl job. + */ + @aiFunction({ + name: 'cancel_crawl_job', + description: \`Cancel a crawl job.\`, + inputSchema: firecrawl.CancelCrawlJobParamsSchema + }) + async cancelCrawlJob( + params: firecrawl.CancelCrawlJobParams + ): Promise { + return this.ky + .delete(\`/crawl/cancel/\${params['jobId']}\`) + .json() + } +} +" +`; + +exports[`openapi-to-ts > 3.0/notion.json 1`] = ` +"/* eslint-disable unicorn/no-unreadable-iife */ +/* eslint-disable unicorn/no-array-reduce */ + +/** + * This file was auto-generated from an OpenAPI spec. + */ + +import { + AIFunctionsProvider, + aiFunction, + assert, + getEnv, + pick, + sanitizeSearchParams +} from '@agentic/core' +import defaultKy, { type KyInstance } from 'ky' +import { z } from 'zod' + +export namespace notion { + export const apiBaseUrl = 'https://api.notion.so' + + // ----------------------------------------------------------------------------- + // Component schemas + // ----------------------------------------------------------------------------- + + export const UserObjectResponseSchema = z.object({ + object: z.literal('user'), + id: z.string(), + type: z.enum(['person', 'bot']), + name: z.string(), + avatar_url: z.string() + }) + export type UserObjectResponse = z.infer + + export const AnnotationRequestSchema = z.object({ + bold: z.boolean().optional(), + italic: z.boolean().optional(), + strikethrough: z.boolean().optional(), + underline: z.boolean().optional(), + code: z.boolean().optional(), + color: z + .enum([ + 'default', + 'gray', + 'brown', + 'orange', + 'yellow', + 'green', + 'blue', + 'purple', + 'pink', + 'red', + 'gray_background', + 'brown_background', + 'orange_background', + 'yellow_background', + 'green_background', + 'blue_background', + 'purple_background', + 'pink_background', + 'red_background' + ]) + .optional() + }) + export type AnnotationRequest = z.infer + + export const DateRequestSchema = z.object({ + start: z.string(), + end: z.union([z.string(), z.null()]).optional(), + time_zone: z.union([z.string(), z.null()]).optional() + }) + export type DateRequest = z.infer + + export const PageObjectResponseSchema = z.object({ + object: z.literal('page'), + id: z.string(), + created_time: z.string(), + last_edited_time: z.string(), + archived: z.boolean(), + url: z.string() + }) + export type PageObjectResponse = z.infer + + export const PartialPageObjectResponseSchema = z.object({ + object: z.literal('page'), + id: z.string() + }) + export type PartialPageObjectResponse = z.infer< + typeof PartialPageObjectResponseSchema + > + + export const PropertyItemObjectResponseSchema = z.object({ + type: z.string(), + id: z.string() + }) + export type PropertyItemObjectResponse = z.infer< + typeof PropertyItemObjectResponseSchema + > + + export const PartialBlockObjectResponseSchema = z.object({ + object: z.literal('block'), + id: z.string() + }) + export type PartialBlockObjectResponse = z.infer< + typeof PartialBlockObjectResponseSchema + > + + export const BlockObjectResponseSchema = z.object({ + object: z.literal('block'), + id: z.string(), + type: z.string(), + created_time: z.string(), + last_edited_time: z.string(), + has_children: z.boolean(), + archived: z.boolean() + }) + export type BlockObjectResponse = z.infer + + export const TitlePropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('title'), + title: z.record(z.any()) + }) + export type TitlePropertyResponse = z.infer< + typeof TitlePropertyResponseSchema + > + + export const RichTextPropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('rich_text'), + rich_text: z.record(z.any()) + }) + export type RichTextPropertyResponse = z.infer< + typeof RichTextPropertyResponseSchema + > + + export const NumberPropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('number'), + number: z.object({ format: z.string() }) + }) + export type NumberPropertyResponse = z.infer< + typeof NumberPropertyResponseSchema + > + + export const SelectOptionSchema = z.object({ + id: z.string(), + name: z.string(), + color: z.string() + }) + export type SelectOption = z.infer + + export const DatePropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('date'), + date: z.record(z.any()) + }) + export type DatePropertyResponse = z.infer + + export const PeoplePropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('people'), + people: z.record(z.any()) + }) + export type PeoplePropertyResponse = z.infer< + typeof PeoplePropertyResponseSchema + > + + export const FilePropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('files'), + files: z.record(z.any()) + }) + export type FilePropertyResponse = z.infer + + export const CheckboxPropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('checkbox'), + checkbox: z.record(z.any()) + }) + export type CheckboxPropertyResponse = z.infer< + typeof CheckboxPropertyResponseSchema + > + + export const UrlPropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('url'), + url: z.record(z.any()) + }) + export type UrlPropertyResponse = z.infer + + export const EmailPropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('email'), + email: z.record(z.any()) + }) + export type EmailPropertyResponse = z.infer< + typeof EmailPropertyResponseSchema + > + + export const PhoneNumberPropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('phone_number'), + phone_number: z.record(z.any()) + }) + export type PhoneNumberPropertyResponse = z.infer< + typeof PhoneNumberPropertyResponseSchema + > + + export const FormulaPropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('formula'), + formula: z.object({ expression: z.string() }) + }) + export type FormulaPropertyResponse = z.infer< + typeof FormulaPropertyResponseSchema + > + + export const RelationPropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('relation'), + relation: z.object({ + database_id: z.string(), + synced_property_name: z.string(), + synced_property_id: z.string() + }) + }) + export type RelationPropertyResponse = z.infer< + typeof RelationPropertyResponseSchema + > + + export const RollupPropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('rollup'), + rollup: z.object({ + relation_property_name: z.string(), + relation_property_id: z.string(), + rollup_property_name: z.string(), + rollup_property_id: z.string(), + function: z.string() + }) + }) + export type RollupPropertyResponse = z.infer< + typeof RollupPropertyResponseSchema + > + + export const CreatedTimePropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('created_time'), + created_time: z.record(z.any()) + }) + export type CreatedTimePropertyResponse = z.infer< + typeof CreatedTimePropertyResponseSchema + > + + export const CreatedByPropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('created_by'), + created_by: z.record(z.any()) + }) + export type CreatedByPropertyResponse = z.infer< + typeof CreatedByPropertyResponseSchema + > + + export const LastEditedTimePropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('last_edited_time'), + last_edited_time: z.record(z.any()) + }) + export type LastEditedTimePropertyResponse = z.infer< + typeof LastEditedTimePropertyResponseSchema + > + + export const LastEditedByPropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('last_edited_by'), + last_edited_by: z.record(z.any()) + }) + export type LastEditedByPropertyResponse = z.infer< + typeof LastEditedByPropertyResponseSchema + > + + export const PartialUserObjectResponseSchema = z.object({ + object: z.literal('user'), + id: z.string() + }) + export type PartialUserObjectResponse = z.infer< + typeof PartialUserObjectResponseSchema + > + + export const AnnotationResponseSchema = z.object({ + bold: z.boolean(), + italic: z.boolean(), + strikethrough: z.boolean(), + underline: z.boolean(), + code: z.boolean(), + color: z.enum([ + 'default', + 'gray', + 'brown', + 'orange', + 'yellow', + 'green', + 'blue', + 'purple', + 'pink', + 'red', + 'gray_background', + 'brown_background', + 'orange_background', + 'yellow_background', + 'green_background', + 'blue_background', + 'purple_background', + 'pink_background', + 'red_background' + ]) + }) + export type AnnotationResponse = z.infer + + export const DateResponseSchema = z.object({ + start: z.string(), + end: z.union([z.string(), z.null()]), + time_zone: z.union([z.string(), z.null()]) + }) + export type DateResponse = z.infer + + export const PropertyUpdateSchemaSchema = z.object({ + name: z.string().optional(), + type: z.string().optional() + }) + export type PropertyUpdateSchema = z.infer + + export const TextPropertyFilterSchema = z.object({ + equals: z.string().optional(), + does_not_equal: z.string().optional(), + contains: z.string().optional(), + does_not_contain: z.string().optional(), + starts_with: z.string().optional(), + ends_with: z.string().optional(), + is_empty: z.boolean().optional(), + is_not_empty: z.boolean().optional() + }) + export type TextPropertyFilter = z.infer + + export const NumberPropertyFilterSchema = z.object({ + equals: z.number().optional(), + does_not_equal: z.number().optional(), + greater_than: z.number().optional(), + less_than: z.number().optional(), + greater_than_or_equal_to: z.number().optional(), + less_than_or_equal_to: z.number().optional(), + is_empty: z.boolean().optional(), + is_not_empty: z.boolean().optional() + }) + export type NumberPropertyFilter = z.infer + + export const CheckboxPropertyFilterSchema = z.object({ + equals: z.boolean().optional(), + does_not_equal: z.boolean().optional() + }) + export type CheckboxPropertyFilter = z.infer< + typeof CheckboxPropertyFilterSchema + > + + export const SelectPropertyFilterSchema = z.object({ + equals: z.string().optional(), + does_not_equal: z.string().optional(), + is_empty: z.boolean().optional(), + is_not_empty: z.boolean().optional() + }) + export type SelectPropertyFilter = z.infer + + export const MultiSelectPropertyFilterSchema = z.object({ + contains: z.string().optional(), + does_not_contain: z.string().optional(), + is_empty: z.boolean().optional(), + is_not_empty: z.boolean().optional() + }) + export type MultiSelectPropertyFilter = z.infer< + typeof MultiSelectPropertyFilterSchema + > + + export const DatePropertyFilterSchema = z.object({ + equals: z.string().optional(), + before: z.string().optional(), + after: z.string().optional(), + on_or_before: z.string().optional(), + on_or_after: z.string().optional(), + past_week: z.any().optional(), + past_month: z.any().optional(), + past_year: z.any().optional(), + next_week: z.any().optional(), + next_month: z.any().optional(), + next_year: z.any().optional(), + is_empty: z.boolean().optional(), + is_not_empty: z.boolean().optional() + }) + export type DatePropertyFilter = z.infer + + export const PeoplePropertyFilterSchema = z.object({ + contains: z.string().optional(), + does_not_contain: z.string().optional(), + is_empty: z.boolean().optional(), + is_not_empty: z.boolean().optional() + }) + export type PeoplePropertyFilter = z.infer + + export const FilesPropertyFilterSchema = z.object({ + is_empty: z.boolean().optional(), + is_not_empty: z.boolean().optional() + }) + export type FilesPropertyFilter = z.infer + + export const RelationPropertyFilterSchema = z.object({ + contains: z.string().optional(), + does_not_contain: z.string().optional(), + is_empty: z.boolean().optional(), + is_not_empty: z.boolean().optional() + }) + export type RelationPropertyFilter = z.infer< + typeof RelationPropertyFilterSchema + > + + export const PropertySchemaSchema = z.object({ + type: z.string(), + name: z.union([z.string(), z.null()]).optional() + }) + export type PropertySchema = z.infer + + export const SearchParametersSchema = z.object({ + query: z.string().optional(), + sort: z + .object({ + direction: z.enum(['ascending', 'descending']), + timestamp: z.literal('last_edited_time') + }) + .optional(), + filter: z + .object({ + value: z.enum(['page', 'database']), + property: z.literal('object') + }) + .optional(), + start_cursor: z.string().optional(), + page_size: z.number().int().optional() + }) + export type SearchParameters = z.infer + + export const PartialCommentObjectResponseSchema = z.object({ + object: z.literal('comment'), + id: z.string() + }) + export type PartialCommentObjectResponse = z.infer< + typeof PartialCommentObjectResponseSchema + > + + export const OauthTokenParametersSchema = z.object({ + grant_type: z.string(), + code: z.string(), + redirect_uri: z.string().optional(), + external_account: z.object({ key: z.string(), name: z.string() }).optional() + }) + export type OauthTokenParameters = z.infer + + export const ListUsersResponseSchema = z.object({ + results: z.array(UserObjectResponseSchema), + next_cursor: z.union([z.string(), z.null()]), + has_more: z.boolean() + }) + export type ListUsersResponse = z.infer + + export const PropertyItemListResponseSchema = z.object({ + results: z.array(PropertyItemObjectResponseSchema), + next_cursor: z.union([z.string(), z.null()]), + has_more: z.boolean() + }) + export type PropertyItemListResponse = z.infer< + typeof PropertyItemListResponseSchema + > + + export const SelectPropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('select'), + select: z.object({ options: z.array(SelectOptionSchema) }) + }) + export type SelectPropertyResponse = z.infer< + typeof SelectPropertyResponseSchema + > + + export const MultiSelectPropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('multi_select'), + multi_select: z.object({ options: z.array(SelectOptionSchema) }) + }) + export type MultiSelectPropertyResponse = z.infer< + typeof MultiSelectPropertyResponseSchema + > + + export const TextRichTextItemResponseSchema = z.object({ + type: z.literal('text'), + text: z.object({ + content: z.string(), + link: z.union([z.object({ url: z.string() }), z.null()]) + }), + annotations: AnnotationResponseSchema, + plain_text: z.string(), + href: z.union([z.string(), z.null()]) + }) + export type TextRichTextItemResponse = z.infer< + typeof TextRichTextItemResponseSchema + > + + export const EquationRichTextItemResponseSchema = z.object({ + type: z.literal('equation'), + equation: z.object({ expression: z.string() }), + annotations: AnnotationResponseSchema, + plain_text: z.string(), + href: z.union([z.string(), z.null()]) + }) + export type EquationRichTextItemResponse = z.infer< + typeof EquationRichTextItemResponseSchema + > + + export const ListBlockChildrenResponseSchema = z.object({ + object: z.literal('list'), + results: z.array( + z.union([PartialBlockObjectResponseSchema, BlockObjectResponseSchema]) + ), + next_cursor: z.union([z.string(), z.null()]), + has_more: z.boolean() + }) + export type ListBlockChildrenResponse = z.infer< + typeof ListBlockChildrenResponseSchema + > + + export const AppendBlockChildrenResponseSchema = z.object({ + object: z.literal('list'), + results: z.array( + z.union([PartialBlockObjectResponseSchema, BlockObjectResponseSchema]) + ), + next_cursor: z.union([z.string(), z.null()]), + has_more: z.boolean() + }) + export type AppendBlockChildrenResponse = z.infer< + typeof AppendBlockChildrenResponseSchema + > + + export const QueryDatabaseResponseSchema = z.object({ + object: z.literal('list'), + results: z.array( + z.union([PageObjectResponseSchema, PartialPageObjectResponseSchema]) + ), + next_cursor: z.union([z.string(), z.null()]), + has_more: z.boolean() + }) + export type QueryDatabaseResponse = z.infer< + typeof QueryDatabaseResponseSchema + > + + export const OauthTokenResponseSchema = z.object({ + access_token: z.string(), + token_type: z.literal('bearer'), + bot_id: z.string(), + workspace_name: z.union([z.string(), z.null()]), + workspace_icon: z.union([z.string(), z.null()]), + workspace_id: z.string(), + owner: z.union([ + z.object({ + type: z.literal('user'), + user: z.union([ + UserObjectResponseSchema, + PartialUserObjectResponseSchema + ]) + }), + z.object({ type: z.literal('workspace'), workspace: z.literal(true) }) + ]), + duplicated_template_id: z.union([z.string(), z.null()]) + }) + export type OauthTokenResponse = z.infer + + export const RichTextItemRequestSchema = z.union([ + z.object({ + text: z.object({ + content: z.string(), + link: z.union([z.object({ url: z.string() }), z.null()]).optional() + }), + type: z.literal('text').optional(), + annotations: AnnotationRequestSchema.optional() + }), + z.object({ + mention: z.union([ + z.object({ + user: z.union([ + z.object({ id: z.string() }), + UserObjectResponseSchema + ]) + }), + z.object({ page: z.object({ id: z.string() }) }), + z.object({ database: z.object({ id: z.string() }) }), + z.object({ date: DateRequestSchema }) + ]), + type: z.literal('mention').optional(), + annotations: AnnotationRequestSchema.optional() + }), + z.object({ + equation: z.object({ expression: z.string() }), + type: z.literal('equation').optional(), + annotations: AnnotationRequestSchema.optional() + }) + ]) + export type RichTextItemRequest = z.infer + + export const CreatePageParametersSchema = z.object({ + parent: z + .record(z.any()) + .and( + z.union([ + z.object({ type: z.literal('page_id'), page_id: z.string() }), + z.object({ type: z.literal('database_id'), database_id: z.string() }) + ]) + ), + properties: z.record( + z.union([ + z.object({ title: z.array(RichTextItemRequestSchema) }), + z.object({ rich_text: z.array(RichTextItemRequestSchema) }), + z.object({ number: z.union([z.number(), z.null()]) }), + z.object({ + select: z.union([z.object({ name: z.string() }), z.null()]) + }) + ]) + ) + }) + export type CreatePageParameters = z.infer + + export const UpdatePageParametersSchema = z.object({ + properties: z + .record( + z.union([ + z.object({ title: z.array(RichTextItemRequestSchema) }), + z.object({ rich_text: z.array(RichTextItemRequestSchema) }), + z.object({ number: z.union([z.number(), z.null()]) }), + z.object({ + select: z.union([z.object({ name: z.string() }), z.null()]) + }) + ]) + ) + .optional(), + archived: z.boolean().optional() + }) + export type UpdatePageParameters = z.infer + + export const UpdateBlockParametersSchema = z.object({ + paragraph: z + .object({ + rich_text: z.array(RichTextItemRequestSchema).optional(), + color: z.string().optional() + }) + .optional(), + heading_1: z + .object({ + rich_text: z.array(RichTextItemRequestSchema).optional(), + color: z.string().optional() + }) + .optional(), + heading_2: z + .object({ + rich_text: z.array(RichTextItemRequestSchema).optional(), + color: z.string().optional() + }) + .optional(), + heading_3: z + .object({ + rich_text: z.array(RichTextItemRequestSchema).optional(), + color: z.string().optional() + }) + .optional(), + bulleted_list_item: z + .object({ + rich_text: z.array(RichTextItemRequestSchema).optional(), + color: z.string().optional() + }) + .optional(), + numbered_list_item: z + .object({ + rich_text: z.array(RichTextItemRequestSchema).optional(), + color: z.string().optional() + }) + .optional(), + quote: z + .object({ + rich_text: z.array(RichTextItemRequestSchema).optional(), + color: z.string().optional() + }) + .optional(), + to_do: z + .object({ + rich_text: z.array(RichTextItemRequestSchema).optional(), + checked: z.boolean().optional(), + color: z.string().optional() + }) + .optional(), + toggle: z + .object({ + rich_text: z.array(RichTextItemRequestSchema).optional(), + color: z.string().optional() + }) + .optional(), + code: z + .object({ + rich_text: z.array(RichTextItemRequestSchema).optional(), + language: z.string().optional() + }) + .optional(), + embed: z.object({ url: z.string().optional() }).optional(), + image: z + .object({ external: z.object({ url: z.string().optional() }).optional() }) + .optional(), + video: z + .object({ external: z.object({ url: z.string().optional() }).optional() }) + .optional(), + file: z + .object({ external: z.object({ url: z.string().optional() }).optional() }) + .optional(), + pdf: z + .object({ external: z.object({ url: z.string().optional() }).optional() }) + .optional(), + bookmark: z.object({ url: z.string().optional() }).optional(), + equation: z.object({ expression: z.string().optional() }).optional(), + divider: z.record(z.any()).optional(), + table_of_contents: z.object({ color: z.string().optional() }).optional(), + breadcrumb: z.record(z.any()).optional(), + column_list: z.record(z.any()).optional(), + column: z.record(z.any()).optional(), + link_to_page: z + .object({ + type: z.enum(['page_id', 'database_id']).optional(), + page_id: z.string().optional(), + database_id: z.string().optional() + }) + .optional(), + table_row: z + .object({ cells: z.array(z.array(RichTextItemRequestSchema)).optional() }) + .optional(), + archived: z.boolean().optional() + }) + export type UpdateBlockParameters = z.infer< + typeof UpdateBlockParametersSchema + > + + export const BlockObjectRequestSchema = z.union([ + z.object({ + object: z.literal('block'), + type: z.literal('paragraph'), + paragraph: z.object({ + rich_text: z.array(RichTextItemRequestSchema), + color: z.string().optional() + }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('heading_1'), + heading_1: z.object({ + rich_text: z.array(RichTextItemRequestSchema), + color: z.string().optional() + }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('heading_2'), + heading_2: z.object({ + rich_text: z.array(RichTextItemRequestSchema), + color: z.string().optional() + }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('heading_3'), + heading_3: z.object({ + rich_text: z.array(RichTextItemRequestSchema), + color: z.string().optional() + }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('bulleted_list_item'), + bulleted_list_item: z.object({ + rich_text: z.array(RichTextItemRequestSchema), + color: z.string().optional() + }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('numbered_list_item'), + numbered_list_item: z.object({ + rich_text: z.array(RichTextItemRequestSchema), + color: z.string().optional() + }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('to_do'), + to_do: z.object({ + rich_text: z.array(RichTextItemRequestSchema), + checked: z.boolean(), + color: z.string().optional() + }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('toggle'), + toggle: z.object({ + rich_text: z.array(RichTextItemRequestSchema), + color: z.string().optional() + }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('code'), + code: z.object({ + rich_text: z.array(RichTextItemRequestSchema), + language: z.string(), + caption: z.array(RichTextItemRequestSchema).optional() + }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('child_page'), + child_page: z.object({ title: z.string() }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('child_database'), + child_database: z.object({ title: z.string() }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('embed'), + embed: z.object({ + url: z.string(), + caption: z.array(RichTextItemRequestSchema).optional() + }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('image'), + image: z.object({ + external: z.object({ url: z.string() }), + caption: z.array(RichTextItemRequestSchema).optional() + }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('video'), + video: z.object({ + external: z.object({ url: z.string() }), + caption: z.array(RichTextItemRequestSchema).optional() + }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('file'), + file: z.object({ + external: z.object({ url: z.string() }), + caption: z.array(RichTextItemRequestSchema).optional() + }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('pdf'), + pdf: z.object({ + external: z.object({ url: z.string() }), + caption: z.array(RichTextItemRequestSchema).optional() + }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('bookmark'), + bookmark: z.object({ + url: z.string(), + caption: z.array(RichTextItemRequestSchema).optional() + }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('equation'), + equation: z.object({ expression: z.string() }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('divider'), + divider: z.record(z.any()) + }), + z.object({ + object: z.literal('block'), + type: z.literal('table_of_contents'), + table_of_contents: z.object({ color: z.string().optional() }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('column_list'), + column_list: z.record(z.any()) + }), + z.object({ + object: z.literal('block'), + type: z.literal('column'), + column: z.record(z.any()) + }), + z.object({ + object: z.literal('block'), + type: z.literal('link_to_page'), + link_to_page: z.union([ + z.object({ type: z.literal('page_id'), page_id: z.string() }), + z.object({ type: z.literal('database_id'), database_id: z.string() }) + ]) + }), + z.object({ + object: z.literal('block'), + type: z.literal('table'), + table: z.object({ + table_width: z.number().int(), + has_column_header: z.boolean().optional(), + has_row_header: z.boolean().optional(), + children: z.array( + // TODO: Support recursive types for \`BlockObjectRequestSchema\`. + z.any() + ) + }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('table_row'), + table_row: z.object({ + cells: z.array(z.array(RichTextItemRequestSchema)) + }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('synced_block'), + synced_block: z.object({ + synced_from: z + .union([ + z.object({ type: z.literal('block_id'), block_id: z.string() }), + z.null() + ]) + .optional(), + children: z + .array( + // TODO: Support recursive types for \`BlockObjectRequestSchema\`. + z.any() + ) + .optional() + }) + }) + ]) + export type BlockObjectRequest = z.infer + + export const MentionRichTextItemResponseSchema = z.object({ + type: z.literal('mention'), + mention: z.union([ + z.object({ + type: z.literal('user'), + user: z.union([ + PartialUserObjectResponseSchema, + UserObjectResponseSchema + ]) + }), + z.object({ type: z.literal('date'), date: DateResponseSchema }), + z.object({ + type: z.literal('link_preview'), + link_preview: z.object({ url: z.string() }) + }), + z.object({ type: z.literal('page'), page: z.object({ id: z.string() }) }), + z.object({ + type: z.literal('database'), + database: z.object({ id: z.string() }) + }) + ]), + annotations: AnnotationResponseSchema, + plain_text: z.string(), + href: z.union([z.string(), z.null()]) + }) + export type MentionRichTextItemResponse = z.infer< + typeof MentionRichTextItemResponseSchema + > + + export const CreateCommentParametersSchema = z.union([ + z.object({ + parent: z.object({ + page_id: z.string(), + type: z.literal('page_id').optional() + }), + rich_text: z.array(RichTextItemRequestSchema) + }), + z.object({ + discussion_id: z.string(), + rich_text: z.array(RichTextItemRequestSchema) + }) + ]) + export type CreateCommentParameters = z.infer< + typeof CreateCommentParametersSchema + > + + export const AppendBlockChildrenParametersSchema = z.object({ + children: z.array(BlockObjectRequestSchema) + }) + export type AppendBlockChildrenParameters = z.infer< + typeof AppendBlockChildrenParametersSchema + > + + export const UpdateDatabaseParametersSchema = z.object({ + title: z.array(RichTextItemRequestSchema).optional(), + description: z.array(RichTextItemRequestSchema).optional(), + icon: z + .union([ + z.object({ emoji: z.string(), type: z.literal('emoji') }), + z.object({ + external: z.object({ url: z.string() }), + type: z.literal('external') + }), + z.null() + ]) + .optional(), + cover: z + .union([ + z.object({ + external: z.object({ url: z.string() }), + type: z.literal('external') + }), + z.null() + ]) + .optional(), + properties: z.record(PropertyUpdateSchemaSchema).optional(), + is_inline: z.boolean().optional(), + archived: z.boolean().optional() + }) + export type UpdateDatabaseParameters = z.infer< + typeof UpdateDatabaseParametersSchema + > + + export const CreateDatabaseParametersSchema = z.object({ + parent: z.union([ + z.object({ type: z.literal('page_id'), page_id: z.string() }), + z.object({ type: z.literal('database_id'), database_id: z.string() }) + ]), + properties: z.record(PropertySchemaSchema), + icon: z + .union([ + z.object({ type: z.literal('emoji'), emoji: z.string() }), + z.object({ + type: z.literal('external'), + external: z.object({ url: z.string() }) + }), + z.null() + ]) + .optional(), + cover: z + .union([ + z.object({ + type: z.literal('external'), + external: z.object({ url: z.string() }) + }), + z.null() + ]) + .optional(), + title: z.array(RichTextItemRequestSchema), + description: z.array(RichTextItemRequestSchema).optional(), + is_inline: z.boolean().optional() + }) + export type CreateDatabaseParameters = z.infer< + typeof CreateDatabaseParametersSchema + > + + export const RichTextItemResponseSchema = z.union([ + TextRichTextItemResponseSchema, + MentionRichTextItemResponseSchema, + EquationRichTextItemResponseSchema + ]) + export type RichTextItemResponse = z.infer + + export const CommentObjectResponseSchema = z.object({ + object: z.literal('comment'), + id: z.string(), + parent: z.union([ + z.object({ type: z.literal('page_id'), page_id: z.string() }), + z.object({ type: z.literal('block_id'), block_id: z.string() }) + ]), + discussion_id: z.string(), + rich_text: z.array(RichTextItemResponseSchema), + created_by: PartialUserObjectResponseSchema, + created_time: z.string(), + last_edited_time: z.string() + }) + export type CommentObjectResponse = z.infer< + typeof CommentObjectResponseSchema + > + + export const PropertyFilterSchema = z.union([ + z.object({ property: z.string(), title: TextPropertyFilterSchema }), + z.object({ property: z.string(), rich_text: TextPropertyFilterSchema }), + z.object({ property: z.string(), number: NumberPropertyFilterSchema }), + z.object({ property: z.string(), checkbox: CheckboxPropertyFilterSchema }), + z.object({ property: z.string(), select: SelectPropertyFilterSchema }), + z.object({ + property: z.string(), + multi_select: MultiSelectPropertyFilterSchema + }), + z.object({ property: z.string(), date: DatePropertyFilterSchema }), + z.object({ property: z.string(), people: PeoplePropertyFilterSchema }), + z.object({ property: z.string(), files: FilesPropertyFilterSchema }), + z.object({ property: z.string(), url: TextPropertyFilterSchema }), + z.object({ property: z.string(), email: TextPropertyFilterSchema }), + z.object({ property: z.string(), phone_number: TextPropertyFilterSchema }), + z.object({ property: z.string(), relation: RelationPropertyFilterSchema }), + z.object({ property: z.string(), created_by: PeoplePropertyFilterSchema }), + z.object({ property: z.string(), created_time: DatePropertyFilterSchema }), + z.object({ + property: z.string(), + last_edited_by: PeoplePropertyFilterSchema + }), + z.object({ + property: z.string(), + last_edited_time: DatePropertyFilterSchema + }), + z.object({ + timestamp: z.enum(['created_time', 'last_edited_time']), + created_time: DatePropertyFilterSchema + }), + z.object({ + timestamp: z.enum(['created_time', 'last_edited_time']), + last_edited_time: DatePropertyFilterSchema + }) + ]) + export type PropertyFilter = z.infer + + export const ListCommentsResponseSchema = z.object({ + object: z.literal('list'), + results: z.array(CommentObjectResponseSchema), + next_cursor: z.union([z.string(), z.null()]), + has_more: z.boolean() + }) + export type ListCommentsResponse = z.infer + + export const CompoundFilterSchema = z.object({ + and: z.array(PropertyFilterSchema).optional(), + or: z.array(PropertyFilterSchema).optional() + }) + export type CompoundFilter = z.infer + + export const QueryDatabaseParametersSchema = z.object({ + sorts: z + .array( + z.union([ + z.object({ + property: z.string(), + direction: z.enum(['ascending', 'descending']) + }), + z.object({ + timestamp: z.enum(['created_time', 'last_edited_time']), + direction: z.enum(['ascending', 'descending']) + }) + ]) + ) + .optional(), + filter: z.union([PropertyFilterSchema, CompoundFilterSchema]).optional(), + start_cursor: z.string().optional(), + page_size: z.number().int().optional(), + archived: z.boolean().optional() + }) + export type QueryDatabaseParameters = z.infer< + typeof QueryDatabaseParametersSchema + > + + export const DatabasePropertyConfigResponseSchema = z.union([ + TitlePropertyResponseSchema, + RichTextPropertyResponseSchema, + NumberPropertyResponseSchema, + SelectPropertyResponseSchema, + MultiSelectPropertyResponseSchema, + DatePropertyResponseSchema, + PeoplePropertyResponseSchema, + FilePropertyResponseSchema, + CheckboxPropertyResponseSchema, + UrlPropertyResponseSchema, + EmailPropertyResponseSchema, + PhoneNumberPropertyResponseSchema, + FormulaPropertyResponseSchema, + RelationPropertyResponseSchema, + RollupPropertyResponseSchema, + CreatedTimePropertyResponseSchema, + CreatedByPropertyResponseSchema, + LastEditedTimePropertyResponseSchema, + LastEditedByPropertyResponseSchema + ]) + export type DatabasePropertyConfigResponse = z.infer< + typeof DatabasePropertyConfigResponseSchema + > + + export const PartialDatabaseObjectResponseSchema = z.object({ + object: z.literal('database'), + id: z.string(), + properties: z.record(DatabasePropertyConfigResponseSchema) + }) + export type PartialDatabaseObjectResponse = z.infer< + typeof PartialDatabaseObjectResponseSchema + > + + export const DatabaseObjectResponseSchema = z.object({ + object: z.literal('database'), + id: z.string(), + cover: z + .union([ + z.object({ + type: z.literal('external'), + external: z.object({ url: z.string() }) + }), + z.null() + ]) + .optional(), + icon: z + .union([ + z.object({ type: z.literal('emoji'), emoji: z.string() }), + z.object({ + type: z.literal('external'), + external: z.object({ url: z.string() }) + }), + z.null() + ]) + .optional(), + created_time: z.string(), + created_by: PartialUserObjectResponseSchema, + last_edited_time: z.string(), + last_edited_by: PartialUserObjectResponseSchema, + title: z.array(RichTextItemResponseSchema), + description: z.array(RichTextItemResponseSchema), + is_inline: z.boolean(), + properties: z.record(DatabasePropertyConfigResponseSchema), + parent: z.union([ + z.object({ type: z.literal('page_id'), page_id: z.string() }), + z.object({ type: z.literal('workspace'), workspace: z.literal(true) }) + ]), + url: z.string(), + archived: z.boolean() + }) + export type DatabaseObjectResponse = z.infer< + typeof DatabaseObjectResponseSchema + > + + export const ListDatabasesResponseSchema = z.object({ + object: z.literal('list'), + results: z.array( + z.union([ + PartialDatabaseObjectResponseSchema, + DatabaseObjectResponseSchema + ]) + ), + next_cursor: z.union([z.string(), z.null()]), + has_more: z.boolean() + }) + export type ListDatabasesResponse = z.infer< + typeof ListDatabasesResponseSchema + > + + export const SearchResponseSchema = z.object({ + object: z.literal('list'), + results: z.array( + z.union([ + PageObjectResponseSchema, + PartialPageObjectResponseSchema, + PartialDatabaseObjectResponseSchema, + DatabaseObjectResponseSchema + ]) + ), + next_cursor: z.union([z.string(), z.null()]), + has_more: z.boolean() + }) + export type SearchResponse = z.infer + + // ----------------------------------------------------------------------------- + // Operation schemas + // ----------------------------------------------------------------------------- + + export const GetSelfParamsSchema = z.object({}) + export type GetSelfParams = z.infer + + export const GetSelfResponseSchema = UserObjectResponseSchema + export type GetSelfResponse = z.infer + + export const GetUserParamsSchema = z.object({ user_id: z.string() }) + export type GetUserParams = z.infer + + export const GetUserResponseSchema = UserObjectResponseSchema + export type GetUserResponse = z.infer + + export const ListUsersParamsSchema = z.object({ + start_cursor: z.string().optional(), + page_size: z.number().int().optional() + }) + export type ListUsersParams = z.infer + + export const CreatePageParamsSchema = CreatePageParametersSchema + export type CreatePageParams = z.infer + + export const CreatePageResponseSchema = z.union([ + PageObjectResponseSchema, + PartialPageObjectResponseSchema + ]) + export type CreatePageResponse = z.infer + + export const GetPageParamsSchema = z.object({ + page_id: z.string(), + filter_properties: z.array(z.string()).optional() + }) + export type GetPageParams = z.infer + + export const GetPageResponseSchema = z.union([ + PageObjectResponseSchema, + PartialPageObjectResponseSchema + ]) + export type GetPageResponse = z.infer + + export const UpdatePageParamsSchema = z + .object({ page_id: z.string() }) + .merge(UpdatePageParametersSchema) + export type UpdatePageParams = z.infer + + export const UpdatePageResponseSchema = z.union([ + PageObjectResponseSchema, + PartialPageObjectResponseSchema + ]) + export type UpdatePageResponse = z.infer + + export const GetPagePropertyParamsSchema = z.object({ + page_id: z.string(), + property_id: z.string(), + start_cursor: z.string().optional(), + page_size: z.number().int().optional() + }) + export type GetPagePropertyParams = z.infer< + typeof GetPagePropertyParamsSchema + > + + export const GetPagePropertyResponseSchema = z.union([ + PropertyItemObjectResponseSchema, + PropertyItemListResponseSchema + ]) + export type GetPagePropertyResponse = z.infer< + typeof GetPagePropertyResponseSchema + > + + export const GetBlockParamsSchema = z.object({ block_id: z.string() }) + export type GetBlockParams = z.infer + + export const GetBlockResponseSchema = z.union([ + PartialBlockObjectResponseSchema, + BlockObjectResponseSchema + ]) + export type GetBlockResponse = z.infer + + export const DeleteBlockParamsSchema = z.object({ block_id: z.string() }) + export type DeleteBlockParams = z.infer + + export const DeleteBlockResponseSchema = z.union([ + PartialBlockObjectResponseSchema, + BlockObjectResponseSchema + ]) + export type DeleteBlockResponse = z.infer + + export const UpdateBlockParamsSchema = z + .object({ block_id: z.string() }) + .merge(UpdateBlockParametersSchema) + export type UpdateBlockParams = z.infer + + export const UpdateBlockResponseSchema = z.union([ + PartialBlockObjectResponseSchema, + BlockObjectResponseSchema + ]) + export type UpdateBlockResponse = z.infer + + export const ListBlockChildrenParamsSchema = z.object({ + block_id: z.string(), + start_cursor: z.string().optional(), + page_size: z.number().int().optional() + }) + export type ListBlockChildrenParams = z.infer< + typeof ListBlockChildrenParamsSchema + > + + export const AppendBlockChildrenParamsSchema = z + .object({ block_id: z.string() }) + .merge(AppendBlockChildrenParametersSchema) + export type AppendBlockChildrenParams = z.infer< + typeof AppendBlockChildrenParamsSchema + > + + export const GetDatabaseParamsSchema = z.object({ database_id: z.string() }) + export type GetDatabaseParams = z.infer + + export const GetDatabaseResponseSchema = z.union([ + PartialDatabaseObjectResponseSchema, + DatabaseObjectResponseSchema + ]) + export type GetDatabaseResponse = z.infer + + export const UpdateDatabaseParamsSchema = z + .object({ database_id: z.string() }) + .merge(UpdateDatabaseParametersSchema) + export type UpdateDatabaseParams = z.infer + + export const UpdateDatabaseResponseSchema = z.union([ + PartialDatabaseObjectResponseSchema, + DatabaseObjectResponseSchema + ]) + export type UpdateDatabaseResponse = z.infer< + typeof UpdateDatabaseResponseSchema + > + + export const QueryDatabaseParamsSchema = z + .object({ + database_id: z.string(), + filter_properties: z.array(z.string()).optional() + }) + .merge(QueryDatabaseParametersSchema) + export type QueryDatabaseParams = z.infer + + export const ListDatabasesParamsSchema = z.object({ + start_cursor: z.string().optional(), + page_size: z.number().int().optional() + }) + export type ListDatabasesParams = z.infer + + export const CreateDatabaseParamsSchema = CreateDatabaseParametersSchema + export type CreateDatabaseParams = z.infer + + export const CreateDatabaseResponseSchema = z.union([ + PartialDatabaseObjectResponseSchema, + DatabaseObjectResponseSchema + ]) + export type CreateDatabaseResponse = z.infer< + typeof CreateDatabaseResponseSchema + > + + export const SearchParamsSchema = SearchParametersSchema + export type SearchParams = z.infer + + export const ListCommentsParamsSchema = z.object({ + block_id: z.string(), + start_cursor: z.string().optional(), + page_size: z.number().int().optional() + }) + export type ListCommentsParams = z.infer + + export const CreateCommentParamsSchema = CreateCommentParametersSchema + export type CreateCommentParams = z.infer + + export const CreateCommentResponseSchema = z.union([ + CommentObjectResponseSchema, + PartialCommentObjectResponseSchema + ]) + export type CreateCommentResponse = z.infer< + typeof CreateCommentResponseSchema + > + + export const OauthTokenParamsSchema = OauthTokenParametersSchema + export type OauthTokenParams = z.infer +} + +/** + * Agentic Notion client. + * + * API specification for Notion. + */ +export class NotionClient extends AIFunctionsProvider { + protected readonly ky: KyInstance + protected readonly apiKey: string + protected readonly apiBaseUrl: string + + constructor({ + apiKey = getEnv('NOTION_API_KEY'), + apiBaseUrl = notion.apiBaseUrl, + ky = defaultKy + }: { + apiKey?: string + apiBaseUrl?: string + ky?: KyInstance + } = {}) { + assert( + apiKey, + 'NotionClient missing required "apiKey" (defaults to "NOTION_API_KEY")' + ) + super() + + this.apiKey = apiKey + this.apiBaseUrl = apiBaseUrl + + this.ky = ky.extend({ + prefixUrl: apiBaseUrl, + headers: { + Authorization: \`Bearer \${apiKey}\` + } + }) + } + + /** + * Get current user. + */ + @aiFunction({ + name: 'get_self', + description: \`Get current user.\`, + inputSchema: notion.GetSelfParamsSchema + }) + async getSelf( + _params: notion.GetSelfParams + ): Promise { + return this.ky.get('/users/me').json() + } + + /** + * Get user. + */ + @aiFunction({ + name: 'get_user', + description: \`Get user.\`, + inputSchema: notion.GetUserParamsSchema + }) + async getUser(params: notion.GetUserParams): Promise { + return this.ky + .get(\`/users/\${params['user_id']}\`) + .json() + } + + /** + * List users. + */ + @aiFunction({ + name: 'list_users', + description: \`List users.\`, + inputSchema: notion.ListUsersParamsSchema + }) + async listUsers( + params: notion.ListUsersParams + ): Promise { + return this.ky + .get('/users', { + searchParams: sanitizeSearchParams( + pick(params, 'start_cursor', 'page_size') + ) + }) + .json() + } + + /** + * Create page. + */ + @aiFunction({ + name: 'create_page', + description: \`Create page.\`, + inputSchema: notion.CreatePageParamsSchema + }) + async createPage( + params: notion.CreatePageParams + ): Promise { + return this.ky + .post('/pages', { + json: pick(params, 'parent', 'properties') + }) + .json() + } + + /** + * Get page. + */ + @aiFunction({ + name: 'get_page', + description: \`Get page.\`, + inputSchema: notion.GetPageParamsSchema + }) + async getPage(params: notion.GetPageParams): Promise { + return this.ky + .get(\`/pages/\${params['page_id']}\`, { + searchParams: sanitizeSearchParams(pick(params, 'filter_properties')) + }) + .json() + } + + /** + * Update page. + */ + @aiFunction({ + name: 'update_page', + description: \`Update page.\`, + inputSchema: notion.UpdatePageParamsSchema + }) + async updatePage( + params: notion.UpdatePageParams + ): Promise { + return this.ky + .patch(\`/pages/\${params['page_id']}\`, { + json: pick(params, 'properties', 'archived') + }) + .json() + } + + /** + * Get page property. + */ + @aiFunction({ + name: 'get_page_property', + description: \`Get page property.\`, + inputSchema: notion.GetPagePropertyParamsSchema + }) + async getPageProperty( + params: notion.GetPagePropertyParams + ): Promise { + return this.ky + .get(\`/pages/\${params['page_id']}/properties/\${params['property_id']}\`, { + searchParams: sanitizeSearchParams( + pick(params, 'start_cursor', 'page_size') + ) + }) + .json() + } + + /** + * Get block. + */ + @aiFunction({ + name: 'get_block', + description: \`Get block.\`, + inputSchema: notion.GetBlockParamsSchema + }) + async getBlock( + params: notion.GetBlockParams + ): Promise { + return this.ky + .get(\`/blocks/\${params['block_id']}\`) + .json() + } + + /** + * Delete block. + */ + @aiFunction({ + name: 'delete_block', + description: \`Delete block.\`, + inputSchema: notion.DeleteBlockParamsSchema + }) + async deleteBlock( + params: notion.DeleteBlockParams + ): Promise { + return this.ky + .delete(\`/blocks/\${params['block_id']}\`) + .json() + } + + /** + * Update block. + */ + @aiFunction({ + name: 'update_block', + description: \`Update block.\`, + inputSchema: notion.UpdateBlockParamsSchema + }) + async updateBlock( + params: notion.UpdateBlockParams + ): Promise { + return this.ky + .patch(\`/blocks/\${params['block_id']}\`, { + json: pick( + params, + 'paragraph', + 'heading_1', + 'heading_2', + 'heading_3', + 'bulleted_list_item', + 'numbered_list_item', + 'quote', + 'to_do', + 'toggle', + 'code', + 'embed', + 'image', + 'video', + 'file', + 'pdf', + 'bookmark', + 'equation', + 'divider', + 'table_of_contents', + 'breadcrumb', + 'column_list', + 'column', + 'link_to_page', + 'table_row', + 'archived' + ) + }) + .json() + } + + /** + * List block children. + */ + @aiFunction({ + name: 'list_block_children', + description: \`List block children.\`, + inputSchema: notion.ListBlockChildrenParamsSchema + }) + async listBlockChildren( + params: notion.ListBlockChildrenParams + ): Promise { + return this.ky + .get(\`/blocks/\${params['block_id']}/children\`, { + searchParams: sanitizeSearchParams( + pick(params, 'start_cursor', 'page_size') + ) + }) + .json() + } + + /** + * Append block children. + */ + @aiFunction({ + name: 'append_block_children', + description: \`Append block children.\`, + inputSchema: notion.AppendBlockChildrenParamsSchema + }) + async appendBlockChildren( + params: notion.AppendBlockChildrenParams + ): Promise { + return this.ky + .patch(\`/blocks/\${params['block_id']}/children\`, { + json: pick(params, 'children') + }) + .json() + } + + /** + * Get database. + */ + @aiFunction({ + name: 'get_database', + description: \`Get database.\`, + inputSchema: notion.GetDatabaseParamsSchema + }) + async getDatabase( + params: notion.GetDatabaseParams + ): Promise { + return this.ky + .get(\`/databases/\${params['database_id']}\`) + .json() + } + + /** + * Update database. + */ + @aiFunction({ + name: 'update_database', + description: \`Update database.\`, + inputSchema: notion.UpdateDatabaseParamsSchema + }) + async updateDatabase( + params: notion.UpdateDatabaseParams + ): Promise { + return this.ky + .patch(\`/databases/\${params['database_id']}\`, { + json: pick( + params, + 'title', + 'description', + 'icon', + 'cover', + 'properties', + 'is_inline', + 'archived' + ) + }) + .json() + } + + /** + * Query database. + */ + @aiFunction({ + name: 'query_database', + description: \`Query database.\`, + inputSchema: notion.QueryDatabaseParamsSchema + }) + async queryDatabase( + params: notion.QueryDatabaseParams + ): Promise { + return this.ky + .post(\`/databases/\${params['database_id']}/query\`, { + searchParams: sanitizeSearchParams(pick(params, 'filter_properties')), + json: pick( + params, + 'sorts', + 'filter', + 'start_cursor', + 'page_size', + 'archived' + ) + }) + .json() + } + + /** + * List databases. + */ + @aiFunction({ + name: 'list_databases', + description: \`List databases.\`, + inputSchema: notion.ListDatabasesParamsSchema + }) + async listDatabases( + params: notion.ListDatabasesParams + ): Promise { + return this.ky + .get('/databases', { + searchParams: sanitizeSearchParams( + pick(params, 'start_cursor', 'page_size') + ) + }) + .json() + } + + /** + * Create database. + */ + @aiFunction({ + name: 'create_database', + description: \`Create database.\`, + inputSchema: notion.CreateDatabaseParamsSchema + }) + async createDatabase( + params: notion.CreateDatabaseParams + ): Promise { + return this.ky + .post('/databases', { + json: pick( + params, + 'parent', + 'properties', + 'icon', + 'cover', + 'title', + 'description', + 'is_inline' + ) + }) + .json() + } + + /** + * Search. + */ + @aiFunction({ + name: 'search', + description: \`Search.\`, + inputSchema: notion.SearchParamsSchema + }) + async search(params: notion.SearchParams): Promise { + return this.ky + .post('/search', { + json: pick( + params, + 'query', + 'sort', + 'filter', + 'start_cursor', + 'page_size' + ) + }) + .json() + } + + /** + * List comments. + */ + @aiFunction({ + name: 'list_comments', + description: \`List comments.\`, + inputSchema: notion.ListCommentsParamsSchema + }) + async listComments( + params: notion.ListCommentsParams + ): Promise { + return this.ky + .get('/comments', { + searchParams: sanitizeSearchParams( + pick(params, 'block_id', 'start_cursor', 'page_size') + ) + }) + .json() + } + + /** + * Create comment. + */ + @aiFunction({ + name: 'create_comment', + description: \`Create comment.\`, + // TODO: Improve handling of union params + inputSchema: notion.CreateCommentParamsSchema as any + }) + async createComment( + params: notion.CreateCommentParams + ): Promise { + return this.ky + .post('/comments', { + json: params + }) + .json() + } + + /** + * OAuth token. + */ + @aiFunction({ + name: 'oauth_token', + description: \`OAuth token.\`, + inputSchema: notion.OauthTokenParamsSchema + }) + async oauthToken( + params: notion.OauthTokenParams + ): Promise { + return this.ky + .post('/oauth/token', { + json: pick( + params, + 'grant_type', + 'code', + 'redirect_uri', + 'external_account' + ) + }) + .json() + } +} +" +`; + +exports[`openapi-to-ts > 3.0/pet-store.json 1`] = ` +"/* eslint-disable unicorn/no-unreadable-iife */ +/* eslint-disable unicorn/no-array-reduce */ + +/** + * This file was auto-generated from an OpenAPI spec. + */ + +import { + AIFunctionsProvider, + aiFunction, + pick, + sanitizeSearchParams +} from '@agentic/core' +import defaultKy, { type KyInstance } from 'ky' +import { z } from 'zod' + +export namespace petstore { + export const apiBaseUrl = 'http://petstore.swagger.io/v1' + + // ----------------------------------------------------------------------------- + // Component schemas + // ----------------------------------------------------------------------------- + + export const PetSchema = z.object({ + id: z.number().int(), + name: z.string(), + tag: z.string().optional() + }) + export type Pet = z.infer + + export const PetsSchema = z.array(PetSchema).max(100) + export type Pets = z.infer + + // ----------------------------------------------------------------------------- + // Operation schemas + // ----------------------------------------------------------------------------- + + export const ListPetsParamsSchema = z.object({ + /**How many items to return at one time (max 100)*/ + limit: z + .number() + .int() + .lte(100) + .describe('How many items to return at one time (max 100)') + .optional() + }) + export type ListPetsParams = z.infer + + export const ListPetsResponseSchema = PetsSchema + export type ListPetsResponse = z.infer + + export const CreatePetsParamsSchema = PetSchema + export type CreatePetsParams = z.infer + + export type CreatePetsResponse = undefined + + export const ShowPetByIdParamsSchema = z.object({ + /**The id of the pet to retrieve*/ + petId: z.string().describe('The id of the pet to retrieve') + }) + export type ShowPetByIdParams = z.infer + + export const ShowPetByIdResponseSchema = PetSchema + export type ShowPetByIdResponse = z.infer +} + +/** + * Agentic PetStore client. + */ +export class PetStoreClient extends AIFunctionsProvider { + protected readonly ky: KyInstance + + protected readonly apiBaseUrl: string + + constructor({ + apiBaseUrl = petstore.apiBaseUrl, + ky = defaultKy + }: { + apiKey?: string + apiBaseUrl?: string + ky?: KyInstance + } = {}) { + super() + + this.apiBaseUrl = apiBaseUrl + + this.ky = ky.extend({ + prefixUrl: apiBaseUrl + }) + } + + /** + * List all pets. + */ + @aiFunction({ + name: 'list_pets', + description: \`List all pets.\`, + inputSchema: petstore.ListPetsParamsSchema + }) + async listPets( + params: petstore.ListPetsParams + ): Promise { + return this.ky + .get('/pets', { + searchParams: sanitizeSearchParams(params) + }) + .json() + } + + /** + * Create a pet. + */ + @aiFunction({ + name: 'create_pets', + description: \`Create a pet.\`, + inputSchema: petstore.CreatePetsParamsSchema + }) + async createPets( + params: petstore.CreatePetsParams + ): Promise { + return this.ky + .post('/pets', { + json: pick(params, 'id', 'name', 'tag') + }) + .json() + } + + /** + * Info for a specific pet. + */ + @aiFunction({ + name: 'show_pet_by_id', + description: \`Info for a specific pet.\`, + inputSchema: petstore.ShowPetByIdParamsSchema + }) + async showPetById( + params: petstore.ShowPetByIdParams + ): Promise { + return this.ky + .get(\`/pets/\${params['petId']}\`) + .json() + } +} +" +`; + +exports[`openapi-to-ts > 3.0/petstore-expanded.json 1`] = ` +"/* eslint-disable unicorn/no-unreadable-iife */ +/* eslint-disable unicorn/no-array-reduce */ + +/** + * This file was auto-generated from an OpenAPI spec. + */ + +import { + AIFunctionsProvider, + aiFunction, + pick, + sanitizeSearchParams +} from '@agentic/core' +import defaultKy, { type KyInstance } from 'ky' +import { z } from 'zod' + +export namespace petstoreexpanded { + export const apiBaseUrl = 'http://petstore.swagger.io/api' + + // ----------------------------------------------------------------------------- + // Component schemas + // ----------------------------------------------------------------------------- + + export const NewPetSchema = z.object({ + name: z.string(), + tag: z.string().optional() + }) + export type NewPet = z.infer + + export const PetSchema = z.intersection( + NewPetSchema, + z.object({ id: z.number().int() }) + ) + export type Pet = z.infer + + // ----------------------------------------------------------------------------- + // Operation schemas + // ----------------------------------------------------------------------------- + + export const FindPetsParamsSchema = z.object({ + /**tags to filter by*/ + tags: z.array(z.string()).describe('tags to filter by').optional(), + /**maximum number of results to return*/ + limit: z + .number() + .int() + .describe('maximum number of results to return') + .optional() + }) + export type FindPetsParams = z.infer + + export const FindPetsResponseSchema = z.array(PetSchema) + export type FindPetsResponse = z.infer + + export const AddPetParamsSchema = NewPetSchema + export type AddPetParams = z.infer + + export const AddPetResponseSchema = PetSchema + export type AddPetResponse = z.infer + + export const FindPetByIdParamsSchema = z.object({ + /**ID of pet to fetch*/ + id: z.number().int().describe('ID of pet to fetch') + }) + export type FindPetByIdParams = z.infer + + export const FindPetByIdResponseSchema = PetSchema + export type FindPetByIdResponse = z.infer + + export const DeletePetParamsSchema = z.object({ + /**ID of pet to delete*/ + id: z.number().int().describe('ID of pet to delete') + }) + export type DeletePetParams = z.infer + + export type DeletePetResponse = undefined +} + +/** + * Agentic PetstoreExpanded client. + * + * A sample API that uses a petstore as an example to demonstrate features in the OpenAPI 3.0 specification. + */ +export class PetstoreExpandedClient extends AIFunctionsProvider { + protected readonly ky: KyInstance + + protected readonly apiBaseUrl: string + + constructor({ + apiBaseUrl = petstoreexpanded.apiBaseUrl, + ky = defaultKy + }: { + apiKey?: string + apiBaseUrl?: string + ky?: KyInstance + } = {}) { + super() + + this.apiBaseUrl = apiBaseUrl + + this.ky = ky.extend({ + prefixUrl: apiBaseUrl + }) + } + + /** + * Returns all pets from the system that the user has access to +Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia. + +Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien. + */ + @aiFunction({ + name: 'find_pets', + description: \`Returns all pets from the system that the user has access to +Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia. + +Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.\`, + inputSchema: petstoreexpanded.FindPetsParamsSchema + }) + async findPets( + params: petstoreexpanded.FindPetsParams + ): Promise { + return this.ky + .get('/pets', { + searchParams: sanitizeSearchParams(pick(params, 'tags', 'limit')) + }) + .json() + } + + /** + * Creates a new pet in the store. Duplicates are allowed. + */ + @aiFunction({ + name: 'add_pet', + description: \`Creates a new pet in the store. Duplicates are allowed.\`, + inputSchema: petstoreexpanded.AddPetParamsSchema + }) + async addPet( + params: petstoreexpanded.AddPetParams + ): Promise { + return this.ky + .post('/pets', { + json: pick(params, 'name', 'tag') + }) + .json() + } + + /** + * Returns a user based on a single ID, if the user does not have access to the pet. + */ + @aiFunction({ + name: 'find_pet_by_id', + description: \`Returns a user based on a single ID, if the user does not have access to the pet.\`, + inputSchema: petstoreexpanded.FindPetByIdParamsSchema + }) + async findPetById( + params: petstoreexpanded.FindPetByIdParams + ): Promise { + return this.ky + .get(\`/pets/\${params['id']}\`) + .json() + } + + /** + * deletes a single pet based on the ID supplied. + */ + @aiFunction({ + name: 'delete_pet', + description: \`deletes a single pet based on the ID supplied.\`, + inputSchema: petstoreexpanded.DeletePetParamsSchema + }) + async deletePet( + params: petstoreexpanded.DeletePetParams + ): Promise { + return this.ky + .delete(\`/pets/\${params['id']}\`) + .json() + } +} +" +`; + +exports[`openapi-to-ts > 3.0/security.json 1`] = ` +"/* eslint-disable unicorn/no-unreadable-iife */ +/* eslint-disable unicorn/no-array-reduce */ + +/** + * This file was auto-generated from an OpenAPI spec. + */ + +import { AIFunctionsProvider, aiFunction } from '@agentic/core' +import defaultKy, { type KyInstance } from 'ky' +import { z } from 'zod' + +export namespace security { + export const apiBaseUrl = 'https://httpbin.org' + + // ----------------------------------------------------------------------------- + // Operation schemas + // ----------------------------------------------------------------------------- + + export const GetAnythingApiKeyParamsSchema = z.object({}) + export type GetAnythingApiKeyParams = z.infer< + typeof GetAnythingApiKeyParamsSchema + > + + export type GetAnythingApiKeyResponse = undefined + + export const PostAnythingApiKeyParamsSchema = z.object({}) + export type PostAnythingApiKeyParams = z.infer< + typeof PostAnythingApiKeyParamsSchema + > + + export type PostAnythingApiKeyResponse = undefined + + export const PutAnythingApiKeyParamsSchema = z.object({}) + export type PutAnythingApiKeyParams = z.infer< + typeof PutAnythingApiKeyParamsSchema + > + + export type PutAnythingApiKeyResponse = undefined + + export const PostAnythingBasicParamsSchema = z.object({}) + export type PostAnythingBasicParams = z.infer< + typeof PostAnythingBasicParamsSchema + > + + export type PostAnythingBasicResponse = undefined + + export const PostAnythingBearerParamsSchema = z.object({}) + export type PostAnythingBearerParams = z.infer< + typeof PostAnythingBearerParamsSchema + > + + export type PostAnythingBearerResponse = undefined + + export const PutAnythingBearerParamsSchema = z.object({}) + export type PutAnythingBearerParams = z.infer< + typeof PutAnythingBearerParamsSchema + > + + export type PutAnythingBearerResponse = undefined + + export const GetAnythingOauth2ParamsSchema = z.object({}) + export type GetAnythingOauth2Params = z.infer< + typeof GetAnythingOauth2ParamsSchema + > + + export type GetAnythingOauth2Response = undefined + + export const PostAnythingOauth2ParamsSchema = z.object({}) + export type PostAnythingOauth2Params = z.infer< + typeof PostAnythingOauth2ParamsSchema + > + + export type PostAnythingOauth2Response = undefined + + export const PutAnythingOauth2ParamsSchema = z.object({}) + export type PutAnythingOauth2Params = z.infer< + typeof PutAnythingOauth2ParamsSchema + > + + export type PutAnythingOauth2Response = undefined + + export const DeleteAnythingOauth2ParamsSchema = z.object({}) + export type DeleteAnythingOauth2Params = z.infer< + typeof DeleteAnythingOauth2ParamsSchema + > + + export type DeleteAnythingOauth2Response = undefined + + export const PatchAnythingOauth2ParamsSchema = z.object({}) + export type PatchAnythingOauth2Params = z.infer< + typeof PatchAnythingOauth2ParamsSchema + > + + export type PatchAnythingOauth2Response = undefined + + export const PostAnythingOpenIdConnectParamsSchema = z.object({}) + export type PostAnythingOpenIdConnectParams = z.infer< + typeof PostAnythingOpenIdConnectParamsSchema + > + + export type PostAnythingOpenIdConnectResponse = undefined + + export const PostAnythingNoAuthParamsSchema = z.object({}) + export type PostAnythingNoAuthParams = z.infer< + typeof PostAnythingNoAuthParamsSchema + > + + export type PostAnythingNoAuthResponse = undefined + + export const GetAnythingOptionalAuthParamsSchema = z.object({}) + export type GetAnythingOptionalAuthParams = z.infer< + typeof GetAnythingOptionalAuthParamsSchema + > + + export type GetAnythingOptionalAuthResponse = undefined + + export const PostStatus401ParamsSchema = z.object({}) + export type PostStatus401Params = z.infer + + export type PostStatus401Response = undefined +} + +/** + * Agentic Security client. + * + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#securitySchemeObject. + */ +export class SecurityClient extends AIFunctionsProvider { + protected readonly ky: KyInstance + + protected readonly apiBaseUrl: string + + constructor({ + apiBaseUrl = security.apiBaseUrl, + ky = defaultKy + }: { + apiKey?: string + apiBaseUrl?: string + ky?: KyInstance + } = {}) { + super() + + this.apiBaseUrl = apiBaseUrl + + this.ky = ky.extend({ + prefixUrl: apiBaseUrl + }) + } + + /** + * \`apiKey\` auth will be supplied within an \`apiKey\` query parameter. + */ + @aiFunction({ + name: 'get_anything_api_key', + description: \`\\\`apiKey\\\` auth will be supplied within an \\\`apiKey\\\` query parameter.\`, + inputSchema: security.GetAnythingApiKeyParamsSchema + }) + async getAnythingApiKey( + _params: security.GetAnythingApiKeyParams + ): Promise { + return this.ky + .get('/anything/apiKey') + .json() + } + + /** + * \`apiKey\` auth will be supplied within an \`api_key\` cookie. + */ + @aiFunction({ + name: 'post_anything_api_key', + description: \`\\\`apiKey\\\` auth will be supplied within an \\\`api_key\\\` cookie.\`, + inputSchema: security.PostAnythingApiKeyParamsSchema + }) + async postAnythingApiKey( + _params: security.PostAnythingApiKeyParams + ): Promise { + return this.ky + .post('/anything/apiKey') + .json() + } + + /** + * \`apiKey\` auth will be supplied within an \`X-API-KEY\` header. + */ + @aiFunction({ + name: 'put_anything_api_key', + description: \`\\\`apiKey\\\` auth will be supplied within an \\\`X-API-KEY\\\` header.\`, + inputSchema: security.PutAnythingApiKeyParamsSchema + }) + async putAnythingApiKey( + _params: security.PutAnythingApiKeyParams + ): Promise { + return this.ky + .put('/anything/apiKey') + .json() + } + + /** + * Authentication credentials will be supplied within a \`Basic\` \`Authorization\` header. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample. + */ + @aiFunction({ + name: 'post_anything_basic', + description: \`Authentication credentials will be supplied within a \\\`Basic\\\` \\\`Authorization\\\` header. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample.\`, + inputSchema: security.PostAnythingBasicParamsSchema + }) + async postAnythingBasic( + _params: security.PostAnythingBasicParams + ): Promise { + return this.ky + .post('/anything/basic') + .json() + } + + /** + * Authentication credentials will be supplied within a \`Bearer\` \`Authorization\` header. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample. + */ + @aiFunction({ + name: 'post_anything_bearer', + description: \`Authentication credentials will be supplied within a \\\`Bearer\\\` \\\`Authorization\\\` header. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample.\`, + inputSchema: security.PostAnythingBearerParamsSchema + }) + async postAnythingBearer( + _params: security.PostAnythingBearerParams + ): Promise { + return this.ky + .post('/anything/bearer') + .json() + } + + /** + * Authentication credentials will be supplied within a \`Bearer\` \`Authorization\` header, but its data should be controlled as a JWT. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample + +> ℹ️ +> We currently do not support any special handling for this so they're handled as a standard \`Bearer\` authentication token. + */ + @aiFunction({ + name: 'put_anything_bearer', + description: \`Authentication credentials will be supplied within a \\\`Bearer\\\` \\\`Authorization\\\` header, but its data should be controlled as a JWT. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample + +> ℹ️ +> We currently do not support any special handling for this so they're handled as a standard \\\`Bearer\\\` authentication token.\`, + inputSchema: security.PutAnythingBearerParamsSchema + }) + async putAnythingBearer( + _params: security.PutAnythingBearerParams + ): Promise { + return this.ky + .put('/anything/bearer') + .json() + } + + /** + * > ℹ️ +> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23. + */ + @aiFunction({ + name: 'get_anything_oauth2', + description: \`> ℹ️ +> We currently do not handle OAuth 2 authentication flows so if an operation has an \\\`oauth2\\\` requirement we assume that the user, or the projects JWT, has a qualified \\\`bearer\\\` token and will use that. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23.\`, + inputSchema: security.GetAnythingOauth2ParamsSchema + }) + async getAnythingOauth2( + _params: security.GetAnythingOauth2Params + ): Promise { + return this.ky + .get('/anything/oauth2') + .json() + } + + /** + * > ℹ️ +> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23. + */ + @aiFunction({ + name: 'post_anything_oauth2', + description: \`> ℹ️ +> We currently do not handle OAuth 2 authentication flows so if an operation has an \\\`oauth2\\\` requirement we assume that the user, or the projects JWT, has a qualified \\\`bearer\\\` token and will use that. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23.\`, + inputSchema: security.PostAnythingOauth2ParamsSchema + }) + async postAnythingOauth2( + _params: security.PostAnythingOauth2Params + ): Promise { + return this.ky + .post('/anything/oauth2') + .json() + } + + /** + * > ℹ️ +> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23. + */ + @aiFunction({ + name: 'put_anything_oauth2', + description: \`> ℹ️ +> We currently do not handle OAuth 2 authentication flows so if an operation has an \\\`oauth2\\\` requirement we assume that the user, or the projects JWT, has a qualified \\\`bearer\\\` token and will use that. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23.\`, + inputSchema: security.PutAnythingOauth2ParamsSchema + }) + async putAnythingOauth2( + _params: security.PutAnythingOauth2Params + ): Promise { + return this.ky + .put('/anything/oauth2') + .json() + } + + /** + * > ℹ️ +> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23. + */ + @aiFunction({ + name: 'delete_anything_oauth2', + description: \`> ℹ️ +> We currently do not handle OAuth 2 authentication flows so if an operation has an \\\`oauth2\\\` requirement we assume that the user, or the projects JWT, has a qualified \\\`bearer\\\` token and will use that. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23.\`, + inputSchema: security.DeleteAnythingOauth2ParamsSchema + }) + async deleteAnythingOauth2( + _params: security.DeleteAnythingOauth2Params + ): Promise { + return this.ky + .delete('/anything/oauth2') + .json() + } + + /** + * > ℹ️ +> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23. + */ + @aiFunction({ + name: 'patch_anything_oauth2', + description: \`> ℹ️ +> We currently do not handle OAuth 2 authentication flows so if an operation has an \\\`oauth2\\\` requirement we assume that the user, or the projects JWT, has a qualified \\\`bearer\\\` token and will use that. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23.\`, + inputSchema: security.PatchAnythingOauth2ParamsSchema + }) + async patchAnythingOauth2( + _params: security.PatchAnythingOauth2Params + ): Promise { + return this.ky + .patch('/anything/oauth2') + .json() + } + + /** + * 🚧 This is not supported. + */ + @aiFunction({ + name: 'post_anything_open_id_connect', + description: \`🚧 This is not supported.\`, + inputSchema: security.PostAnythingOpenIdConnectParamsSchema + }) + async postAnythingOpenIdConnect( + _params: security.PostAnythingOpenIdConnectParams + ): Promise { + return this.ky + .post('/anything/openIdConnect') + .json() + } + + /** + * This operation does not have any authentication requirements. + */ + @aiFunction({ + name: 'post_anything_no_auth', + description: \`This operation does not have any authentication requirements.\`, + inputSchema: security.PostAnythingNoAuthParamsSchema + }) + async postAnythingNoAuth( + _params: security.PostAnythingNoAuthParams + ): Promise { + return this.ky + .post('/anything/no-auth') + .json() + } + + /** + * The \`apiKey\` query parameter auth on this operation is optional. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-requirement-object. + */ + @aiFunction({ + name: 'get_anything_optional_auth', + description: \`The \\\`apiKey\\\` query parameter auth on this operation is optional. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-requirement-object.\`, + inputSchema: security.GetAnythingOptionalAuthParamsSchema + }) + async getAnythingOptionalAuth( + _params: security.GetAnythingOptionalAuthParams + ): Promise { + return this.ky + .get('/anything/optional-auth') + .json() + } + + /** + * This endpoint requires an authentication header but making any request to it will forcefully return a 401 status code for invalid auth. + */ + @aiFunction({ + name: 'post_status401', + description: \`This endpoint requires an authentication header but making any request to it will forcefully return a 401 status code for invalid auth.\`, + inputSchema: security.PostStatus401ParamsSchema + }) + async postStatus401( + _params: security.PostStatus401Params + ): Promise { + return this.ky.post('/status/401').json() + } +} +" +`; + +exports[`openapi-to-ts > 3.0/tic-tac-toe.json 1`] = ` +"/* eslint-disable unicorn/no-unreadable-iife */ +/* eslint-disable unicorn/no-array-reduce */ + +/** + * This file was auto-generated from an OpenAPI spec. + */ + +import { AIFunctionsProvider, aiFunction } from '@agentic/core' +import defaultKy, { type KyInstance } from 'ky' +import { z } from 'zod' + +export namespace tictactoe { + // ----------------------------------------------------------------------------- + // Component schemas + // ----------------------------------------------------------------------------- + + /**Winner of the game. \`.\` means nobody has won yet.*/ + export const WinnerSchema = z + .enum(['.', 'X', 'O']) + .describe('Winner of the game. \`.\` means nobody has won yet.') + export type Winner = z.infer + + /**Possible values for a board square. \`.\` means empty square.*/ + export const MarkSchema = z + .enum(['.', 'X', 'O']) + .describe('Possible values for a board square. \`.\` means empty square.') + export type Mark = z.infer + + export const BoardSchema = z + .array(z.array(MarkSchema).min(3).max(3)) + .min(3) + .max(3) + export type Board = z.infer + + export const StatusSchema = z.object({ + winner: WinnerSchema.optional(), + board: BoardSchema.optional() + }) + export type Status = z.infer + + // ----------------------------------------------------------------------------- + // Operation schemas + // ----------------------------------------------------------------------------- + + export const GetBoardParamsSchema = z.object({}) + export type GetBoardParams = z.infer + + export const GetBoardResponseSchema = StatusSchema + export type GetBoardResponse = z.infer + + export const GetSquareParamsSchema = z.object({}) + export type GetSquareParams = z.infer + + export const GetSquareResponseSchema = MarkSchema + export type GetSquareResponse = z.infer + + export const PutSquareParamsSchema = MarkSchema + export type PutSquareParams = z.infer + + export const PutSquareResponseSchema = StatusSchema + export type PutSquareResponse = z.infer +} + +/** + * Agentic TicTacToe client. + * + * This API allows writing down marks on a Tic Tac Toe board +and requesting the state of the board or of individual squares. +. + */ +export class TicTacToeClient extends AIFunctionsProvider { + protected readonly ky: KyInstance + + protected readonly apiBaseUrl: string + + constructor({ + apiBaseUrl, + ky = defaultKy + }: { + apiKey?: string + apiBaseUrl?: string + ky?: KyInstance + } = {}) { + super() + + this.apiBaseUrl = apiBaseUrl + + this.ky = ky.extend({ + prefixUrl: apiBaseUrl + }) + } + + /** + * Retrieves the current state of the board and the winner. + */ + @aiFunction({ + name: 'get_board', + description: \`Retrieves the current state of the board and the winner.\`, + inputSchema: tictactoe.GetBoardParamsSchema + }) + async getBoard( + _params: tictactoe.GetBoardParams + ): Promise { + return this.ky.get('/board').json() + } + + /** + * Retrieves the requested square. + */ + @aiFunction({ + name: 'get_square', + description: \`Retrieves the requested square.\`, + inputSchema: tictactoe.GetSquareParamsSchema + }) + async getSquare( + _params: tictactoe.GetSquareParams + ): Promise { + return this.ky + .get('/board/{row}/{column}') + .json() + } + + /** + * Places a mark on the board and retrieves the whole board and the winner (if any). + */ + @aiFunction({ + name: 'put_square', + description: \`Places a mark on the board and retrieves the whole board and the winner (if any).\`, + inputSchema: tictactoe.PutSquareParamsSchema + }) + async putSquare( + _params: tictactoe.PutSquareParams + ): Promise { + return this.ky + .put('/board/{row}/{column}') + .json() + } +} +" +`; + +exports[`openapi-to-ts > firecrawl.json 1`] = ` +"/* eslint-disable unicorn/no-unreadable-iife */ +/* eslint-disable unicorn/no-array-reduce */ + +/** + * This file was auto-generated from an OpenAPI spec. + */ + +import { + AIFunctionsProvider, + aiFunction, + assert, + getEnv, + pick +} from '@agentic/core' +import defaultKy, { type KyInstance } from 'ky' +import { z } from 'zod' + +export namespace firecrawl { + export const apiBaseUrl = 'https://api.firecrawl.dev/v0' + + // ----------------------------------------------------------------------------- + // Component schemas + // ----------------------------------------------------------------------------- + + export const ScrapeResponseSchema = z.object({ + success: z.boolean().optional(), + /** Warning message to let you know of any issues. */ + warning: z + .string() + .describe('Warning message to let you know of any issues.') + .optional(), + data: z + .object({ + /** Markdown content of the page if the \`markdown\` format was specified (default) */ + markdown: z + .string() + .describe( + 'Markdown content of the page if the \`markdown\` format was specified (default)' + ) + .optional(), + /** HTML version of the content on page if the \`html\` format was specified */ + html: z + .string() + .describe( + 'HTML version of the content on page if the \`html\` format was specified' + ) + .optional(), + /** Raw HTML content of the page if the \`rawHtml\` format was specified */ + rawHtml: z + .string() + .describe( + 'Raw HTML content of the page if the \`rawHtml\` format was specified' + ) + .optional(), + /** Links on the page if the \`links\` format was specified */ + links: z + .array(z.string().url()) + .describe('Links on the page if the \`links\` format was specified') + .optional(), + /** URL of the screenshot of the page if the \`screenshot\` or \`screenshot@fullSize\` format was specified */ + screenshot: z + .string() + .describe( + 'URL of the screenshot of the page if the \`screenshot\` or \`screenshot@fullSize\` format was specified' + ) + .optional(), + metadata: z + .object({ + title: z.string().optional(), + description: z.string().optional(), + language: z.string().optional(), + sourceURL: z.string().url().optional(), + ' ': z.string().optional(), + /** The status code of the page */ + statusCode: z + .number() + .int() + .describe('The status code of the page') + .optional(), + /** The error message of the page */ + error: z + .string() + .describe('The error message of the page') + .optional() + }) + .optional() + }) + .optional() + }) + export type ScrapeResponse = z.infer + + export const CrawlResponseSchema = z.object({ + success: z.boolean().optional(), + id: z.string().optional(), + url: z.string().url().optional() + }) + export type CrawlResponse = z.infer + + export const SearchResponseSchema = z.object({ + success: z.boolean().optional(), + data: z.array(z.any()).optional() + }) + export type SearchResponse = z.infer + + export const CrawlStatusResponseObjSchema = z.object({ + /** Markdown content of the page if the \`markdown\` format was specified (default) */ + markdown: z + .string() + .describe( + 'Markdown content of the page if the \`markdown\` format was specified (default)' + ) + .optional(), + /** HTML version of the content on page if the \`html\` format was specified */ + html: z + .string() + .describe( + 'HTML version of the content on page if the \`html\` format was specified' + ) + .optional(), + /** Raw HTML content of the page if the \`rawHtml\` format was specified */ + rawHtml: z + .string() + .describe( + 'Raw HTML content of the page if the \`rawHtml\` format was specified' + ) + .optional(), + /** Links on the page if the \`links\` format was specified */ + links: z + .array(z.string().url()) + .describe('Links on the page if the \`links\` format was specified') + .optional(), + /** URL of the screenshot of the page if the \`screenshot\` or \`screenshot@fullSize\` format was specified */ + screenshot: z + .string() + .describe( + 'URL of the screenshot of the page if the \`screenshot\` or \`screenshot@fullSize\` format was specified' + ) + .optional(), + metadata: z + .object({ + title: z.string().optional(), + description: z.string().optional(), + language: z.string().optional(), + sourceURL: z.string().url().optional(), + ' ': z.string().optional(), + /** The status code of the page */ + statusCode: z + .number() + .int() + .describe('The status code of the page') + .optional(), + /** The error message of the page */ + error: z.string().describe('The error message of the page').optional() + }) + .optional() + }) + export type CrawlStatusResponseObj = z.infer< + typeof CrawlStatusResponseObjSchema + > + + // ----------------------------------------------------------------------------- + // Operation schemas + // ----------------------------------------------------------------------------- + + export const ScrapeParamsSchema = z.object({ + /** The URL to scrape */ + url: z.string().url().describe('The URL to scrape'), + /** + * Specific formats to return. + * + * - markdown: The page in Markdown format. + * - html: The page's HTML, trimmed to include only meaningful content. + * - rawHtml: The page's original HTML. + * - links: The links on the page. + * - screenshot: A screenshot of the top of the page. + * - screenshot@fullPage: A screenshot of the full page. (overridden by screenshot if present) + */ + formats: z + .array( + z.enum([ + 'markdown', + 'html', + 'rawHtml', + 'links', + 'screenshot', + 'screenshot@fullPage' + ]) + ) + .describe( + "Specific formats to return.\\n\\n - markdown: The page in Markdown format.\\n - html: The page's HTML, trimmed to include only meaningful content.\\n - rawHtml: The page's original HTML.\\n - links: The links on the page.\\n - screenshot: A screenshot of the top of the page.\\n - screenshot@fullPage: A screenshot of the full page. (overridden by screenshot if present)" + ) + .default(['markdown']), + /** Headers to send with the request. Can be used to send cookies, user-agent, etc. */ + headers: z + .record(z.any()) + .describe( + 'Headers to send with the request. Can be used to send cookies, user-agent, etc.' + ) + .optional(), + /** Only include tags, classes and ids from the page in the final output. Use comma separated values. Example: 'script, .ad, #footer' */ + includeTags: z + .array(z.string()) + .describe( + "Only include tags, classes and ids from the page in the final output. Use comma separated values. Example: 'script, .ad, #footer'" + ) + .optional(), + /** Tags, classes and ids to remove from the page. Use comma separated values. Example: 'script, .ad, #footer' */ + excludeTags: z + .array(z.string()) + .describe( + "Tags, classes and ids to remove from the page. Use comma separated values. Example: 'script, .ad, #footer'" + ) + .optional(), + /** Only return the main content of the page excluding headers, navs, footers, etc. */ + onlyMainContent: z + .boolean() + .describe( + 'Only return the main content of the page excluding headers, navs, footers, etc.' + ) + .default(true), + /** Timeout in milliseconds for the request */ + timeout: z + .number() + .int() + .describe('Timeout in milliseconds for the request') + .default(30000), + /** Wait x amount of milliseconds for the page to load to fetch content */ + waitFor: z + .number() + .int() + .describe( + 'Wait x amount of milliseconds for the page to load to fetch content' + ) + .default(0) + }) + export type ScrapeParams = z.infer + + export const CrawlUrlsParamsSchema = z.object({ + /** The base URL to start crawling from */ + url: z.string().url().describe('The base URL to start crawling from'), + crawlerOptions: z + .object({ + /** URL patterns to include */ + includes: z + .array(z.string()) + .describe('URL patterns to include') + .optional(), + /** URL patterns to exclude */ + excludes: z + .array(z.string()) + .describe('URL patterns to exclude') + .optional(), + /** Generate alt text for images using LLMs (must have a paid plan) */ + generateImgAltText: z + .boolean() + .describe( + 'Generate alt text for images using LLMs (must have a paid plan)' + ) + .default(false), + /** If true, returns only the URLs as a list on the crawl status. Attention: the return response will be a list of URLs inside the data, not a list of documents. */ + returnOnlyUrls: z + .boolean() + .describe( + 'If true, returns only the URLs as a list on the crawl status. Attention: the return response will be a list of URLs inside the data, not a list of documents.' + ) + .default(false), + /** Maximum depth to crawl relative to the entered URL. A maxDepth of 0 scrapes only the entered URL. A maxDepth of 1 scrapes the entered URL and all pages one level deep. A maxDepth of 2 scrapes the entered URL and all pages up to two levels deep. Higher values follow the same pattern. */ + maxDepth: z + .number() + .int() + .describe( + 'Maximum depth to crawl relative to the entered URL. A maxDepth of 0 scrapes only the entered URL. A maxDepth of 1 scrapes the entered URL and all pages one level deep. A maxDepth of 2 scrapes the entered URL and all pages up to two levels deep. Higher values follow the same pattern.' + ) + .optional(), + /** The crawling mode to use. Fast mode crawls 4x faster websites without sitemap, but may not be as accurate and shouldn't be used in heavy js-rendered websites. */ + mode: z + .enum(['default', 'fast']) + .describe( + "The crawling mode to use. Fast mode crawls 4x faster websites without sitemap, but may not be as accurate and shouldn't be used in heavy js-rendered websites." + ) + .default('default'), + /** Ignore the website sitemap when crawling */ + ignoreSitemap: z + .boolean() + .describe('Ignore the website sitemap when crawling') + .default(false), + /** Maximum number of pages to crawl */ + limit: z + .number() + .int() + .describe('Maximum number of pages to crawl') + .default(10000), + /** Enables the crawler to navigate from a specific URL to previously linked pages. For instance, from 'example.com/product/123' back to 'example.com/product' */ + allowBackwardCrawling: z + .boolean() + .describe( + "Enables the crawler to navigate from a specific URL to previously linked pages. For instance, from 'example.com/product/123' back to 'example.com/product'" + ) + .default(false), + /** Allows the crawler to follow links to external websites. */ + allowExternalContentLinks: z + .boolean() + .describe('Allows the crawler to follow links to external websites.') + .default(false) + }) + .optional(), + pageOptions: z + .object({ + /** Headers to send with the request. Can be used to send cookies, user-agent, etc. */ + headers: z + .record(z.any()) + .describe( + 'Headers to send with the request. Can be used to send cookies, user-agent, etc.' + ) + .optional(), + /** Include the HTML version of the content on page. Will output a html key in the response. */ + includeHtml: z + .boolean() + .describe( + 'Include the HTML version of the content on page. Will output a html key in the response.' + ) + .default(false), + /** Include the raw HTML content of the page. Will output a rawHtml key in the response. */ + includeRawHtml: z + .boolean() + .describe( + 'Include the raw HTML content of the page. Will output a rawHtml key in the response.' + ) + .default(false), + /** Only include tags, classes and ids from the page in the final output. Use comma separated values. Example: 'script, .ad, #footer' */ + onlyIncludeTags: z + .array(z.string()) + .describe( + "Only include tags, classes and ids from the page in the final output. Use comma separated values. Example: 'script, .ad, #footer'" + ) + .optional(), + /** Only return the main content of the page excluding headers, navs, footers, etc. */ + onlyMainContent: z + .boolean() + .describe( + 'Only return the main content of the page excluding headers, navs, footers, etc.' + ) + .default(false), + /** Tags, classes and ids to remove from the page. Use comma separated values. Example: 'script, .ad, #footer' */ + removeTags: z + .array(z.string()) + .describe( + "Tags, classes and ids to remove from the page. Use comma separated values. Example: 'script, .ad, #footer'" + ) + .optional(), + /** Replace all relative paths with absolute paths for images and links */ + replaceAllPathsWithAbsolutePaths: z + .boolean() + .describe( + 'Replace all relative paths with absolute paths for images and links' + ) + .default(false), + /** Include a screenshot of the top of the page that you are scraping. */ + screenshot: z + .boolean() + .describe( + 'Include a screenshot of the top of the page that you are scraping.' + ) + .default(false), + /** Include a full page screenshot of the page that you are scraping. */ + fullPageScreenshot: z + .boolean() + .describe( + 'Include a full page screenshot of the page that you are scraping.' + ) + .default(false), + /** Wait x amount of milliseconds for the page to load to fetch content */ + waitFor: z + .number() + .int() + .describe( + 'Wait x amount of milliseconds for the page to load to fetch content' + ) + .default(0) + }) + .optional() + }) + export type CrawlUrlsParams = z.infer + + export const CrawlUrlsResponseSchema = CrawlResponseSchema + export type CrawlUrlsResponse = z.infer + + export const SearchGoogleParamsSchema = z.object({ + /** The query to search for */ + query: z.string().url().describe('The query to search for'), + pageOptions: z + .object({ + /** Only return the main content of the page excluding headers, navs, footers, etc. */ + onlyMainContent: z + .boolean() + .describe( + 'Only return the main content of the page excluding headers, navs, footers, etc.' + ) + .default(false), + /** Fetch the content of each page. If false, defaults to a basic fast serp API. */ + fetchPageContent: z + .boolean() + .describe( + 'Fetch the content of each page. If false, defaults to a basic fast serp API.' + ) + .default(true), + /** Include the HTML version of the content on page. Will output a html key in the response. */ + includeHtml: z + .boolean() + .describe( + 'Include the HTML version of the content on page. Will output a html key in the response.' + ) + .default(false), + /** Include the raw HTML content of the page. Will output a rawHtml key in the response. */ + includeRawHtml: z + .boolean() + .describe( + 'Include the raw HTML content of the page. Will output a rawHtml key in the response.' + ) + .default(false) + }) + .optional(), + searchOptions: z + .object({ + /** Maximum number of results. Max is 20 during beta. */ + limit: z + .number() + .int() + .describe('Maximum number of results. Max is 20 during beta.') + .optional() + }) + .optional() + }) + export type SearchGoogleParams = z.infer + + export const SearchGoogleResponseSchema = SearchResponseSchema + export type SearchGoogleResponse = z.infer + + export const GetCrawlStatusParamsSchema = z.object({ + /** ID of the crawl job */ + jobId: z.string().describe('ID of the crawl job') + }) + export type GetCrawlStatusParams = z.infer + + export const GetCrawlStatusResponseSchema = z.object({ + /** Status of the job (completed, active, failed, paused) */ + status: z + .string() + .describe('Status of the job (completed, active, failed, paused)') + .optional(), + /** Current page number */ + current: z.number().int().describe('Current page number').optional(), + /** Total number of pages */ + total: z.number().int().describe('Total number of pages').optional(), + /** Data returned from the job (null when it is in progress) */ + data: z + .array(CrawlStatusResponseObjSchema) + .describe('Data returned from the job (null when it is in progress)') + .optional(), + /** Partial documents returned as it is being crawled (streaming). **This feature is currently in alpha - expect breaking changes** When a page is ready, it will append to the partial_data array, so there is no need to wait for the entire website to be crawled. When the crawl is done, partial_data will become empty and the result will be available in \`data\`. There is a max of 50 items in the array response. The oldest item (top of the array) will be removed when the new item is added to the array. */ + partial_data: z + .array(CrawlStatusResponseObjSchema) + .describe( + 'Partial documents returned as it is being crawled (streaming). **This feature is currently in alpha - expect breaking changes** When a page is ready, it will append to the partial_data array, so there is no need to wait for the entire website to be crawled. When the crawl is done, partial_data will become empty and the result will be available in \`data\`. There is a max of 50 items in the array response. The oldest item (top of the array) will be removed when the new item is added to the array.' + ) + .optional() + }) + export type GetCrawlStatusResponse = z.infer< + typeof GetCrawlStatusResponseSchema + > + + export const CancelCrawlJobParamsSchema = z.object({ + /** ID of the crawl job */ + jobId: z.string().describe('ID of the crawl job') + }) + export type CancelCrawlJobParams = z.infer + + export const CancelCrawlJobResponseSchema = z.object({ + /** Returns cancelled. */ + status: z.string().describe('Returns cancelled.').optional() + }) + export type CancelCrawlJobResponse = z.infer< + typeof CancelCrawlJobResponseSchema + > +} + +/** + * Agentic Firecrawl client. + * + * API for interacting with Firecrawl services to perform web scraping and crawling tasks. + */ +export class FirecrawlClient extends AIFunctionsProvider { + protected readonly ky: KyInstance + protected readonly apiKey: string + protected readonly apiBaseUrl: string + + constructor({ + apiKey = getEnv('FIRECRAWL_API_KEY'), + apiBaseUrl = firecrawl.apiBaseUrl, + ky = defaultKy + }: { + apiKey?: string + apiBaseUrl?: string + ky?: KyInstance + } = {}) { + assert( + apiKey, + 'FirecrawlClient missing required "apiKey" (defaults to "FIRECRAWL_API_KEY")' + ) + super() + + this.apiKey = apiKey + this.apiBaseUrl = apiBaseUrl + + this.ky = ky.extend({ + prefixUrl: apiBaseUrl, + headers: { + Authorization: apiKey + } + }) + } + + /** + * Scrape a single URL. + */ + @aiFunction({ + name: 'scrape', + description: \`Scrape a single URL.\`, + inputSchema: firecrawl.ScrapeParamsSchema + }) + async scrape( + params: firecrawl.ScrapeParams + ): Promise { + return this.ky + .post('/scrape', { + json: pick( + params, + 'url', + 'formats', + 'headers', + 'includeTags', + 'excludeTags', + 'onlyMainContent', + 'timeout', + 'waitFor' + ) + }) + .json() + } + + /** + * Crawl multiple URLs based on options. + */ + @aiFunction({ + name: 'crawl_urls', + description: \`Crawl multiple URLs based on options.\`, + inputSchema: firecrawl.CrawlUrlsParamsSchema + }) + async crawlUrls( + params: firecrawl.CrawlUrlsParams + ): Promise { + return this.ky + .post('/crawl', { + json: pick(params, 'url', 'crawlerOptions', 'pageOptions') + }) + .json() + } + + /** + * Search for a keyword in Google, returns top page results with markdown content for each page. + */ + @aiFunction({ + name: 'search_google', + description: \`Search for a keyword in Google, returns top page results with markdown content for each page.\`, + inputSchema: firecrawl.SearchGoogleParamsSchema + }) + async searchGoogle( + params: firecrawl.SearchGoogleParams + ): Promise { + return this.ky + .post('/search', { + json: pick(params, 'query', 'pageOptions', 'searchOptions') + }) + .json() + } + + /** + * Get the status of a crawl job. + */ + @aiFunction({ + name: 'get_crawl_status', + description: \`Get the status of a crawl job.\`, + inputSchema: firecrawl.GetCrawlStatusParamsSchema + }) + async getCrawlStatus( + params: firecrawl.GetCrawlStatusParams + ): Promise { + return this.ky + .get(\`/crawl/status/\${params['jobId']}\`) + .json() + } + + /** + * Cancel a crawl job. + */ + @aiFunction({ + name: 'cancel_crawl_job', + description: \`Cancel a crawl job.\`, + inputSchema: firecrawl.CancelCrawlJobParamsSchema + }) + async cancelCrawlJob( + params: firecrawl.CancelCrawlJobParams + ): Promise { + return this.ky + .delete(\`/crawl/cancel/\${params['jobId']}\`) + .json() + } +} +" +`; + +exports[`openapi-to-ts > notion.json 1`] = ` +"/* eslint-disable unicorn/no-unreadable-iife */ +/* eslint-disable unicorn/no-array-reduce */ + +/** + * This file was auto-generated from an OpenAPI spec. + */ + +import { + AIFunctionsProvider, + aiFunction, + assert, + getEnv, + pick, + sanitizeSearchParams +} from '@agentic/core' +import defaultKy, { type KyInstance } from 'ky' +import { z } from 'zod' + +export namespace notion { + export const apiBaseUrl = 'https://api.notion.so' + + // ----------------------------------------------------------------------------- + // Component schemas + // ----------------------------------------------------------------------------- + + export const UserObjectResponseSchema = z.object({ + object: z.literal('user'), + id: z.string(), + type: z.enum(['person', 'bot']), + name: z.string(), + avatar_url: z.string() + }) + export type UserObjectResponse = z.infer + + export const AnnotationRequestSchema = z.object({ + bold: z.boolean().optional(), + italic: z.boolean().optional(), + strikethrough: z.boolean().optional(), + underline: z.boolean().optional(), + code: z.boolean().optional(), + color: z + .enum([ + 'default', + 'gray', + 'brown', + 'orange', + 'yellow', + 'green', + 'blue', + 'purple', + 'pink', + 'red', + 'gray_background', + 'brown_background', + 'orange_background', + 'yellow_background', + 'green_background', + 'blue_background', + 'purple_background', + 'pink_background', + 'red_background' + ]) + .optional() + }) + export type AnnotationRequest = z.infer + + export const DateRequestSchema = z.object({ + start: z.string(), + end: z.union([z.string(), z.null()]).optional(), + time_zone: z.union([z.string(), z.null()]).optional() + }) + export type DateRequest = z.infer + + export const PageObjectResponseSchema = z.object({ + object: z.literal('page'), + id: z.string(), + created_time: z.string(), + last_edited_time: z.string(), + archived: z.boolean(), + url: z.string() + }) + export type PageObjectResponse = z.infer + + export const PartialPageObjectResponseSchema = z.object({ + object: z.literal('page'), + id: z.string() + }) + export type PartialPageObjectResponse = z.infer< + typeof PartialPageObjectResponseSchema + > + + export const PropertyItemObjectResponseSchema = z.object({ + type: z.string(), + id: z.string() + }) + export type PropertyItemObjectResponse = z.infer< + typeof PropertyItemObjectResponseSchema + > + + export const PartialBlockObjectResponseSchema = z.object({ + object: z.literal('block'), + id: z.string() + }) + export type PartialBlockObjectResponse = z.infer< + typeof PartialBlockObjectResponseSchema + > + + export const BlockObjectResponseSchema = z.object({ + object: z.literal('block'), + id: z.string(), + type: z.string(), + created_time: z.string(), + last_edited_time: z.string(), + has_children: z.boolean(), + archived: z.boolean() + }) + export type BlockObjectResponse = z.infer + + export const TitlePropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('title'), + title: z.record(z.any()) + }) + export type TitlePropertyResponse = z.infer< + typeof TitlePropertyResponseSchema + > + + export const RichTextPropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('rich_text'), + rich_text: z.record(z.any()) + }) + export type RichTextPropertyResponse = z.infer< + typeof RichTextPropertyResponseSchema + > + + export const NumberPropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('number'), + number: z.object({ format: z.string() }) + }) + export type NumberPropertyResponse = z.infer< + typeof NumberPropertyResponseSchema + > + + export const SelectOptionSchema = z.object({ + id: z.string(), + name: z.string(), + color: z.string() + }) + export type SelectOption = z.infer + + export const DatePropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('date'), + date: z.record(z.any()) + }) + export type DatePropertyResponse = z.infer + + export const PeoplePropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('people'), + people: z.record(z.any()) + }) + export type PeoplePropertyResponse = z.infer< + typeof PeoplePropertyResponseSchema + > + + export const FilePropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('files'), + files: z.record(z.any()) + }) + export type FilePropertyResponse = z.infer + + export const CheckboxPropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('checkbox'), + checkbox: z.record(z.any()) + }) + export type CheckboxPropertyResponse = z.infer< + typeof CheckboxPropertyResponseSchema + > + + export const UrlPropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('url'), + url: z.record(z.any()) + }) + export type UrlPropertyResponse = z.infer + + export const EmailPropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('email'), + email: z.record(z.any()) + }) + export type EmailPropertyResponse = z.infer< + typeof EmailPropertyResponseSchema + > + + export const PhoneNumberPropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('phone_number'), + phone_number: z.record(z.any()) + }) + export type PhoneNumberPropertyResponse = z.infer< + typeof PhoneNumberPropertyResponseSchema + > + + export const FormulaPropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('formula'), + formula: z.object({ expression: z.string() }) + }) + export type FormulaPropertyResponse = z.infer< + typeof FormulaPropertyResponseSchema + > + + export const RelationPropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('relation'), + relation: z.object({ + database_id: z.string(), + synced_property_name: z.string(), + synced_property_id: z.string() + }) + }) + export type RelationPropertyResponse = z.infer< + typeof RelationPropertyResponseSchema + > + + export const RollupPropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('rollup'), + rollup: z.object({ + relation_property_name: z.string(), + relation_property_id: z.string(), + rollup_property_name: z.string(), + rollup_property_id: z.string(), + function: z.string() + }) + }) + export type RollupPropertyResponse = z.infer< + typeof RollupPropertyResponseSchema + > + + export const CreatedTimePropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('created_time'), + created_time: z.record(z.any()) + }) + export type CreatedTimePropertyResponse = z.infer< + typeof CreatedTimePropertyResponseSchema + > + + export const CreatedByPropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('created_by'), + created_by: z.record(z.any()) + }) + export type CreatedByPropertyResponse = z.infer< + typeof CreatedByPropertyResponseSchema + > + + export const LastEditedTimePropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('last_edited_time'), + last_edited_time: z.record(z.any()) + }) + export type LastEditedTimePropertyResponse = z.infer< + typeof LastEditedTimePropertyResponseSchema + > + + export const LastEditedByPropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('last_edited_by'), + last_edited_by: z.record(z.any()) + }) + export type LastEditedByPropertyResponse = z.infer< + typeof LastEditedByPropertyResponseSchema + > + + export const PartialUserObjectResponseSchema = z.object({ + object: z.literal('user'), + id: z.string() + }) + export type PartialUserObjectResponse = z.infer< + typeof PartialUserObjectResponseSchema + > + + export const AnnotationResponseSchema = z.object({ + bold: z.boolean(), + italic: z.boolean(), + strikethrough: z.boolean(), + underline: z.boolean(), + code: z.boolean(), + color: z.enum([ + 'default', + 'gray', + 'brown', + 'orange', + 'yellow', + 'green', + 'blue', + 'purple', + 'pink', + 'red', + 'gray_background', + 'brown_background', + 'orange_background', + 'yellow_background', + 'green_background', + 'blue_background', + 'purple_background', + 'pink_background', + 'red_background' + ]) + }) + export type AnnotationResponse = z.infer + + export const DateResponseSchema = z.object({ + start: z.string(), + end: z.union([z.string(), z.null()]), + time_zone: z.union([z.string(), z.null()]) + }) + export type DateResponse = z.infer + + export const PropertyUpdateSchemaSchema = z.object({ + name: z.string().optional(), + type: z.string().optional() + }) + export type PropertyUpdateSchema = z.infer + + export const TextPropertyFilterSchema = z.object({ + equals: z.string().optional(), + does_not_equal: z.string().optional(), + contains: z.string().optional(), + does_not_contain: z.string().optional(), + starts_with: z.string().optional(), + ends_with: z.string().optional(), + is_empty: z.boolean().optional(), + is_not_empty: z.boolean().optional() + }) + export type TextPropertyFilter = z.infer + + export const NumberPropertyFilterSchema = z.object({ + equals: z.number().optional(), + does_not_equal: z.number().optional(), + greater_than: z.number().optional(), + less_than: z.number().optional(), + greater_than_or_equal_to: z.number().optional(), + less_than_or_equal_to: z.number().optional(), + is_empty: z.boolean().optional(), + is_not_empty: z.boolean().optional() + }) + export type NumberPropertyFilter = z.infer + + export const CheckboxPropertyFilterSchema = z.object({ + equals: z.boolean().optional(), + does_not_equal: z.boolean().optional() + }) + export type CheckboxPropertyFilter = z.infer< + typeof CheckboxPropertyFilterSchema + > + + export const SelectPropertyFilterSchema = z.object({ + equals: z.string().optional(), + does_not_equal: z.string().optional(), + is_empty: z.boolean().optional(), + is_not_empty: z.boolean().optional() + }) + export type SelectPropertyFilter = z.infer + + export const MultiSelectPropertyFilterSchema = z.object({ + contains: z.string().optional(), + does_not_contain: z.string().optional(), + is_empty: z.boolean().optional(), + is_not_empty: z.boolean().optional() + }) + export type MultiSelectPropertyFilter = z.infer< + typeof MultiSelectPropertyFilterSchema + > + + export const DatePropertyFilterSchema = z.object({ + equals: z.string().optional(), + before: z.string().optional(), + after: z.string().optional(), + on_or_before: z.string().optional(), + on_or_after: z.string().optional(), + past_week: z.any().optional(), + past_month: z.any().optional(), + past_year: z.any().optional(), + next_week: z.any().optional(), + next_month: z.any().optional(), + next_year: z.any().optional(), + is_empty: z.boolean().optional(), + is_not_empty: z.boolean().optional() + }) + export type DatePropertyFilter = z.infer + + export const PeoplePropertyFilterSchema = z.object({ + contains: z.string().optional(), + does_not_contain: z.string().optional(), + is_empty: z.boolean().optional(), + is_not_empty: z.boolean().optional() + }) + export type PeoplePropertyFilter = z.infer + + export const FilesPropertyFilterSchema = z.object({ + is_empty: z.boolean().optional(), + is_not_empty: z.boolean().optional() + }) + export type FilesPropertyFilter = z.infer + + export const RelationPropertyFilterSchema = z.object({ + contains: z.string().optional(), + does_not_contain: z.string().optional(), + is_empty: z.boolean().optional(), + is_not_empty: z.boolean().optional() + }) + export type RelationPropertyFilter = z.infer< + typeof RelationPropertyFilterSchema + > + + export const PropertySchemaSchema = z.object({ + type: z.string(), + name: z.union([z.string(), z.null()]).optional() + }) + export type PropertySchema = z.infer + + export const SearchParametersSchema = z.object({ + query: z.string().optional(), + sort: z + .object({ + direction: z.enum(['ascending', 'descending']), + timestamp: z.literal('last_edited_time') + }) + .optional(), + filter: z + .object({ + value: z.enum(['page', 'database']), + property: z.literal('object') + }) + .optional(), + start_cursor: z.string().optional(), + page_size: z.number().int().optional() + }) + export type SearchParameters = z.infer + + export const PartialCommentObjectResponseSchema = z.object({ + object: z.literal('comment'), + id: z.string() + }) + export type PartialCommentObjectResponse = z.infer< + typeof PartialCommentObjectResponseSchema + > + + export const OauthTokenParametersSchema = z.object({ + grant_type: z.string(), + code: z.string(), + redirect_uri: z.string().optional(), + external_account: z.object({ key: z.string(), name: z.string() }).optional() + }) + export type OauthTokenParameters = z.infer + + export const ListUsersResponseSchema = z.object({ + results: z.array(UserObjectResponseSchema), + next_cursor: z.union([z.string(), z.null()]), + has_more: z.boolean() + }) + export type ListUsersResponse = z.infer + + export const PropertyItemListResponseSchema = z.object({ + results: z.array(PropertyItemObjectResponseSchema), + next_cursor: z.union([z.string(), z.null()]), + has_more: z.boolean() + }) + export type PropertyItemListResponse = z.infer< + typeof PropertyItemListResponseSchema + > + + export const SelectPropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('select'), + select: z.object({ options: z.array(SelectOptionSchema) }) + }) + export type SelectPropertyResponse = z.infer< + typeof SelectPropertyResponseSchema + > + + export const MultiSelectPropertyResponseSchema = z.object({ + id: z.string(), + type: z.literal('multi_select'), + multi_select: z.object({ options: z.array(SelectOptionSchema) }) + }) + export type MultiSelectPropertyResponse = z.infer< + typeof MultiSelectPropertyResponseSchema + > + + export const TextRichTextItemResponseSchema = z.object({ + type: z.literal('text'), + text: z.object({ + content: z.string(), + link: z.union([z.object({ url: z.string() }), z.null()]) + }), + annotations: AnnotationResponseSchema, + plain_text: z.string(), + href: z.union([z.string(), z.null()]) + }) + export type TextRichTextItemResponse = z.infer< + typeof TextRichTextItemResponseSchema + > + + export const EquationRichTextItemResponseSchema = z.object({ + type: z.literal('equation'), + equation: z.object({ expression: z.string() }), + annotations: AnnotationResponseSchema, + plain_text: z.string(), + href: z.union([z.string(), z.null()]) + }) + export type EquationRichTextItemResponse = z.infer< + typeof EquationRichTextItemResponseSchema + > + + export const ListBlockChildrenResponseSchema = z.object({ + object: z.literal('list'), + results: z.array( + z.union([PartialBlockObjectResponseSchema, BlockObjectResponseSchema]) + ), + next_cursor: z.union([z.string(), z.null()]), + has_more: z.boolean() + }) + export type ListBlockChildrenResponse = z.infer< + typeof ListBlockChildrenResponseSchema + > + + export const AppendBlockChildrenResponseSchema = z.object({ + object: z.literal('list'), + results: z.array( + z.union([PartialBlockObjectResponseSchema, BlockObjectResponseSchema]) + ), + next_cursor: z.union([z.string(), z.null()]), + has_more: z.boolean() + }) + export type AppendBlockChildrenResponse = z.infer< + typeof AppendBlockChildrenResponseSchema + > + + export const QueryDatabaseResponseSchema = z.object({ + object: z.literal('list'), + results: z.array( + z.union([PageObjectResponseSchema, PartialPageObjectResponseSchema]) + ), + next_cursor: z.union([z.string(), z.null()]), + has_more: z.boolean() + }) + export type QueryDatabaseResponse = z.infer< + typeof QueryDatabaseResponseSchema + > + + export const OauthTokenResponseSchema = z.object({ + access_token: z.string(), + token_type: z.literal('bearer'), + bot_id: z.string(), + workspace_name: z.union([z.string(), z.null()]), + workspace_icon: z.union([z.string(), z.null()]), + workspace_id: z.string(), + owner: z.union([ + z.object({ + type: z.literal('user'), + user: z.union([ + UserObjectResponseSchema, + PartialUserObjectResponseSchema + ]) + }), + z.object({ type: z.literal('workspace'), workspace: z.literal(true) }) + ]), + duplicated_template_id: z.union([z.string(), z.null()]) + }) + export type OauthTokenResponse = z.infer + + export const RichTextItemRequestSchema = z.union([ + z.object({ + text: z.object({ + content: z.string(), + link: z.union([z.object({ url: z.string() }), z.null()]).optional() + }), + type: z.literal('text').optional(), + annotations: AnnotationRequestSchema.optional() + }), + z.object({ + mention: z.union([ + z.object({ + user: z.union([ + z.object({ id: z.string() }), + UserObjectResponseSchema + ]) + }), + z.object({ page: z.object({ id: z.string() }) }), + z.object({ database: z.object({ id: z.string() }) }), + z.object({ date: DateRequestSchema }) + ]), + type: z.literal('mention').optional(), + annotations: AnnotationRequestSchema.optional() + }), + z.object({ + equation: z.object({ expression: z.string() }), + type: z.literal('equation').optional(), + annotations: AnnotationRequestSchema.optional() + }) + ]) + export type RichTextItemRequest = z.infer + + export const CreatePageParametersSchema = z.object({ + parent: z + .record(z.any()) + .and( + z.union([ + z.object({ type: z.literal('page_id'), page_id: z.string() }), + z.object({ type: z.literal('database_id'), database_id: z.string() }) + ]) + ), + properties: z.record( + z.union([ + z.object({ title: z.array(RichTextItemRequestSchema) }), + z.object({ rich_text: z.array(RichTextItemRequestSchema) }), + z.object({ number: z.union([z.number(), z.null()]) }), + z.object({ + select: z.union([z.object({ name: z.string() }), z.null()]) + }) + ]) + ) + }) + export type CreatePageParameters = z.infer + + export const UpdatePageParametersSchema = z.object({ + properties: z + .record( + z.union([ + z.object({ title: z.array(RichTextItemRequestSchema) }), + z.object({ rich_text: z.array(RichTextItemRequestSchema) }), + z.object({ number: z.union([z.number(), z.null()]) }), + z.object({ + select: z.union([z.object({ name: z.string() }), z.null()]) + }) + ]) + ) + .optional(), + archived: z.boolean().optional() + }) + export type UpdatePageParameters = z.infer + + export const UpdateBlockParametersSchema = z.object({ + paragraph: z + .object({ + rich_text: z.array(RichTextItemRequestSchema).optional(), + color: z.string().optional() + }) + .optional(), + heading_1: z + .object({ + rich_text: z.array(RichTextItemRequestSchema).optional(), + color: z.string().optional() + }) + .optional(), + heading_2: z + .object({ + rich_text: z.array(RichTextItemRequestSchema).optional(), + color: z.string().optional() + }) + .optional(), + heading_3: z + .object({ + rich_text: z.array(RichTextItemRequestSchema).optional(), + color: z.string().optional() + }) + .optional(), + bulleted_list_item: z + .object({ + rich_text: z.array(RichTextItemRequestSchema).optional(), + color: z.string().optional() + }) + .optional(), + numbered_list_item: z + .object({ + rich_text: z.array(RichTextItemRequestSchema).optional(), + color: z.string().optional() + }) + .optional(), + quote: z + .object({ + rich_text: z.array(RichTextItemRequestSchema).optional(), + color: z.string().optional() + }) + .optional(), + to_do: z + .object({ + rich_text: z.array(RichTextItemRequestSchema).optional(), + checked: z.boolean().optional(), + color: z.string().optional() + }) + .optional(), + toggle: z + .object({ + rich_text: z.array(RichTextItemRequestSchema).optional(), + color: z.string().optional() + }) + .optional(), + code: z + .object({ + rich_text: z.array(RichTextItemRequestSchema).optional(), + language: z.string().optional() + }) + .optional(), + embed: z.object({ url: z.string().optional() }).optional(), + image: z + .object({ external: z.object({ url: z.string().optional() }).optional() }) + .optional(), + video: z + .object({ external: z.object({ url: z.string().optional() }).optional() }) + .optional(), + file: z + .object({ external: z.object({ url: z.string().optional() }).optional() }) + .optional(), + pdf: z + .object({ external: z.object({ url: z.string().optional() }).optional() }) + .optional(), + bookmark: z.object({ url: z.string().optional() }).optional(), + equation: z.object({ expression: z.string().optional() }).optional(), + divider: z.record(z.any()).optional(), + table_of_contents: z.object({ color: z.string().optional() }).optional(), + breadcrumb: z.record(z.any()).optional(), + column_list: z.record(z.any()).optional(), + column: z.record(z.any()).optional(), + link_to_page: z + .object({ + type: z.enum(['page_id', 'database_id']).optional(), + page_id: z.string().optional(), + database_id: z.string().optional() + }) + .optional(), + table_row: z + .object({ cells: z.array(z.array(RichTextItemRequestSchema)).optional() }) + .optional(), + archived: z.boolean().optional() + }) + export type UpdateBlockParameters = z.infer< + typeof UpdateBlockParametersSchema + > + + export const BlockObjectRequestSchema = z.union([ + z.object({ + object: z.literal('block'), + type: z.literal('paragraph'), + paragraph: z.object({ + rich_text: z.array(RichTextItemRequestSchema), + color: z.string().optional() + }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('heading_1'), + heading_1: z.object({ + rich_text: z.array(RichTextItemRequestSchema), + color: z.string().optional() + }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('heading_2'), + heading_2: z.object({ + rich_text: z.array(RichTextItemRequestSchema), + color: z.string().optional() + }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('heading_3'), + heading_3: z.object({ + rich_text: z.array(RichTextItemRequestSchema), + color: z.string().optional() + }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('bulleted_list_item'), + bulleted_list_item: z.object({ + rich_text: z.array(RichTextItemRequestSchema), + color: z.string().optional() + }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('numbered_list_item'), + numbered_list_item: z.object({ + rich_text: z.array(RichTextItemRequestSchema), + color: z.string().optional() + }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('to_do'), + to_do: z.object({ + rich_text: z.array(RichTextItemRequestSchema), + checked: z.boolean(), + color: z.string().optional() + }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('toggle'), + toggle: z.object({ + rich_text: z.array(RichTextItemRequestSchema), + color: z.string().optional() + }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('code'), + code: z.object({ + rich_text: z.array(RichTextItemRequestSchema), + language: z.string(), + caption: z.array(RichTextItemRequestSchema).optional() + }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('child_page'), + child_page: z.object({ title: z.string() }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('child_database'), + child_database: z.object({ title: z.string() }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('embed'), + embed: z.object({ + url: z.string(), + caption: z.array(RichTextItemRequestSchema).optional() + }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('image'), + image: z.object({ + external: z.object({ url: z.string() }), + caption: z.array(RichTextItemRequestSchema).optional() + }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('video'), + video: z.object({ + external: z.object({ url: z.string() }), + caption: z.array(RichTextItemRequestSchema).optional() + }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('file'), + file: z.object({ + external: z.object({ url: z.string() }), + caption: z.array(RichTextItemRequestSchema).optional() + }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('pdf'), + pdf: z.object({ + external: z.object({ url: z.string() }), + caption: z.array(RichTextItemRequestSchema).optional() + }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('bookmark'), + bookmark: z.object({ + url: z.string(), + caption: z.array(RichTextItemRequestSchema).optional() + }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('equation'), + equation: z.object({ expression: z.string() }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('divider'), + divider: z.record(z.any()) + }), + z.object({ + object: z.literal('block'), + type: z.literal('table_of_contents'), + table_of_contents: z.object({ color: z.string().optional() }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('column_list'), + column_list: z.record(z.any()) + }), + z.object({ + object: z.literal('block'), + type: z.literal('column'), + column: z.record(z.any()) + }), + z.object({ + object: z.literal('block'), + type: z.literal('link_to_page'), + link_to_page: z.union([ + z.object({ type: z.literal('page_id'), page_id: z.string() }), + z.object({ type: z.literal('database_id'), database_id: z.string() }) + ]) + }), + z.object({ + object: z.literal('block'), + type: z.literal('table'), + table: z.object({ + table_width: z.number().int(), + has_column_header: z.boolean().optional(), + has_row_header: z.boolean().optional(), + children: z.array( + // TODO: Support recursive types for \`BlockObjectRequestSchema\`. + z.any() + ) + }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('table_row'), + table_row: z.object({ + cells: z.array(z.array(RichTextItemRequestSchema)) + }) + }), + z.object({ + object: z.literal('block'), + type: z.literal('synced_block'), + synced_block: z.object({ + synced_from: z + .union([ + z.object({ type: z.literal('block_id'), block_id: z.string() }), + z.null() + ]) + .optional(), + children: z + .array( + // TODO: Support recursive types for \`BlockObjectRequestSchema\`. + z.any() + ) + .optional() + }) + }) + ]) + export type BlockObjectRequest = z.infer + + export const MentionRichTextItemResponseSchema = z.object({ + type: z.literal('mention'), + mention: z.union([ + z.object({ + type: z.literal('user'), + user: z.union([ + PartialUserObjectResponseSchema, + UserObjectResponseSchema + ]) + }), + z.object({ type: z.literal('date'), date: DateResponseSchema }), + z.object({ + type: z.literal('link_preview'), + link_preview: z.object({ url: z.string() }) + }), + z.object({ type: z.literal('page'), page: z.object({ id: z.string() }) }), + z.object({ + type: z.literal('database'), + database: z.object({ id: z.string() }) + }) + ]), + annotations: AnnotationResponseSchema, + plain_text: z.string(), + href: z.union([z.string(), z.null()]) + }) + export type MentionRichTextItemResponse = z.infer< + typeof MentionRichTextItemResponseSchema + > + + export const CreateCommentParametersSchema = z.union([ + z.object({ + parent: z.object({ + page_id: z.string(), + type: z.literal('page_id').optional() + }), + rich_text: z.array(RichTextItemRequestSchema) + }), + z.object({ + discussion_id: z.string(), + rich_text: z.array(RichTextItemRequestSchema) + }) + ]) + export type CreateCommentParameters = z.infer< + typeof CreateCommentParametersSchema + > + + export const AppendBlockChildrenParametersSchema = z.object({ + children: z.array(BlockObjectRequestSchema) + }) + export type AppendBlockChildrenParameters = z.infer< + typeof AppendBlockChildrenParametersSchema + > + + export const UpdateDatabaseParametersSchema = z.object({ + title: z.array(RichTextItemRequestSchema).optional(), + description: z.array(RichTextItemRequestSchema).optional(), + icon: z + .union([ + z.object({ emoji: z.string(), type: z.literal('emoji') }), + z.object({ + external: z.object({ url: z.string() }), + type: z.literal('external') + }), + z.null() + ]) + .optional(), + cover: z + .union([ + z.object({ + external: z.object({ url: z.string() }), + type: z.literal('external') + }), + z.null() + ]) + .optional(), + properties: z.record(PropertyUpdateSchemaSchema).optional(), + is_inline: z.boolean().optional(), + archived: z.boolean().optional() + }) + export type UpdateDatabaseParameters = z.infer< + typeof UpdateDatabaseParametersSchema + > + + export const CreateDatabaseParametersSchema = z.object({ + parent: z.union([ + z.object({ type: z.literal('page_id'), page_id: z.string() }), + z.object({ type: z.literal('database_id'), database_id: z.string() }) + ]), + properties: z.record(PropertySchemaSchema), + icon: z + .union([ + z.object({ type: z.literal('emoji'), emoji: z.string() }), + z.object({ + type: z.literal('external'), + external: z.object({ url: z.string() }) + }), + z.null() + ]) + .optional(), + cover: z + .union([ + z.object({ + type: z.literal('external'), + external: z.object({ url: z.string() }) + }), + z.null() + ]) + .optional(), + title: z.array(RichTextItemRequestSchema), + description: z.array(RichTextItemRequestSchema).optional(), + is_inline: z.boolean().optional() + }) + export type CreateDatabaseParameters = z.infer< + typeof CreateDatabaseParametersSchema + > + + export const RichTextItemResponseSchema = z.union([ + TextRichTextItemResponseSchema, + MentionRichTextItemResponseSchema, + EquationRichTextItemResponseSchema + ]) + export type RichTextItemResponse = z.infer + + export const CommentObjectResponseSchema = z.object({ + object: z.literal('comment'), + id: z.string(), + parent: z.union([ + z.object({ type: z.literal('page_id'), page_id: z.string() }), + z.object({ type: z.literal('block_id'), block_id: z.string() }) + ]), + discussion_id: z.string(), + rich_text: z.array(RichTextItemResponseSchema), + created_by: PartialUserObjectResponseSchema, + created_time: z.string(), + last_edited_time: z.string() + }) + export type CommentObjectResponse = z.infer< + typeof CommentObjectResponseSchema + > + + export const PropertyFilterSchema = z.union([ + z.object({ property: z.string(), title: TextPropertyFilterSchema }), + z.object({ property: z.string(), rich_text: TextPropertyFilterSchema }), + z.object({ property: z.string(), number: NumberPropertyFilterSchema }), + z.object({ property: z.string(), checkbox: CheckboxPropertyFilterSchema }), + z.object({ property: z.string(), select: SelectPropertyFilterSchema }), + z.object({ + property: z.string(), + multi_select: MultiSelectPropertyFilterSchema + }), + z.object({ property: z.string(), date: DatePropertyFilterSchema }), + z.object({ property: z.string(), people: PeoplePropertyFilterSchema }), + z.object({ property: z.string(), files: FilesPropertyFilterSchema }), + z.object({ property: z.string(), url: TextPropertyFilterSchema }), + z.object({ property: z.string(), email: TextPropertyFilterSchema }), + z.object({ property: z.string(), phone_number: TextPropertyFilterSchema }), + z.object({ property: z.string(), relation: RelationPropertyFilterSchema }), + z.object({ property: z.string(), created_by: PeoplePropertyFilterSchema }), + z.object({ property: z.string(), created_time: DatePropertyFilterSchema }), + z.object({ + property: z.string(), + last_edited_by: PeoplePropertyFilterSchema + }), + z.object({ + property: z.string(), + last_edited_time: DatePropertyFilterSchema + }), + z.object({ + timestamp: z.enum(['created_time', 'last_edited_time']), + created_time: DatePropertyFilterSchema + }), + z.object({ + timestamp: z.enum(['created_time', 'last_edited_time']), + last_edited_time: DatePropertyFilterSchema + }) + ]) + export type PropertyFilter = z.infer + + export const ListCommentsResponseSchema = z.object({ + object: z.literal('list'), + results: z.array(CommentObjectResponseSchema), + next_cursor: z.union([z.string(), z.null()]), + has_more: z.boolean() + }) + export type ListCommentsResponse = z.infer + + export const CompoundFilterSchema = z.object({ + and: z.array(PropertyFilterSchema).optional(), + or: z.array(PropertyFilterSchema).optional() + }) + export type CompoundFilter = z.infer + + export const QueryDatabaseParametersSchema = z.object({ + sorts: z + .array( + z.union([ + z.object({ + property: z.string(), + direction: z.enum(['ascending', 'descending']) + }), + z.object({ + timestamp: z.enum(['created_time', 'last_edited_time']), + direction: z.enum(['ascending', 'descending']) + }) + ]) + ) + .optional(), + filter: z.union([PropertyFilterSchema, CompoundFilterSchema]).optional(), + start_cursor: z.string().optional(), + page_size: z.number().int().optional(), + archived: z.boolean().optional() + }) + export type QueryDatabaseParameters = z.infer< + typeof QueryDatabaseParametersSchema + > + + export const DatabasePropertyConfigResponseSchema = z.union([ + TitlePropertyResponseSchema, + RichTextPropertyResponseSchema, + NumberPropertyResponseSchema, + SelectPropertyResponseSchema, + MultiSelectPropertyResponseSchema, + DatePropertyResponseSchema, + PeoplePropertyResponseSchema, + FilePropertyResponseSchema, + CheckboxPropertyResponseSchema, + UrlPropertyResponseSchema, + EmailPropertyResponseSchema, + PhoneNumberPropertyResponseSchema, + FormulaPropertyResponseSchema, + RelationPropertyResponseSchema, + RollupPropertyResponseSchema, + CreatedTimePropertyResponseSchema, + CreatedByPropertyResponseSchema, + LastEditedTimePropertyResponseSchema, + LastEditedByPropertyResponseSchema + ]) + export type DatabasePropertyConfigResponse = z.infer< + typeof DatabasePropertyConfigResponseSchema + > + + export const PartialDatabaseObjectResponseSchema = z.object({ + object: z.literal('database'), + id: z.string(), + properties: z.record(DatabasePropertyConfigResponseSchema) + }) + export type PartialDatabaseObjectResponse = z.infer< + typeof PartialDatabaseObjectResponseSchema + > + + export const DatabaseObjectResponseSchema = z.object({ + object: z.literal('database'), + id: z.string(), + cover: z + .union([ + z.object({ + type: z.literal('external'), + external: z.object({ url: z.string() }) + }), + z.null() + ]) + .optional(), + icon: z + .union([ + z.object({ type: z.literal('emoji'), emoji: z.string() }), + z.object({ + type: z.literal('external'), + external: z.object({ url: z.string() }) + }), + z.null() + ]) + .optional(), + created_time: z.string(), + created_by: PartialUserObjectResponseSchema, + last_edited_time: z.string(), + last_edited_by: PartialUserObjectResponseSchema, + title: z.array(RichTextItemResponseSchema), + description: z.array(RichTextItemResponseSchema), + is_inline: z.boolean(), + properties: z.record(DatabasePropertyConfigResponseSchema), + parent: z.union([ + z.object({ type: z.literal('page_id'), page_id: z.string() }), + z.object({ type: z.literal('workspace'), workspace: z.literal(true) }) + ]), + url: z.string(), + archived: z.boolean() + }) + export type DatabaseObjectResponse = z.infer< + typeof DatabaseObjectResponseSchema + > + + export const ListDatabasesResponseSchema = z.object({ + object: z.literal('list'), + results: z.array( + z.union([ + PartialDatabaseObjectResponseSchema, + DatabaseObjectResponseSchema + ]) + ), + next_cursor: z.union([z.string(), z.null()]), + has_more: z.boolean() + }) + export type ListDatabasesResponse = z.infer< + typeof ListDatabasesResponseSchema + > + + export const SearchResponseSchema = z.object({ + object: z.literal('list'), + results: z.array( + z.union([ + PageObjectResponseSchema, + PartialPageObjectResponseSchema, + PartialDatabaseObjectResponseSchema, + DatabaseObjectResponseSchema + ]) + ), + next_cursor: z.union([z.string(), z.null()]), + has_more: z.boolean() + }) + export type SearchResponse = z.infer + + // ----------------------------------------------------------------------------- + // Operation schemas + // ----------------------------------------------------------------------------- + + export const GetSelfParamsSchema = z.object({}) + export type GetSelfParams = z.infer + + export const GetSelfResponseSchema = UserObjectResponseSchema + export type GetSelfResponse = z.infer + + export const GetUserParamsSchema = z.object({ user_id: z.string() }) + export type GetUserParams = z.infer + + export const GetUserResponseSchema = UserObjectResponseSchema + export type GetUserResponse = z.infer + + export const ListUsersParamsSchema = z.object({ + start_cursor: z.string().optional(), + page_size: z.number().int().optional() + }) + export type ListUsersParams = z.infer + + export const CreatePageParamsSchema = CreatePageParametersSchema + export type CreatePageParams = z.infer + + export const CreatePageResponseSchema = z.union([ + PageObjectResponseSchema, + PartialPageObjectResponseSchema + ]) + export type CreatePageResponse = z.infer + + export const GetPageParamsSchema = z.object({ + page_id: z.string(), + filter_properties: z.array(z.string()).optional() + }) + export type GetPageParams = z.infer + + export const GetPageResponseSchema = z.union([ + PageObjectResponseSchema, + PartialPageObjectResponseSchema + ]) + export type GetPageResponse = z.infer + + export const UpdatePageParamsSchema = z + .object({ page_id: z.string() }) + .merge(UpdatePageParametersSchema) + export type UpdatePageParams = z.infer + + export const UpdatePageResponseSchema = z.union([ + PageObjectResponseSchema, + PartialPageObjectResponseSchema + ]) + export type UpdatePageResponse = z.infer + + export const GetPagePropertyParamsSchema = z.object({ + page_id: z.string(), + property_id: z.string(), + start_cursor: z.string().optional(), + page_size: z.number().int().optional() + }) + export type GetPagePropertyParams = z.infer< + typeof GetPagePropertyParamsSchema + > + + export const GetPagePropertyResponseSchema = z.union([ + PropertyItemObjectResponseSchema, + PropertyItemListResponseSchema + ]) + export type GetPagePropertyResponse = z.infer< + typeof GetPagePropertyResponseSchema + > + + export const GetBlockParamsSchema = z.object({ block_id: z.string() }) + export type GetBlockParams = z.infer + + export const GetBlockResponseSchema = z.union([ + PartialBlockObjectResponseSchema, + BlockObjectResponseSchema + ]) + export type GetBlockResponse = z.infer + + export const DeleteBlockParamsSchema = z.object({ block_id: z.string() }) + export type DeleteBlockParams = z.infer + + export const DeleteBlockResponseSchema = z.union([ + PartialBlockObjectResponseSchema, + BlockObjectResponseSchema + ]) + export type DeleteBlockResponse = z.infer + + export const UpdateBlockParamsSchema = z + .object({ block_id: z.string() }) + .merge(UpdateBlockParametersSchema) + export type UpdateBlockParams = z.infer + + export const UpdateBlockResponseSchema = z.union([ + PartialBlockObjectResponseSchema, + BlockObjectResponseSchema + ]) + export type UpdateBlockResponse = z.infer + + export const ListBlockChildrenParamsSchema = z.object({ + block_id: z.string(), + start_cursor: z.string().optional(), + page_size: z.number().int().optional() + }) + export type ListBlockChildrenParams = z.infer< + typeof ListBlockChildrenParamsSchema + > + + export const AppendBlockChildrenParamsSchema = z + .object({ block_id: z.string() }) + .merge(AppendBlockChildrenParametersSchema) + export type AppendBlockChildrenParams = z.infer< + typeof AppendBlockChildrenParamsSchema + > + + export const GetDatabaseParamsSchema = z.object({ database_id: z.string() }) + export type GetDatabaseParams = z.infer + + export const GetDatabaseResponseSchema = z.union([ + PartialDatabaseObjectResponseSchema, + DatabaseObjectResponseSchema + ]) + export type GetDatabaseResponse = z.infer + + export const UpdateDatabaseParamsSchema = z + .object({ database_id: z.string() }) + .merge(UpdateDatabaseParametersSchema) + export type UpdateDatabaseParams = z.infer + + export const UpdateDatabaseResponseSchema = z.union([ + PartialDatabaseObjectResponseSchema, + DatabaseObjectResponseSchema + ]) + export type UpdateDatabaseResponse = z.infer< + typeof UpdateDatabaseResponseSchema + > + + export const QueryDatabaseParamsSchema = z + .object({ + database_id: z.string(), + filter_properties: z.array(z.string()).optional() + }) + .merge(QueryDatabaseParametersSchema) + export type QueryDatabaseParams = z.infer + + export const ListDatabasesParamsSchema = z.object({ + start_cursor: z.string().optional(), + page_size: z.number().int().optional() + }) + export type ListDatabasesParams = z.infer + + export const CreateDatabaseParamsSchema = CreateDatabaseParametersSchema + export type CreateDatabaseParams = z.infer + + export const CreateDatabaseResponseSchema = z.union([ + PartialDatabaseObjectResponseSchema, + DatabaseObjectResponseSchema + ]) + export type CreateDatabaseResponse = z.infer< + typeof CreateDatabaseResponseSchema + > + + export const SearchParamsSchema = SearchParametersSchema + export type SearchParams = z.infer + + export const ListCommentsParamsSchema = z.object({ + block_id: z.string(), + start_cursor: z.string().optional(), + page_size: z.number().int().optional() + }) + export type ListCommentsParams = z.infer + + export const CreateCommentParamsSchema = CreateCommentParametersSchema + export type CreateCommentParams = z.infer + + export const CreateCommentResponseSchema = z.union([ + CommentObjectResponseSchema, + PartialCommentObjectResponseSchema + ]) + export type CreateCommentResponse = z.infer< + typeof CreateCommentResponseSchema + > + + export const OauthTokenParamsSchema = OauthTokenParametersSchema + export type OauthTokenParams = z.infer +} + +/** + * Agentic Notion client. + * + * API specification for Notion. + */ +export class NotionClient extends AIFunctionsProvider { + protected readonly ky: KyInstance + protected readonly apiKey: string + protected readonly apiBaseUrl: string + + constructor({ + apiKey = getEnv('NOTION_API_KEY'), + apiBaseUrl = notion.apiBaseUrl, + ky = defaultKy + }: { + apiKey?: string + apiBaseUrl?: string + ky?: KyInstance + } = {}) { + assert( + apiKey, + 'NotionClient missing required "apiKey" (defaults to "NOTION_API_KEY")' + ) + super() + + this.apiKey = apiKey + this.apiBaseUrl = apiBaseUrl + + this.ky = ky.extend({ + prefixUrl: apiBaseUrl, + headers: { + Authorization: \`Bearer \${apiKey}\` + } + }) + } + + /** + * Get current user. + */ + @aiFunction({ + name: 'get_self', + description: \`Get current user.\`, + inputSchema: notion.GetSelfParamsSchema + }) + async getSelf( + _params: notion.GetSelfParams + ): Promise { + return this.ky.get('/users/me').json() + } + + /** + * Get user. + */ + @aiFunction({ + name: 'get_user', + description: \`Get user.\`, + inputSchema: notion.GetUserParamsSchema + }) + async getUser(params: notion.GetUserParams): Promise { + return this.ky + .get(\`/users/\${params['user_id']}\`) + .json() + } + + /** + * List users. + */ + @aiFunction({ + name: 'list_users', + description: \`List users.\`, + inputSchema: notion.ListUsersParamsSchema + }) + async listUsers( + params: notion.ListUsersParams + ): Promise { + return this.ky + .get('/users', { + searchParams: sanitizeSearchParams( + pick(params, 'start_cursor', 'page_size') + ) + }) + .json() + } + + /** + * Create page. + */ + @aiFunction({ + name: 'create_page', + description: \`Create page.\`, + inputSchema: notion.CreatePageParamsSchema + }) + async createPage( + params: notion.CreatePageParams + ): Promise { + return this.ky + .post('/pages', { + json: pick(params, 'parent', 'properties') + }) + .json() + } + + /** + * Get page. + */ + @aiFunction({ + name: 'get_page', + description: \`Get page.\`, + inputSchema: notion.GetPageParamsSchema + }) + async getPage(params: notion.GetPageParams): Promise { + return this.ky + .get(\`/pages/\${params['page_id']}\`, { + searchParams: sanitizeSearchParams(pick(params, 'filter_properties')) + }) + .json() + } + + /** + * Update page. + */ + @aiFunction({ + name: 'update_page', + description: \`Update page.\`, + inputSchema: notion.UpdatePageParamsSchema + }) + async updatePage( + params: notion.UpdatePageParams + ): Promise { + return this.ky + .patch(\`/pages/\${params['page_id']}\`, { + json: pick(params, 'properties', 'archived') + }) + .json() + } + + /** + * Get page property. + */ + @aiFunction({ + name: 'get_page_property', + description: \`Get page property.\`, + inputSchema: notion.GetPagePropertyParamsSchema + }) + async getPageProperty( + params: notion.GetPagePropertyParams + ): Promise { + return this.ky + .get(\`/pages/\${params['page_id']}/properties/\${params['property_id']}\`, { + searchParams: sanitizeSearchParams( + pick(params, 'start_cursor', 'page_size') + ) + }) + .json() + } + + /** + * Get block. + */ + @aiFunction({ + name: 'get_block', + description: \`Get block.\`, + inputSchema: notion.GetBlockParamsSchema + }) + async getBlock( + params: notion.GetBlockParams + ): Promise { + return this.ky + .get(\`/blocks/\${params['block_id']}\`) + .json() + } + + /** + * Delete block. + */ + @aiFunction({ + name: 'delete_block', + description: \`Delete block.\`, + inputSchema: notion.DeleteBlockParamsSchema + }) + async deleteBlock( + params: notion.DeleteBlockParams + ): Promise { + return this.ky + .delete(\`/blocks/\${params['block_id']}\`) + .json() + } + + /** + * Update block. + */ + @aiFunction({ + name: 'update_block', + description: \`Update block.\`, + inputSchema: notion.UpdateBlockParamsSchema + }) + async updateBlock( + params: notion.UpdateBlockParams + ): Promise { + return this.ky + .patch(\`/blocks/\${params['block_id']}\`, { + json: pick( + params, + 'paragraph', + 'heading_1', + 'heading_2', + 'heading_3', + 'bulleted_list_item', + 'numbered_list_item', + 'quote', + 'to_do', + 'toggle', + 'code', + 'embed', + 'image', + 'video', + 'file', + 'pdf', + 'bookmark', + 'equation', + 'divider', + 'table_of_contents', + 'breadcrumb', + 'column_list', + 'column', + 'link_to_page', + 'table_row', + 'archived' + ) + }) + .json() + } + + /** + * List block children. + */ + @aiFunction({ + name: 'list_block_children', + description: \`List block children.\`, + inputSchema: notion.ListBlockChildrenParamsSchema + }) + async listBlockChildren( + params: notion.ListBlockChildrenParams + ): Promise { + return this.ky + .get(\`/blocks/\${params['block_id']}/children\`, { + searchParams: sanitizeSearchParams( + pick(params, 'start_cursor', 'page_size') + ) + }) + .json() + } + + /** + * Append block children. + */ + @aiFunction({ + name: 'append_block_children', + description: \`Append block children.\`, + inputSchema: notion.AppendBlockChildrenParamsSchema + }) + async appendBlockChildren( + params: notion.AppendBlockChildrenParams + ): Promise { + return this.ky + .patch(\`/blocks/\${params['block_id']}/children\`, { + json: pick(params, 'children') + }) + .json() + } + + /** + * Get database. + */ + @aiFunction({ + name: 'get_database', + description: \`Get database.\`, + inputSchema: notion.GetDatabaseParamsSchema + }) + async getDatabase( + params: notion.GetDatabaseParams + ): Promise { + return this.ky + .get(\`/databases/\${params['database_id']}\`) + .json() + } + + /** + * Update database. + */ + @aiFunction({ + name: 'update_database', + description: \`Update database.\`, + inputSchema: notion.UpdateDatabaseParamsSchema + }) + async updateDatabase( + params: notion.UpdateDatabaseParams + ): Promise { + return this.ky + .patch(\`/databases/\${params['database_id']}\`, { + json: pick( + params, + 'title', + 'description', + 'icon', + 'cover', + 'properties', + 'is_inline', + 'archived' + ) + }) + .json() + } + + /** + * Query database. + */ + @aiFunction({ + name: 'query_database', + description: \`Query database.\`, + inputSchema: notion.QueryDatabaseParamsSchema + }) + async queryDatabase( + params: notion.QueryDatabaseParams + ): Promise { + return this.ky + .post(\`/databases/\${params['database_id']}/query\`, { + searchParams: sanitizeSearchParams(pick(params, 'filter_properties')), + json: pick( + params, + 'sorts', + 'filter', + 'start_cursor', + 'page_size', + 'archived' + ) + }) + .json() + } + + /** + * List databases. + */ + @aiFunction({ + name: 'list_databases', + description: \`List databases.\`, + inputSchema: notion.ListDatabasesParamsSchema + }) + async listDatabases( + params: notion.ListDatabasesParams + ): Promise { + return this.ky + .get('/databases', { + searchParams: sanitizeSearchParams( + pick(params, 'start_cursor', 'page_size') + ) + }) + .json() + } + + /** + * Create database. + */ + @aiFunction({ + name: 'create_database', + description: \`Create database.\`, + inputSchema: notion.CreateDatabaseParamsSchema + }) + async createDatabase( + params: notion.CreateDatabaseParams + ): Promise { + return this.ky + .post('/databases', { + json: pick( + params, + 'parent', + 'properties', + 'icon', + 'cover', + 'title', + 'description', + 'is_inline' + ) + }) + .json() + } + + /** + * Search. + */ + @aiFunction({ + name: 'search', + description: \`Search.\`, + inputSchema: notion.SearchParamsSchema + }) + async search(params: notion.SearchParams): Promise { + return this.ky + .post('/search', { + json: pick( + params, + 'query', + 'sort', + 'filter', + 'start_cursor', + 'page_size' + ) + }) + .json() + } + + /** + * List comments. + */ + @aiFunction({ + name: 'list_comments', + description: \`List comments.\`, + inputSchema: notion.ListCommentsParamsSchema + }) + async listComments( + params: notion.ListCommentsParams + ): Promise { + return this.ky + .get('/comments', { + searchParams: sanitizeSearchParams( + pick(params, 'block_id', 'start_cursor', 'page_size') + ) + }) + .json() + } + + /** + * Create comment. + */ + @aiFunction({ + name: 'create_comment', + description: \`Create comment.\`, + // TODO: Improve handling of union params + inputSchema: notion.CreateCommentParamsSchema as any + }) + async createComment( + params: notion.CreateCommentParams + ): Promise { + return this.ky + .post('/comments', { + json: params + }) + .json() + } + + /** + * OAuth token. + */ + @aiFunction({ + name: 'oauth_token', + description: \`OAuth token.\`, + inputSchema: notion.OauthTokenParamsSchema + }) + async oauthToken( + params: notion.OauthTokenParams + ): Promise { + return this.ky + .post('/oauth/token', { + json: pick( + params, + 'grant_type', + 'code', + 'redirect_uri', + 'external_account' + ) + }) + .json() + } +} +" +`; + +exports[`openapi-to-ts > pet-store.json 1`] = ` +"/* eslint-disable unicorn/no-unreadable-iife */ +/* eslint-disable unicorn/no-array-reduce */ + +/** + * This file was auto-generated from an OpenAPI spec. + */ + +import { + AIFunctionsProvider, + aiFunction, + pick, + sanitizeSearchParams +} from '@agentic/core' +import defaultKy, { type KyInstance } from 'ky' +import { z } from 'zod' + +export namespace petstore { + export const apiBaseUrl = 'http://petstore.swagger.io/v1' + + // ----------------------------------------------------------------------------- + // Component schemas + // ----------------------------------------------------------------------------- + + export const PetSchema = z.object({ + id: z.number().int(), + name: z.string(), + tag: z.string().optional() + }) + export type Pet = z.infer + + export const PetsSchema = z.array(PetSchema).max(100) + export type Pets = z.infer + + // ----------------------------------------------------------------------------- + // Operation schemas + // ----------------------------------------------------------------------------- + + export const ListPetsParamsSchema = z.object({ + /** How many items to return at one time (max 100) */ + limit: z + .number() + .int() + .lte(100) + .describe('How many items to return at one time (max 100)') + .optional() + }) + export type ListPetsParams = z.infer + + export const ListPetsResponseSchema = PetsSchema + export type ListPetsResponse = z.infer + + export const CreatePetsParamsSchema = PetSchema + export type CreatePetsParams = z.infer + + export type CreatePetsResponse = undefined + + export const ShowPetByIdParamsSchema = z.object({ + /** The id of the pet to retrieve */ + petId: z.string().describe('The id of the pet to retrieve') + }) + export type ShowPetByIdParams = z.infer + + export const ShowPetByIdResponseSchema = PetSchema + export type ShowPetByIdResponse = z.infer +} + +/** + * Agentic PetStore client. + */ +export class PetStoreClient extends AIFunctionsProvider { + protected readonly ky: KyInstance + + protected readonly apiBaseUrl: string + + constructor({ + apiBaseUrl = petstore.apiBaseUrl, + ky = defaultKy + }: { + apiKey?: string + apiBaseUrl?: string + ky?: KyInstance + } = {}) { + super() + + this.apiBaseUrl = apiBaseUrl + + this.ky = ky.extend({ + prefixUrl: apiBaseUrl + }) + } + + /** + * List all pets. + */ + @aiFunction({ + name: 'list_pets', + description: \`List all pets.\`, + inputSchema: petstore.ListPetsParamsSchema + }) + async listPets( + params: petstore.ListPetsParams + ): Promise { + return this.ky + .get('/pets', { + searchParams: sanitizeSearchParams(params) + }) + .json() + } + + /** + * Create a pet. + */ + @aiFunction({ + name: 'create_pets', + description: \`Create a pet.\`, + inputSchema: petstore.CreatePetsParamsSchema + }) + async createPets( + params: petstore.CreatePetsParams + ): Promise { + return this.ky + .post('/pets', { + json: pick(params, 'id', 'name', 'tag') + }) + .json() + } + + /** + * Info for a specific pet. + */ + @aiFunction({ + name: 'show_pet_by_id', + description: \`Info for a specific pet.\`, + inputSchema: petstore.ShowPetByIdParamsSchema + }) + async showPetById( + params: petstore.ShowPetByIdParams + ): Promise { + return this.ky + .get(\`/pets/\${params['petId']}\`) + .json() + } +} +" +`; + +exports[`openapi-to-ts > petstore-expanded.json 1`] = ` +"/* eslint-disable unicorn/no-unreadable-iife */ +/* eslint-disable unicorn/no-array-reduce */ + +/** + * This file was auto-generated from an OpenAPI spec. + */ + +import { + AIFunctionsProvider, + aiFunction, + pick, + sanitizeSearchParams +} from '@agentic/core' +import defaultKy, { type KyInstance } from 'ky' +import { z } from 'zod' + +export namespace petstoreexpanded { + export const apiBaseUrl = 'http://petstore.swagger.io/api' + + // ----------------------------------------------------------------------------- + // Component schemas + // ----------------------------------------------------------------------------- + + export const NewPetSchema = z.object({ + name: z.string(), + tag: z.string().optional() + }) + export type NewPet = z.infer + + export const PetSchema = z.intersection( + NewPetSchema, + z.object({ id: z.number().int() }) + ) + export type Pet = z.infer + + // ----------------------------------------------------------------------------- + // Operation schemas + // ----------------------------------------------------------------------------- + + export const FindPetsParamsSchema = z.object({ + /** tags to filter by */ + tags: z.array(z.string()).describe('tags to filter by').optional(), + /** maximum number of results to return */ + limit: z + .number() + .int() + .describe('maximum number of results to return') + .optional() + }) + export type FindPetsParams = z.infer + + export const FindPetsResponseSchema = z.array(PetSchema) + export type FindPetsResponse = z.infer + + export const AddPetParamsSchema = NewPetSchema + export type AddPetParams = z.infer + + export const AddPetResponseSchema = PetSchema + export type AddPetResponse = z.infer + + export const FindPetByIdParamsSchema = z.object({ + /** ID of pet to fetch */ + id: z.number().int().describe('ID of pet to fetch') + }) + export type FindPetByIdParams = z.infer + + export const FindPetByIdResponseSchema = PetSchema + export type FindPetByIdResponse = z.infer + + export const DeletePetParamsSchema = z.object({ + /** ID of pet to delete */ + id: z.number().int().describe('ID of pet to delete') + }) + export type DeletePetParams = z.infer + + export type DeletePetResponse = undefined +} + +/** + * Agentic PetstoreExpanded client. + * + * A sample API that uses a petstore as an example to demonstrate features in the OpenAPI 3.0 specification. + */ +export class PetstoreExpandedClient extends AIFunctionsProvider { + protected readonly ky: KyInstance + + protected readonly apiBaseUrl: string + + constructor({ + apiBaseUrl = petstoreexpanded.apiBaseUrl, + ky = defaultKy + }: { + apiKey?: string + apiBaseUrl?: string + ky?: KyInstance + } = {}) { + super() + + this.apiBaseUrl = apiBaseUrl + + this.ky = ky.extend({ + prefixUrl: apiBaseUrl + }) + } + + /** + * Returns all pets from the system that the user has access to +Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia. + +Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien. + */ + @aiFunction({ + name: 'find_pets', + description: \`Returns all pets from the system that the user has access to +Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia. + +Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.\`, + inputSchema: petstoreexpanded.FindPetsParamsSchema + }) + async findPets( + params: petstoreexpanded.FindPetsParams + ): Promise { + return this.ky + .get('/pets', { + searchParams: sanitizeSearchParams(pick(params, 'tags', 'limit')) + }) + .json() + } + + /** + * Creates a new pet in the store. Duplicates are allowed. + */ + @aiFunction({ + name: 'add_pet', + description: \`Creates a new pet in the store. Duplicates are allowed.\`, + inputSchema: petstoreexpanded.AddPetParamsSchema + }) + async addPet( + params: petstoreexpanded.AddPetParams + ): Promise { + return this.ky + .post('/pets', { + json: pick(params, 'name', 'tag') + }) + .json() + } + + /** + * Returns a user based on a single ID, if the user does not have access to the pet. + */ + @aiFunction({ + name: 'find_pet_by_id', + description: \`Returns a user based on a single ID, if the user does not have access to the pet.\`, + inputSchema: petstoreexpanded.FindPetByIdParamsSchema + }) + async findPetById( + params: petstoreexpanded.FindPetByIdParams + ): Promise { + return this.ky + .get(\`/pets/\${params['id']}\`) + .json() + } + + /** + * deletes a single pet based on the ID supplied. + */ + @aiFunction({ + name: 'delete_pet', + description: \`deletes a single pet based on the ID supplied.\`, + inputSchema: petstoreexpanded.DeletePetParamsSchema + }) + async deletePet( + params: petstoreexpanded.DeletePetParams + ): Promise { + return this.ky + .delete(\`/pets/\${params['id']}\`) + .json() + } +} +" +`; + +exports[`openapi-to-ts > security.json 1`] = ` +"/* eslint-disable unicorn/no-unreadable-iife */ +/* eslint-disable unicorn/no-array-reduce */ + +/** + * This file was auto-generated from an OpenAPI spec. + */ + +import { AIFunctionsProvider, aiFunction } from '@agentic/core' +import defaultKy, { type KyInstance } from 'ky' +import { z } from 'zod' + +export namespace security { + export const apiBaseUrl = 'https://httpbin.org' + + // ----------------------------------------------------------------------------- + // Operation schemas + // ----------------------------------------------------------------------------- + + export const GetAnythingApiKeyParamsSchema = z.object({}) + export type GetAnythingApiKeyParams = z.infer< + typeof GetAnythingApiKeyParamsSchema + > + + export type GetAnythingApiKeyResponse = undefined + + export const PostAnythingApiKeyParamsSchema = z.object({}) + export type PostAnythingApiKeyParams = z.infer< + typeof PostAnythingApiKeyParamsSchema + > + + export type PostAnythingApiKeyResponse = undefined + + export const PutAnythingApiKeyParamsSchema = z.object({}) + export type PutAnythingApiKeyParams = z.infer< + typeof PutAnythingApiKeyParamsSchema + > + + export type PutAnythingApiKeyResponse = undefined + + export const PostAnythingBasicParamsSchema = z.object({}) + export type PostAnythingBasicParams = z.infer< + typeof PostAnythingBasicParamsSchema + > + + export type PostAnythingBasicResponse = undefined + + export const PostAnythingBearerParamsSchema = z.object({}) + export type PostAnythingBearerParams = z.infer< + typeof PostAnythingBearerParamsSchema + > + + export type PostAnythingBearerResponse = undefined + + export const PutAnythingBearerParamsSchema = z.object({}) + export type PutAnythingBearerParams = z.infer< + typeof PutAnythingBearerParamsSchema + > + + export type PutAnythingBearerResponse = undefined + + export const GetAnythingOauth2ParamsSchema = z.object({}) + export type GetAnythingOauth2Params = z.infer< + typeof GetAnythingOauth2ParamsSchema + > + + export type GetAnythingOauth2Response = undefined + + export const PostAnythingOauth2ParamsSchema = z.object({}) + export type PostAnythingOauth2Params = z.infer< + typeof PostAnythingOauth2ParamsSchema + > + + export type PostAnythingOauth2Response = undefined + + export const PutAnythingOauth2ParamsSchema = z.object({}) + export type PutAnythingOauth2Params = z.infer< + typeof PutAnythingOauth2ParamsSchema + > + + export type PutAnythingOauth2Response = undefined + + export const DeleteAnythingOauth2ParamsSchema = z.object({}) + export type DeleteAnythingOauth2Params = z.infer< + typeof DeleteAnythingOauth2ParamsSchema + > + + export type DeleteAnythingOauth2Response = undefined + + export const PatchAnythingOauth2ParamsSchema = z.object({}) + export type PatchAnythingOauth2Params = z.infer< + typeof PatchAnythingOauth2ParamsSchema + > + + export type PatchAnythingOauth2Response = undefined + + export const PostAnythingOpenIdConnectParamsSchema = z.object({}) + export type PostAnythingOpenIdConnectParams = z.infer< + typeof PostAnythingOpenIdConnectParamsSchema + > + + export type PostAnythingOpenIdConnectResponse = undefined + + export const PostAnythingNoAuthParamsSchema = z.object({}) + export type PostAnythingNoAuthParams = z.infer< + typeof PostAnythingNoAuthParamsSchema + > + + export type PostAnythingNoAuthResponse = undefined + + export const GetAnythingOptionalAuthParamsSchema = z.object({}) + export type GetAnythingOptionalAuthParams = z.infer< + typeof GetAnythingOptionalAuthParamsSchema + > + + export type GetAnythingOptionalAuthResponse = undefined + + export const PostStatus401ParamsSchema = z.object({}) + export type PostStatus401Params = z.infer + + export type PostStatus401Response = undefined +} + +/** + * Agentic Security client. + * + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#securitySchemeObject. + */ +export class SecurityClient extends AIFunctionsProvider { + protected readonly ky: KyInstance + + protected readonly apiBaseUrl: string + + constructor({ + apiBaseUrl = security.apiBaseUrl, + ky = defaultKy + }: { + apiKey?: string + apiBaseUrl?: string + ky?: KyInstance + } = {}) { + super() + + this.apiBaseUrl = apiBaseUrl + + this.ky = ky.extend({ + prefixUrl: apiBaseUrl + }) + } + + /** + * \`apiKey\` auth will be supplied within an \`apiKey\` query parameter. + */ + @aiFunction({ + name: 'get_anything_api_key', + description: \`\\\`apiKey\\\` auth will be supplied within an \\\`apiKey\\\` query parameter.\`, + inputSchema: security.GetAnythingApiKeyParamsSchema + }) + async getAnythingApiKey( + _params: security.GetAnythingApiKeyParams + ): Promise { + return this.ky + .get('/anything/apiKey') + .json() + } + + /** + * \`apiKey\` auth will be supplied within an \`api_key\` cookie. + */ + @aiFunction({ + name: 'post_anything_api_key', + description: \`\\\`apiKey\\\` auth will be supplied within an \\\`api_key\\\` cookie.\`, + inputSchema: security.PostAnythingApiKeyParamsSchema + }) + async postAnythingApiKey( + _params: security.PostAnythingApiKeyParams + ): Promise { + return this.ky + .post('/anything/apiKey') + .json() + } + + /** + * \`apiKey\` auth will be supplied within an \`X-API-KEY\` header. + */ + @aiFunction({ + name: 'put_anything_api_key', + description: \`\\\`apiKey\\\` auth will be supplied within an \\\`X-API-KEY\\\` header.\`, + inputSchema: security.PutAnythingApiKeyParamsSchema + }) + async putAnythingApiKey( + _params: security.PutAnythingApiKeyParams + ): Promise { + return this.ky + .put('/anything/apiKey') + .json() + } + + /** + * Authentication credentials will be supplied within a \`Basic\` \`Authorization\` header. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample. + */ + @aiFunction({ + name: 'post_anything_basic', + description: \`Authentication credentials will be supplied within a \\\`Basic\\\` \\\`Authorization\\\` header. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample.\`, + inputSchema: security.PostAnythingBasicParamsSchema + }) + async postAnythingBasic( + _params: security.PostAnythingBasicParams + ): Promise { + return this.ky + .post('/anything/basic') + .json() + } + + /** + * Authentication credentials will be supplied within a \`Bearer\` \`Authorization\` header. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample. + */ + @aiFunction({ + name: 'post_anything_bearer', + description: \`Authentication credentials will be supplied within a \\\`Bearer\\\` \\\`Authorization\\\` header. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample.\`, + inputSchema: security.PostAnythingBearerParamsSchema + }) + async postAnythingBearer( + _params: security.PostAnythingBearerParams + ): Promise { + return this.ky + .post('/anything/bearer') + .json() + } + + /** + * Authentication credentials will be supplied within a \`Bearer\` \`Authorization\` header, but its data should be controlled as a JWT. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample + +> ℹ️ +> We currently do not support any special handling for this so they're handled as a standard \`Bearer\` authentication token. + */ + @aiFunction({ + name: 'put_anything_bearer', + description: \`Authentication credentials will be supplied within a \\\`Bearer\\\` \\\`Authorization\\\` header, but its data should be controlled as a JWT. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#basic-authentication-sample + +> ℹ️ +> We currently do not support any special handling for this so they're handled as a standard \\\`Bearer\\\` authentication token.\`, + inputSchema: security.PutAnythingBearerParamsSchema + }) + async putAnythingBearer( + _params: security.PutAnythingBearerParams + ): Promise { + return this.ky + .put('/anything/bearer') + .json() + } + + /** + * > ℹ️ +> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23. + */ + @aiFunction({ + name: 'get_anything_oauth2', + description: \`> ℹ️ +> We currently do not handle OAuth 2 authentication flows so if an operation has an \\\`oauth2\\\` requirement we assume that the user, or the projects JWT, has a qualified \\\`bearer\\\` token and will use that. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23.\`, + inputSchema: security.GetAnythingOauth2ParamsSchema + }) + async getAnythingOauth2( + _params: security.GetAnythingOauth2Params + ): Promise { + return this.ky + .get('/anything/oauth2') + .json() + } + + /** + * > ℹ️ +> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23. + */ + @aiFunction({ + name: 'post_anything_oauth2', + description: \`> ℹ️ +> We currently do not handle OAuth 2 authentication flows so if an operation has an \\\`oauth2\\\` requirement we assume that the user, or the projects JWT, has a qualified \\\`bearer\\\` token and will use that. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23.\`, + inputSchema: security.PostAnythingOauth2ParamsSchema + }) + async postAnythingOauth2( + _params: security.PostAnythingOauth2Params + ): Promise { + return this.ky + .post('/anything/oauth2') + .json() + } + + /** + * > ℹ️ +> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23. + */ + @aiFunction({ + name: 'put_anything_oauth2', + description: \`> ℹ️ +> We currently do not handle OAuth 2 authentication flows so if an operation has an \\\`oauth2\\\` requirement we assume that the user, or the projects JWT, has a qualified \\\`bearer\\\` token and will use that. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23.\`, + inputSchema: security.PutAnythingOauth2ParamsSchema + }) + async putAnythingOauth2( + _params: security.PutAnythingOauth2Params + ): Promise { + return this.ky + .put('/anything/oauth2') + .json() + } + + /** + * > ℹ️ +> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23. + */ + @aiFunction({ + name: 'delete_anything_oauth2', + description: \`> ℹ️ +> We currently do not handle OAuth 2 authentication flows so if an operation has an \\\`oauth2\\\` requirement we assume that the user, or the projects JWT, has a qualified \\\`bearer\\\` token and will use that. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23.\`, + inputSchema: security.DeleteAnythingOauth2ParamsSchema + }) + async deleteAnythingOauth2( + _params: security.DeleteAnythingOauth2Params + ): Promise { + return this.ky + .delete('/anything/oauth2') + .json() + } + + /** + * > ℹ️ +> We currently do not handle OAuth 2 authentication flows so if an operation has an \`oauth2\` requirement we assume that the user, or the projects JWT, has a qualified \`bearer\` token and will use that. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23. + */ + @aiFunction({ + name: 'patch_anything_oauth2', + description: \`> ℹ️ +> We currently do not handle OAuth 2 authentication flows so if an operation has an \\\`oauth2\\\` requirement we assume that the user, or the projects JWT, has a qualified \\\`bearer\\\` token and will use that. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23.\`, + inputSchema: security.PatchAnythingOauth2ParamsSchema + }) + async patchAnythingOauth2( + _params: security.PatchAnythingOauth2Params + ): Promise { + return this.ky + .patch('/anything/oauth2') + .json() + } + + /** + * 🚧 This is not supported. + */ + @aiFunction({ + name: 'post_anything_open_id_connect', + description: \`🚧 This is not supported.\`, + inputSchema: security.PostAnythingOpenIdConnectParamsSchema + }) + async postAnythingOpenIdConnect( + _params: security.PostAnythingOpenIdConnectParams + ): Promise { + return this.ky + .post('/anything/openIdConnect') + .json() + } + + /** + * This operation does not have any authentication requirements. + */ + @aiFunction({ + name: 'post_anything_no_auth', + description: \`This operation does not have any authentication requirements.\`, + inputSchema: security.PostAnythingNoAuthParamsSchema + }) + async postAnythingNoAuth( + _params: security.PostAnythingNoAuthParams + ): Promise { + return this.ky + .post('/anything/no-auth') + .json() + } + + /** + * The \`apiKey\` query parameter auth on this operation is optional. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-requirement-object. + */ + @aiFunction({ + name: 'get_anything_optional_auth', + description: \`The \\\`apiKey\\\` query parameter auth on this operation is optional. + +https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#security-requirement-object.\`, + inputSchema: security.GetAnythingOptionalAuthParamsSchema + }) + async getAnythingOptionalAuth( + _params: security.GetAnythingOptionalAuthParams + ): Promise { + return this.ky + .get('/anything/optional-auth') + .json() + } + + /** + * This endpoint requires an authentication header but making any request to it will forcefully return a 401 status code for invalid auth. + */ + @aiFunction({ + name: 'post_status401', + description: \`This endpoint requires an authentication header but making any request to it will forcefully return a 401 status code for invalid auth.\`, + inputSchema: security.PostStatus401ParamsSchema + }) + async postStatus401( + _params: security.PostStatus401Params + ): Promise { + return this.ky.post('/status/401').json() + } +} +" +`; + +exports[`openapi-to-ts > tic-tac-toe.json 1`] = ` +"/* eslint-disable unicorn/no-unreadable-iife */ +/* eslint-disable unicorn/no-array-reduce */ + +/** + * This file was auto-generated from an OpenAPI spec. + */ + +import { AIFunctionsProvider, aiFunction } from '@agentic/core' +import defaultKy, { type KyInstance } from 'ky' +import { z } from 'zod' + +export namespace tictactoe { + // ----------------------------------------------------------------------------- + // Component schemas + // ----------------------------------------------------------------------------- + + /** Winner of the game. \`.\` means nobody has won yet. */ + export const WinnerSchema = z + .enum(['.', 'X', 'O']) + .describe('Winner of the game. \`.\` means nobody has won yet.') + export type Winner = z.infer + + /** Possible values for a board square. \`.\` means empty square. */ + export const MarkSchema = z + .enum(['.', 'X', 'O']) + .describe('Possible values for a board square. \`.\` means empty square.') + export type Mark = z.infer + + export const BoardSchema = z + .array(z.array(MarkSchema).min(3).max(3)) + .min(3) + .max(3) + export type Board = z.infer + + export const StatusSchema = z.object({ + winner: WinnerSchema.optional(), + board: BoardSchema.optional() + }) + export type Status = z.infer + + // ----------------------------------------------------------------------------- + // Operation schemas + // ----------------------------------------------------------------------------- + + export const GetBoardParamsSchema = z.object({}) + export type GetBoardParams = z.infer + + export const GetBoardResponseSchema = StatusSchema + export type GetBoardResponse = z.infer + + export const GetSquareParamsSchema = z.object({}) + export type GetSquareParams = z.infer + + export const GetSquareResponseSchema = MarkSchema + export type GetSquareResponse = z.infer + + export const PutSquareParamsSchema = MarkSchema + export type PutSquareParams = z.infer + + export const PutSquareResponseSchema = StatusSchema + export type PutSquareResponse = z.infer +} + +/** + * Agentic TicTacToe client. + * + * This API allows writing down marks on a Tic Tac Toe board +and requesting the state of the board or of individual squares. +. + */ +export class TicTacToeClient extends AIFunctionsProvider { + protected readonly ky: KyInstance + + protected readonly apiBaseUrl: string + + constructor({ + apiBaseUrl, + ky = defaultKy + }: { + apiKey?: string + apiBaseUrl?: string + ky?: KyInstance + } = {}) { + super() + + this.apiBaseUrl = apiBaseUrl + + this.ky = ky.extend({ + prefixUrl: apiBaseUrl + }) + } + + /** + * Retrieves the current state of the board and the winner. + */ + @aiFunction({ + name: 'get_board', + description: \`Retrieves the current state of the board and the winner.\`, + inputSchema: tictactoe.GetBoardParamsSchema + }) + async getBoard( + _params: tictactoe.GetBoardParams + ): Promise { + return this.ky.get('/board').json() + } + + /** + * Retrieves the requested square. + */ + @aiFunction({ + name: 'get_square', + description: \`Retrieves the requested square.\`, + inputSchema: tictactoe.GetSquareParamsSchema + }) + async getSquare( + _params: tictactoe.GetSquareParams + ): Promise { + return this.ky + .get('/board/{row}/{column}') + .json() + } + + /** + * Places a mark on the board and retrieves the whole board and the winner (if any). + */ + @aiFunction({ + name: 'put_square', + description: \`Places a mark on the board and retrieves the whole board and the winner (if any).\`, + inputSchema: tictactoe.PutSquareParamsSchema + }) + async putSquare( + _params: tictactoe.PutSquareParams + ): Promise { + return this.ky + .put('/board/{row}/{column}') + .json() + } +} +" +`; diff --git a/packages/openapi-to-ts/src/generate-ts-from-openapi.test.ts b/packages/openapi-to-ts/src/generate-ts-from-openapi.test.ts new file mode 100644 index 0000000..5956075 --- /dev/null +++ b/packages/openapi-to-ts/src/generate-ts-from-openapi.test.ts @@ -0,0 +1,40 @@ +import path from 'node:path' +import { fileURLToPath } from 'node:url' + +import { describe, expect, test } from 'vitest' + +import { generateTSFromOpenAPI } from './generate-ts-from-openapi' + +const fixtures = [ + 'firecrawl.json', + // 'github.json', // TODO: not working 100% yet + 'notion.json', + 'pet-store.json', + 'petstore-expanded.json', + 'security.json', + // 'stripe.json', // TODO: not working 100% yet + 'tic-tac-toe.json' +] + +const dirname = path.join(fileURLToPath(import.meta.url), '..', '..') + +describe('openapi-to-ts', () => { + for (const fixture of fixtures) { + test( + fixture, + { + timeout: 60_000 + }, + async () => { + const fixturePath = path.join(dirname, 'fixtures', 'openapi', fixture) + const outputDir = path.join(dirname, 'fixtures', 'generated') + + const result = await generateTSFromOpenAPI({ + openapiFilePath: fixturePath, + outputDir + }) + expect(result).toMatchSnapshot() + } + ) + } +}) diff --git a/packages/openapi-to-ts/src/generate-ts-from-openapi.ts b/packages/openapi-to-ts/src/generate-ts-from-openapi.ts index 5e8375d..29e22a9 100644 --- a/packages/openapi-to-ts/src/generate-ts-from-openapi.ts +++ b/packages/openapi-to-ts/src/generate-ts-from-openapi.ts @@ -699,8 +699,9 @@ export class ${clientName} extends AIFunctionsProvider { '}' ].join('\n\n') ) - ).replaceAll(/z\s*\.object\({}\)\s*\.merge\(([^)]*)\)/gm, '$1') - // .replaceAll(/\/\*\*(\S.*\S)\*\//g, '/** $1 */') + ) + .replaceAll(/z\s*\.object\({}\)\s*\.merge\(([^)]*)\)/gm, '$1') + .replaceAll(/\/\*\*(\S.*\S)\*\//g, '/** $1 */') if (dryRun) { return output